Module tools.jackson.databind
Package tools.jackson.databind.node

Class ArrayNode

java.lang.Object
tools.jackson.databind.JacksonSerializable.Base
tools.jackson.databind.JsonNode
tools.jackson.databind.node.BaseJsonNode
tools.jackson.databind.node.ContainerNode<ArrayNode>
tools.jackson.databind.node.ArrayNode
All Implemented Interfaces:
Serializable, Iterable<JsonNode>, ArrayTreeNode, TreeNode, JacksonSerializable, JsonNodeCreator
public class ArrayNode extends ContainerNode<ArrayNode> implements ArrayTreeNode, Serializable
Node class that represents Arrays mapped from JSON content.
See Also:

  • Constructor Details

  • Method Details

    • _at

      protected JsonNode _at(JsonPointer ptr)
      Description copied from class: JsonNode
      Helper method used by other methods for traversing the next step of given path expression, and returning matching value node if any: if no match, null is returned.
      Specified by:
      _at in class JsonNode
      Parameters:
      ptr - Path expression to use
      Returns:
      Either matching JsonNode for the first step of path or null if no match (including case that this node is not a container)

    • _valueDesc

      protected String _valueDesc()
      Description copied from class: BaseJsonNode
      Method for implementation classes to return a short description of contained value, to be used in error messages.
      Specified by:
      _valueDesc in class BaseJsonNode

    • deepCopy

      public ArrayNode deepCopy()
      Description copied from class: JsonNode
      Method that can be called to get a node that is guaranteed not to allow changing of this node through mutators on this node or any of its children. This means it can either make a copy of this node (and all mutable children and grand children nodes), or node itself if it is immutable.

      Note: return type is guaranteed to have same type as the node method is called on; which is why method is declared with local generic type.

      Specified by:
      deepCopy in class JsonNode
      Returns:
      Node that is either a copy of this node (and all non-leaf children); or, for immutable leaf nodes, node itself.

    • _withObject

      protected ObjectNode _withObject(JsonPointer origPtr, JsonPointer currentPtr, JsonNode.OverwriteMode overwriteMode, boolean preferIndex)
      Specified by:
      _withObject in class ContainerNode<ArrayNode>

    • _withArray

      protected ArrayNode _withArray(JsonPointer origPtr, JsonPointer currentPtr, JsonNode.OverwriteMode overwriteMode, boolean preferIndex)
      Overrides:
      _withArray in class BaseJsonNode

    • _withObjectAddTailElement

      protected ObjectNode _withObjectAddTailElement(JsonPointer tail, boolean preferIndex)

    • _withArrayAddTailElement

      protected ArrayNode _withArrayAddTailElement(JsonPointer tail, boolean preferIndex)

    • _withXxxSetArrayElement

      protected void _withXxxSetArrayElement(int index, JsonNode value)

    • isEmpty

      public boolean isEmpty(SerializationContext serializers)
      Description copied from class: JacksonSerializable.Base
      Method that may be called on instance to determine if it is considered "empty" for purposes of serialization filtering or not.
      Overrides:
      isEmpty in class JacksonSerializable.Base

    • getNodeType

      public JsonNodeType getNodeType()
      Description copied from class: JsonNode
      Return the type of this node
      Specified by:
      getNodeType in class JsonNode
      Returns:
      the node type as a JsonNodeType enum value

    • isArray

      public boolean isArray()
      Specified by:
      isArray in interface TreeNode
      Overrides:
      isArray in class JsonNode

    • asToken

      public JsonToken asToken()
      Description copied from class: BaseJsonNode
      Method that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the first JsonToken that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)
      Specified by:
      asToken in interface TreeNode
      Specified by:
      asToken in class ContainerNode<ArrayNode>

    • size

      public int size()
      Specified by:
      size in interface TreeNode
      Specified by:
      size in class ContainerNode<ArrayNode>

    • isEmpty

      public boolean isEmpty()
      Description copied from class: JsonNode
      Convenience method that is functionally same as: 
          size() == 0
      for all node types.
      Overrides:
      isEmpty in class JsonNode

    • get

      public JsonNode get(int index)
      Description copied from class: JsonNode
      Method for accessing value of the specified element of an array node. For other nodes, null is always returned.

      For array nodes, index specifies exact location within array and allows for efficient iteration over child elements (underlying storage is guaranteed to be efficiently indexable, i.e. has random-access to elements). If index is less than 0, or equal-or-greater than node.size(), null is returned; no exception is thrown for any index.

      NOTE: if the element value has been explicitly set as null (which is different from removal!), a NullNode will be returned, not null.

      Specified by:
      get in interface TreeNode
      Specified by:
      get in class ContainerNode<ArrayNode>
      Returns:
      Node that represent value of the specified element, if this node is an array and has specified element. Null otherwise.

    • get

      public JsonNode get(String propertyName)
      Description copied from class: JsonNode
      Method for accessing value of the specified field of an object node. If this node is not an object (or it does not have a value for specified field name), or if there is no field with such name, null is returned.

      NOTE: if the property value has been explicitly set as null (which is different from removal!), a NullNode will be returned, not null.

      Specified by:
      get in interface TreeNode
      Specified by:
      get in class ContainerNode<ArrayNode>
      Returns:
      Node that represent value of the specified field, if this node is an object and has value for the specified field. Null otherwise.

    • optional

      public Optional<JsonNode> optional(int index)
      Description copied from class: JsonNode
      Method for accessing value of the specified element of an array node, wrapped in an Optional. For other nodes, an empty Optional is always returned.

      For array nodes, index specifies exact location within array and allows for efficient iteration over child elements (underlying storage is guaranteed to be efficiently indexable, i.e. has random-access to elements). If index is less than 0, or equal-or-greater than node.size(), an empty Optional is returned; no exception is thrown for any index.

      NOTE: if the element value has been explicitly set as null (which is different from removal!), a NullNode will be returned wrapped in an Optional, not an empty Optional.

      Overrides:
      optional in class JsonNode
      Returns:
      Optional containing the node that represents the value of the specified element, if this node is an array and has the specified element and otherwise, an empty Optional, never null.

    • path

      public JsonNode path(String propertyName)
      Description copied from class: JsonNode
      This method is similar to JsonNode.get(String), except that instead of returning null if no such value exists (due to this node not being an object, or object not having value for the specified field), a "missing node" (node that returns true for JsonNode.isMissingNode()) will be returned. This allows for convenient and safe chained access via path calls.
      Specified by:
      path in interface TreeNode
      Specified by:
      path in class JsonNode

    • path

      public JsonNode path(int index)
      Description copied from class: JsonNode
      This method is similar to JsonNode.get(int), except that instead of returning null if no such element exists (due to index being out of range, or this node not being an array), a "missing node" (node that returns true for JsonNode.isMissingNode()) will be returned. This allows for convenient and safe chained access via path calls.
      Specified by:
      path in interface TreeNode
      Specified by:
      path in class JsonNode

    • required

      public JsonNode required(int index)
      Description copied from class: JsonNode
      Method is functionally equivalent to path(index).required() and can be used to check that this node is an ArrayNode (that is, represents JSON Array value) and has value for specified index (but note that value may be explicit JSON null value). If this node is Array Node and has value for specified index, value at index is returned; otherwise IllegalArgumentException is thrown.
      Overrides:
      required in class BaseJsonNode
      Parameters:
      index - Index of the value of this Array node to access
      Returns:
      Value at specified index of this Array node

    • values

      public Collection<JsonNode> values()
      Method for accessing all value nodes of this Node, iff this node is a JSON Array or Object node. In case of Object node, field names (keys) are not included, only values. For other types of nodes, returns empty iterator.

      NOTE: this returns the live List and not a copy.

      Overrides:
      values in class JsonNode

    • valueStream

      public Stream<JsonNode> valueStream()
      Description copied from class: JsonNode
      Returns a stream of all value nodes of this Node, iff this node is an ArrayNode or ObjectNode. In case of Object node, property names (keys) are not included, only values. For other types of nodes, returns empty stream.
      Specified by:
      valueStream in class ContainerNode<ArrayNode>

    • elements

      public Collection<JsonNode> elements()
      Alias of values().

    • equals

      public boolean equals(Comparator<JsonNode> comparator, JsonNode o)
      Description copied from class: JsonNode
      Entry method for invoking customizable comparison, using passed-in Comparator object. Nodes will handle traversal of structured types (arrays, objects), but defer to comparator for scalar value comparisons. If a "natural" Comparator is passed -- one that simply calls equals() on one of arguments, passing the other -- implementation is the same as directly calling equals() on node.

      Default implementation simply delegates to passed in comparator, with this as the first argument, and other as the second argument.

      Overrides:
      equals in class JsonNode
      Parameters:
      comparator - Object called to compare two scalar JsonNode instances, and return either 0 (are equals) or non-zero (not equal)

    • serialize

      public void serialize(JsonGenerator g, SerializationContext provider) throws JacksonException
      Description copied from class: BaseJsonNode
      Method called to serialize node instances using given generator.
      Specified by:
      serialize in interface JacksonSerializable
      Specified by:
      serialize in class BaseJsonNode
      Throws:
      JacksonException

    • serializeWithType

      public void serializeWithType(JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException
      Description copied from class: BaseJsonNode
      Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.
      Specified by:
      serializeWithType in interface JacksonSerializable
      Specified by:
      serializeWithType in class BaseJsonNode
      Throws:
      JacksonException

    • findValue

      public JsonNode findValue(String propertyName)
      Description copied from class: JsonNode
      Method for finding the first JSON Object field with specified name in this node or its child nodes, and returning value it has. If no matching field is found in this node or its descendants, returns null.

      Note that traversal is done in document order (that is, order in which nodes are iterated if using JsonNode.values())

      Specified by:
      findValue in class JsonNode
      Parameters:
      propertyName - Name of field to look for
      Returns:
      Value of first matching node found, if any; null if none

    • findValues

      public List<JsonNode> findValues(String propertyName, List<JsonNode> foundSoFar)
      Specified by:
      findValues in class JsonNode

    • findValuesAsString

      public List<String> findValuesAsString(String propertyName, List<String> foundSoFar)
      Specified by:
      findValuesAsString in class JsonNode

    • findParent

      public ObjectNode findParent(String propertyName)
      Description copied from class: JsonNode
      Method for finding a JSON Object that contains specified field, within this node or its descendants. If no matching field is found in this node or its descendants, returns null.
      Specified by:
      findParent in class JsonNode
      Parameters:
      propertyName - Name of field to look for
      Returns:
      Value of first matching node found, if any; null if none

    • findParents

      public List<JsonNode> findParents(String propertyName, List<JsonNode> foundSoFar)
      Specified by:
      findParents in class JsonNode

    • set

      public ArrayNode set(int index, JsonNode value)
      Method that will set specified element, replacing old value.
      Parameters:
      value - to set element to; if null, will be converted to a NullNode first (to remove field entry, call remove(int) instead)
      Returns:
      This node after adding/replacing property value (to allow chaining)
      Throws:
      IndexOutOfBoundsException - If Array does not have specified element (that is, index is outside valid range of elements in array)

    • replace

      public JsonNode replace(int index, JsonNode value)
      Method that will set specified element, replacing old value.
      Parameters:
      value - to set element to; if null, will be converted to a NullNode first (to remove field entry, call remove(int) instead)
      Returns:
      Old value of the element, if any; null if no such element existed.
      Throws:
      IndexOutOfBoundsException - If Array does not have specified element (that is, index is outside valid range of elements in array)

    • add

      public ArrayNode add(JsonNode value)
      Method for adding specified node at the end of this array.
      Returns:
      This node, to allow chaining

    • addAll

      public ArrayNode addAll(ArrayNode other)
      Method for adding all child nodes of given Array, appending to child nodes this array contains
      Parameters:
      other - Array to add contents from
      Returns:
      This node (to allow chaining)

    • addAll

      public ArrayNode addAll(Collection<? extends JsonNode> nodes)
      Method for adding given nodes as child nodes of this array node.
      Parameters:
      nodes - Nodes to add
      Returns:
      This node (to allow chaining)

    • insert

      public ArrayNode insert(int index, JsonNode value)
      Method for inserting specified child node as an element of this Array. If index is 0 or less, it will be inserted as the first element; if >= size(), appended at the end, and otherwise inserted before existing element in specified index. No exceptions are thrown for any index.
      Returns:
      This node (to allow chaining)

    • remove

      public JsonNode remove(int index)
      Method for removing an entry from this ArrayNode. Will return value of the entry at specified index, if entry existed; null if not.
      Returns:
      Node removed, if any; null if none

    • removeAll

      public ArrayNode removeAll()
      Method for removing all elements of this array, leaving the array empty.
      Specified by:
      removeAll in class ContainerNode<ArrayNode>
      Returns:
      This node (to allow chaining)

    • removeIf

      public ArrayNode removeIf(Predicate<? super JsonNode> predicate)
      Description copied from class: ContainerNode
      Method for removing matching those children (value) nodes container has that match given predicate.
      Specified by:
      removeIf in class ContainerNode<ArrayNode>
      Parameters:
      predicate - Predicate to use for matching: anything matching will be removed
      Returns:
      Container node itself (to allow method call chaining)

    • addArray

      public ArrayNode addArray()
      Method that will construct an ArrayNode and add it at the end of this array node.
      Returns:
      Newly constructed ArrayNode (NOTE: NOT `this` ArrayNode)

    • addObject

      public ObjectNode addObject()
      Method that will construct an ObjectNode and add it at the end of this array node.
      Returns:
      Newly constructed ObjectNode (NOTE: NOT `this` ArrayNode)

    • addPOJO

      public ArrayNode addPOJO(Object pojo)
      Method that will construct a POJONode and add it at the end of this array node.
      Returns:
      This array node, to allow chaining

    • addRawValue

      public ArrayNode addRawValue(RawValue raw)
      Returns:
      This array node, to allow chaining

    • addNull

      public ArrayNode addNull()
      Method that will add a null value at the end of this array node.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(short v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining
      Since:
      2.13

    • add

      public ArrayNode add(Short v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining
      Since:
      2.13

    • add

      public ArrayNode add(int v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(Integer v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(long v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(Long v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(float v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(Float v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(double v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(Double v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(BigDecimal v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(BigInteger v)
      Method for adding specified number at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(String v)
      Method for adding specified String value at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(boolean v)
      Method for adding specified boolean value at the end of this array.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(Boolean v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • add

      public ArrayNode add(byte[] v)
      Method for adding specified binary value at the end of this array (note: when serializing as JSON, will be output Base64 encoded)
      Returns:
      This array node, to allow chaining

    • insertArray

      public ArrayNode insertArray(int index)
      Method for creating an array node, inserting it at the specified point in the array, and returning the newly created array (note: NOT 'this' array)
      Returns:
      Newly constructed ArrayNode (note! NOT `this` ArrayNode)

    • insertObject

      public ObjectNode insertObject(int index)
      Method for creating an ObjectNode, appending it at the end of this array, and returning the newly created node (note: NOT 'this' array)
      Returns:
      Newly constructed ObjectNode (note! NOT `this` ArrayNode)

    • insertNull

      public ArrayNode insertNull(int index)
      Method that will insert a null value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insertPOJO

      public ArrayNode insertPOJO(int index, Object pojo)
      Method that will construct a POJONode and insert it at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insertRawValue

      public ArrayNode insertRawValue(int index, RawValue raw)
      Returns:
      This array node, to allow chaining
      Since:
      2.13

    • insert

      public ArrayNode insert(int index, short v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining
      Since:
      2.13

    • insert

      public ArrayNode insert(int index, Short value)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, int v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, Integer v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, long v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, Long v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, float v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, Float v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, double v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, Double v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, BigDecimal v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, BigInteger v)
      Method that will insert specified numeric value at specified position in this array.
      Returns:
      This array node, to allow chaining
      Since:
      2.9

    • insert

      public ArrayNode insert(int index, String v)
      Method that will insert specified String at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, boolean v)
      Method that will insert specified String at specified position in this array.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, Boolean value)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This array node, to allow chaining

    • insert

      public ArrayNode insert(int index, byte[] v)
      Method that will insert specified binary value at specified position in this array (note: when written as JSON, will be Base64 encoded)
      Returns:
      This array node, to allow chaining

    • setNull

      public ArrayNode setNull(int index)
      Returns:
      This node (to allow chaining)

    • setPOJO

      public ArrayNode setPOJO(int index, Object pojo)
      Returns:
      This array node, to allow chaining

    • setRawValue

      public ArrayNode setRawValue(int index, RawValue raw)
      Returns:
      This array node, to allow chaining

    • set

      public ArrayNode set(int index, short v)
      Returns:
      This array node (to allow chaining)

    • set

      public ArrayNode set(int index, Short v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, int v)
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, Integer v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, long v)
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, Long v)
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, float v)
      Method for setting value of a field to specified numeric value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, Float v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, double v)
      Method for setting value of a field to specified numeric value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, Double v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, BigDecimal v)
      Method for setting value of a field to specified numeric value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, BigInteger v)
      Method for setting value of a field to specified numeric value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, String v)
      Method for setting value of a field to specified String value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, boolean v)
      Method for setting value of a field to specified String value.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, Boolean v)
      Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
      Returns:
      This node (to allow chaining)

    • set

      public ArrayNode set(int index, byte[] v)
      Method for setting value of a field to specified binary value
      Returns:
      This node (to allow chaining)

    • equals

      public boolean equals(Object o)
      Description copied from class: JsonNode
      Equality for node objects is defined as full (deep) value equality. This means that it is possible to compare complete JSON trees for equality by comparing equality of root nodes.

      Note: marked as abstract to ensure all implementation classes define it properly and not rely on definition from Object.

      Specified by:
      equals in class JsonNode

    • _childrenEqual

      protected boolean _childrenEqual(ArrayNode other)

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class BaseJsonNode

    • _set

      protected ArrayNode _set(int index, JsonNode node)

    • _add

      protected ArrayNode _add(JsonNode node)

    • _insert

      protected ArrayNode _insert(int index, JsonNode node)