Class ArrayNode
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializable.Base
-
- com.fasterxml.jackson.databind.JsonNode
-
- com.fasterxml.jackson.databind.node.BaseJsonNode
-
- com.fasterxml.jackson.databind.node.ContainerNode<ArrayNode>
-
- com.fasterxml.jackson.databind.node.ArrayNode
-
- All Implemented Interfaces:
com.fasterxml.jackson.core.TreeNode,JsonSerializable,JsonNodeCreator,Serializable,Iterable<JsonNode>
public class ArrayNode extends ContainerNode<ArrayNode> implements Serializable
Node class that represents Arrays mapped from JSON content.Note: class was
finaltemporarily for Jackson 2.2.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
-
Field Summary
-
Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode
_nodeFactory
-
-
Constructor Summary
Constructors Constructor Description ArrayNode(JsonNodeFactory nf)ArrayNode(JsonNodeFactory nf, int capacity)ArrayNode(JsonNodeFactory nf, List<JsonNode> children)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ArrayNode_add(JsonNode node)protected JsonNode_at(com.fasterxml.jackson.core.JsonPointer ptr)protected boolean_childrenEqual(ArrayNode other)protected ArrayNode_insert(int index, JsonNode node)ArrayNodeadd(boolean v)Method for adding specified boolean value at the end of this array.ArrayNodeadd(byte[] v)Method for adding specified binary value at the end of this array (note: when serializing as JSON, will be output Base64 encoded)ArrayNodeadd(double v)Method for adding specified number at the end of this array.ArrayNodeadd(float v)Method for adding specified number at the end of this array.ArrayNodeadd(int v)Method for adding specified number at the end of this array.ArrayNodeadd(long v)Method for adding specified number at the end of this array.ArrayNodeadd(JsonNode value)Method for adding specified node at the end of this array.ArrayNodeadd(Boolean value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeadd(Double value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeadd(Float value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeadd(Integer value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeadd(Long value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeadd(String v)Method for adding specified String value at the end of this array.ArrayNodeadd(BigDecimal v)Method for adding specified number at the end of this array.ArrayNodeadd(BigInteger v)Method for adding specified number at the end of this array.ArrayNodeaddAll(ArrayNode other)Method for adding all child nodes of given Array, appending to child nodes this array containsArrayNodeaddAll(Collection<? extends JsonNode> nodes)Method for adding given nodes as child nodes of this array node.ArrayNodeaddArray()Method that will construct an ArrayNode and add it at the end of this array node.ArrayNodeaddNull()Method that will add a null value at the end of this array node.ObjectNodeaddObject()Method that will construct an ObjectNode and add it at the end of this array node.ArrayNodeaddPOJO(Object value)Method that will construct a POJONode and add it at the end of this array node.ArrayNodeaddRawValue(RawValue raw)com.fasterxml.jackson.core.JsonTokenasToken()Method that can be used for efficient type detection when using stream abstraction for traversing nodes.ArrayNodedeepCopy()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.Iterator<JsonNode>elements()Method for accessing all value nodes of this Node, iff this node is a JSON Array or Object node.booleanequals(Object o)Equality for node objects is defined as full (deep) value equality.booleanequals(Comparator<JsonNode> comparator, JsonNode o)Entry method for invoking customizable comparison, using passed-inComparatorobject.ObjectNodefindParent(String fieldName)Method for finding a JSON Object that contains specified field, within this node or its descendants.List<JsonNode>findParents(String fieldName, List<JsonNode> foundSoFar)JsonNodefindValue(String fieldName)Method for finding a JSON Object field with specified name in this node or its child nodes, and returning value it has.List<JsonNode>findValues(String fieldName, List<JsonNode> foundSoFar)List<String>findValuesAsText(String fieldName, List<String> foundSoFar)JsonNodeget(int index)Method for accessing value of the specified element of an array node.JsonNodeget(String fieldName)Method for accessing value of the specified field of an object node.JsonNodeTypegetNodeType()Return the type of this nodeinthashCode()ArrayNodeinsert(int index, boolean v)Method that will insert specified String at specified position in this array.ArrayNodeinsert(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)ArrayNodeinsert(int index, double v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsert(int index, float v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsert(int index, int v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsert(int index, long v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsert(int index, JsonNode value)Method for inserting specified child node as an element of this Array.ArrayNodeinsert(int index, Boolean value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeinsert(int index, Double value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeinsert(int index, Float value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeinsert(int index, Integer value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeinsert(int index, Long value)Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.ArrayNodeinsert(int index, String v)Method that will insert specified String at specified position in this array.ArrayNodeinsert(int index, BigDecimal v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsert(int index, BigInteger v)Method that will insert specified numeric value at specified position in this array.ArrayNodeinsertArray(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)ArrayNodeinsertNull(int index)Method that will insert a null value at specified position in this array.ObjectNodeinsertObject(int index)Method for creating anObjectNode, appending it at the end of this array, and returning the newly created node (note: NOT 'this' array)ArrayNodeinsertPOJO(int index, Object value)Method that will construct a POJONode and insert it at specified position in this array.booleanisArray()booleanisEmpty()Convenience method that is functionally same as:booleanisEmpty(SerializerProvider serializers)Method that may be called on instance to determine if it is considered "empty" for purposes of serialization filtering or not.JsonNodepath(int index)This method is similar toJsonNode.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 forJsonNode.isMissingNode()) will be returned.JsonNodepath(String fieldName)This method is similar toJsonNode.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 forJsonNode.isMissingNode()) will be returned.JsonNoderemove(int index)Method for removing an entry from this ArrayNode.ArrayNoderemoveAll()Method for removing all elements of this array, leaving the array empty.JsonNoderequired(int index)Method is functionally equivalent topath(index).required()and can be used to check that this node is anArrayNode(that is, represents JSON Array value) and has value for specifiedindex(but note that value may be explicit JSON null value).voidserialize(com.fasterxml.jackson.core.JsonGenerator f, SerializerProvider provider)Method called to serialize node instances using given generator.voidserializeWithType(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer)Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.JsonNodeset(int index, JsonNode value)Method that will set specified field, replacing old value, if any.intsize()-
Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode
arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, missingNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, textNode
-
Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode
findPath, numberType, required, toPrettyString, toString, traverse, traverse
-
Methods inherited from class com.fasterxml.jackson.databind.JsonNode
_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToInt, canConvertToLong, decimalValue, doubleValue, fieldNames, fields, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, with, withArray
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
ArrayNode
public ArrayNode(JsonNodeFactory nf)
-
ArrayNode
public ArrayNode(JsonNodeFactory nf, int capacity)
- Since:
- 2.8
-
ArrayNode
public ArrayNode(JsonNodeFactory nf, List<JsonNode> children)
- Since:
- 2.7
-
-
Method Detail
-
_at
protected JsonNode _at(com.fasterxml.jackson.core.JsonPointer ptr)
-
deepCopy
public ArrayNode deepCopy()
Description copied from class:JsonNodeMethod 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.
-
isEmpty
public boolean isEmpty(SerializerProvider serializers)
Description copied from class:JsonSerializable.BaseMethod that may be called on instance to determine if it is considered "empty" for purposes of serialization filtering or not.- Overrides:
isEmptyin classJsonSerializable.Base
-
getNodeType
public JsonNodeType getNodeType()
Description copied from class:JsonNodeReturn the type of this node- Specified by:
getNodeTypein classJsonNode- Returns:
- the node type as a
JsonNodeTypeenum value
-
isArray
public boolean isArray()
-
asToken
public com.fasterxml.jackson.core.JsonToken asToken()
Description copied from class:BaseJsonNodeMethod that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the firstJsonTokenthat equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)- Specified by:
asTokenin interfacecom.fasterxml.jackson.core.TreeNode- Specified by:
asTokenin classContainerNode<ArrayNode>
-
size
public int size()
- Specified by:
sizein interfacecom.fasterxml.jackson.core.TreeNode- Specified by:
sizein classContainerNode<ArrayNode>
-
isEmpty
public boolean isEmpty()
Description copied from class:JsonNodeConvenience method that is functionally same as:size() == 0for all node types.
-
elements
public Iterator<JsonNode> elements()
Description copied from class:JsonNodeMethod 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.
-
get
public JsonNode get(int index)
Description copied from class:JsonNodeMethod 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!), aNullNodewill be returned, not null.- Specified by:
getin interfacecom.fasterxml.jackson.core.TreeNode- Specified by:
getin classContainerNode<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 fieldName)
Description copied from class:JsonNodeMethod 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!), aNullNodewill be returned, not null.- Specified by:
getin interfacecom.fasterxml.jackson.core.TreeNode- Specified by:
getin classContainerNode<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.
-
path
public JsonNode path(String fieldName)
Description copied from class:JsonNodeThis method is similar toJsonNode.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 forJsonNode.isMissingNode()) will be returned. This allows for convenient and safe chained access via path calls.
-
path
public JsonNode path(int index)
Description copied from class:JsonNodeThis method is similar toJsonNode.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 forJsonNode.isMissingNode()) will be returned. This allows for convenient and safe chained access via path calls.
-
required
public JsonNode required(int index)
Description copied from class:JsonNodeMethod is functionally equivalent topath(index).required()and can be used to check that this node is anArrayNode(that is, represents JSON Array value) and has value for specifiedindex(but note that value may be explicit JSON null value). If this node is Array Node and has value for specified index,thisis returned to allow chaining; otherwiseIllegalArgumentExceptionis thrown.- Overrides:
requiredin classBaseJsonNode- Returns:
thisnode to allow chaining
-
equals
public boolean equals(Comparator<JsonNode> comparator, JsonNode o)
Description copied from class:JsonNodeEntry method for invoking customizable comparison, using passed-inComparatorobject. Nodes will handle traversal of structured types (arrays, objects), but defer to comparator for scalar value comparisons. If a "natural"Comparatoris passed -- one that simply callsequals()on one of arguments, passing the other -- implementation is the same as directly callingequals()on node.Default implementation simply delegates to passed in
comparator, withthisas the first argument, andotheras the second argument.
-
serialize
public void serialize(com.fasterxml.jackson.core.JsonGenerator f, SerializerProvider provider) throws IOExceptionDescription copied from class:BaseJsonNodeMethod called to serialize node instances using given generator.- Specified by:
serializein interfaceJsonSerializable- Specified by:
serializein classBaseJsonNode- Throws:
IOException
-
serializeWithType
public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOExceptionDescription copied from class:BaseJsonNodeType information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.- Specified by:
serializeWithTypein interfaceJsonSerializable- Specified by:
serializeWithTypein classBaseJsonNode- Throws:
IOException
-
findValue
public JsonNode findValue(String fieldName)
Description copied from class:JsonNodeMethod for finding a 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.
-
findValues
public List<JsonNode> findValues(String fieldName, List<JsonNode> foundSoFar)
- Specified by:
findValuesin classJsonNode
-
findValuesAsText
public List<String> findValuesAsText(String fieldName, List<String> foundSoFar)
- Specified by:
findValuesAsTextin classJsonNode
-
findParent
public ObjectNode findParent(String fieldName)
Description copied from class:JsonNodeMethod 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:
findParentin classJsonNode- Parameters:
fieldName- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findParents
public List<JsonNode> findParents(String fieldName, List<JsonNode> foundSoFar)
- Specified by:
findParentsin classJsonNode
-
set
public JsonNode set(int index, JsonNode value)
Method that will set specified field, replacing old value, if any.- Parameters:
value- to set field to; if null, will be converted to aNullNodefirst (to remove field entry, callremove(int)instead)- Returns:
- Old value of the field, if any; null if there was no old value.
-
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:
removeAllin classContainerNode<ArrayNode>- Returns:
- This node (to allow 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
-
addObject
public ObjectNode addObject()
Method that will construct an ObjectNode and add it at the end of this array node.- Returns:
- Newly constructed ObjectNode
-
addPOJO
public ArrayNode addPOJO(Object value)
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
- Since:
- 2.6
-
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(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 value)
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 value)
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 value)
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 value)
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
- Since:
- 2.9
-
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 value)
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)
-
insertObject
public ObjectNode insertObject(int index)
Method for creating anObjectNode, appending it at the end of this array, and returning the newly created node (note: NOT 'this' array)- Returns:
- Newly constructed ObjectNode
-
insertPOJO
public ArrayNode insertPOJO(int index, Object value)
Method that will construct a POJONode and insert it at specified position in this array.- Returns:
- This array node, to allow chaining
-
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
-
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 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, 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 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, 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 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, 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 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, 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
-
equals
public boolean equals(Object o)
Description copied from class:JsonNodeEquality 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.
-
_childrenEqual
protected boolean _childrenEqual(ArrayNode other)
- Since:
- 2.3
-
hashCode
public int hashCode()
- Specified by:
hashCodein classBaseJsonNode
-
-