Package org.codehaus.jackson.node
Class ArrayNode
java.lang.Object
org.codehaus.jackson.JsonNode
org.codehaus.jackson.node.BaseJsonNode
org.codehaus.jackson.node.ContainerNode
org.codehaus.jackson.node.ArrayNode
- All Implemented Interfaces:
Iterable<JsonNode>
,JsonSerializable
,JsonSerializableWithType
Node class that represents Arrays mapped from Json content.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.codehaus.jackson.node.ContainerNode
ContainerNode.NoNodesIterator, ContainerNode.NoStringsIterator
-
Field Summary
FieldsFields inherited from class org.codehaus.jackson.JsonNode
NO_NODES, NO_STRINGS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(boolean v) Method for setting value of a field to specified String value.void
add
(byte[] v) Method for setting value of a field to specified binary valuevoid
add
(double v) Method for setting value of a field to specified numeric value.void
add
(float v) Method for setting value of a field to specified numeric value.void
add
(int v) Method for setting value of a field to specified numeric value.void
add
(long v) Method for setting value of a field to specified numeric value.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Method for setting value of a field to specified String value.void
add
(BigDecimal v) Method for setting value of a field to specified numeric value.void
addAll
(Collection<JsonNode> nodes) Method for adding given nodes as child nodes of this array node.Method for adding all child nodes of given Array, appending to child nodes this array containsaddArray()
Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.protected void
addContentsTo
(List<JsonNode> dst) void
addNull()
Method that will construct an ObjectNode and add it at the end of this array node.void
Method that will construct a POJONode and add it at the end of this array node.asToken()
Method that can be used for efficient type detection when using stream abstraction for traversing nodes.boolean
Equality for node objects is defined as full (deep) value equality.findParent
(String fieldName) Method for finding a JSON Object that contains specified field, within this node or its descendants.findParents
(String fieldName, List<JsonNode> foundSoFar) Method for finding a JSON Object field with specified name in this node or its child nodes, and returning value it has.findValues
(String fieldName, List<JsonNode> foundSoFar) findValuesAsText
(String fieldName, List<String> foundSoFar) get
(int index) Method for accessing value of the specified element of an array node.Method for accessing value of the specified field of an object node.Method for accessing all value nodes of this Node, iff this node is a JSON Array or Object node.int
hashCode()
void
insert
(int index, boolean v) Method for setting value of a field to specified String value.void
insert
(int index, byte[] v) Method for setting value of a field to specified binary valuevoid
insert
(int index, double v) Method for setting value of a field to specified numeric value.void
insert
(int index, float v) Method for setting value of a field to specified numeric value.void
insert
(int index, int v) Method for setting value of a field to specified numeric value.void
insert
(int index, long v) Method for setting value of a field to specified numeric value.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.void
Method for setting value of a field to specified String value.void
insert
(int index, BigDecimal v) Method for setting value of a field to specified numeric value.void
Method for inserting specified child node as an element of this Array.insertArray
(int index) void
insertNull
(int index) insertObject
(int index) Method that will construct an ObjectNode and add it at the end of this array node.void
insertPOJO
(int index, Object value) Method that will construct a POJONode and add it at the end of this array node.boolean
isArray()
path
(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.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.remove
(int index) Method for removing an entry from this ArrayNode.Method for removing all children container has (if any)final void
serialize
(JsonGenerator jg, SerializerProvider provider) Method called to serialize node instances using given generator.void
serializeWithType
(JsonGenerator jg, SerializerProvider provider, TypeSerializer typeSer) Type information is needed, even if JsonNode instances are "plain" JSON, since they may be mixed with other types.Method that will set specified field, replacing old value, if any.int
size()
Method that returns number of child nodes this node contains: for Array nodes, number of child elements, for Object nodes, number of fields, and for all other nodes 0.toString()
Note: marked as abstract to ensure all implementation classes define it properly.Methods inherited from class org.codehaus.jackson.node.ContainerNode
arrayNode, asText, binaryNode, binaryNode, booleanNode, getValueAsText, isContainerNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, POJONode, textNode
Methods inherited from class org.codehaus.jackson.node.BaseJsonNode
findPath, getNumberType, traverse
Methods inherited from class org.codehaus.jackson.JsonNode
asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, findParents, findValues, findValuesAsText, getBigIntegerValue, getBinaryValue, getBooleanValue, getDecimalValue, getDoubleValue, getFieldNames, getFields, getIntValue, getLongValue, getNumberValue, getPath, getPath, getTextValue, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, has, has, isBigDecimal, isBigInteger, isBinary, isBoolean, isDouble, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isTextual, isValueNode, iterator, with
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
_children
-
-
Constructor Details
-
ArrayNode
-
-
Method Details
-
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 firstJsonToken
that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)- Specified by:
asToken
in classContainerNode
-
isArray
public boolean isArray() -
size
public int size()Description copied from class:JsonNode
Method that returns number of child nodes this node contains: for Array nodes, number of child elements, for Object nodes, number of fields, and for all other nodes 0.- Specified by:
size
in classContainerNode
- Returns:
- For non-container nodes returns 0; for arrays number of contained elements, and for objects number of fields.
-
getElements
Description copied from class:JsonNode
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.- Overrides:
getElements
in classJsonNode
-
get
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.- Specified by:
get
in classContainerNode
- Returns:
- Node that represent value of the specified element, if this node is an array and has specified element. Null otherwise.
-
get
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.- Specified by:
get
in classContainerNode
- 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
Description copied from class:JsonNode
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. This allows for convenient and safe chained access via path calls. -
path
Description copied from class:JsonNode
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. This allows for convenient and safe chained access via path calls. -
serialize
public final void serialize(JsonGenerator jg, SerializerProvider provider) throws IOException, JsonProcessingException Description copied from class:BaseJsonNode
Method called to serialize node instances using given generator.- Specified by:
serialize
in interfaceJsonSerializable
- Specified by:
serialize
in classBaseJsonNode
- Throws:
IOException
JsonProcessingException
-
serializeWithType
public void serializeWithType(JsonGenerator jg, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonProcessingException 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 interfaceJsonSerializableWithType
- Specified by:
serializeWithType
in classBaseJsonNode
- Throws:
IOException
JsonProcessingException
-
findValue
Description copied from class:JsonNode
Method 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.- Specified by:
findValue
in classContainerNode
- Parameters:
fieldName
- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findValues
- Specified by:
findValues
in classContainerNode
-
findValuesAsText
- Specified by:
findValuesAsText
in classContainerNode
-
findParent
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 classContainerNode
- Parameters:
fieldName
- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findParents
- Specified by:
findParents
in classContainerNode
-
set
Method that will set specified field, replacing old value, if any.- Parameters:
value
- to set field to; if null, will be converted to aNullNode
first (to remove field entry, callremove(int)
instead)- Returns:
- Old value of the field, if any; null if there was no old value.
-
add
-
addAll
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)
- Since:
- 1.3
-
addAll
Method for adding given nodes as child nodes of this array node.- Parameters:
nodes
- Nodes to add- Returns:
- This node (to allow chaining)
- Since:
- 1.3
-
insert
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. -
remove
Method for removing an entry from this ArrayNode. Will return value of the entry at specified index, if entry existed; null if not. -
removeAll
Description copied from class:ContainerNode
Method for removing all children container has (if any)- Specified by:
removeAll
in classContainerNode
- Returns:
- Container node itself (to allow method call chaining)
-
addArray
Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.- Returns:
- Newly constructed ArrayNode
-
addObject
Method that will construct an ObjectNode and add it at the end of this array node.- Returns:
- Newly constructed ObjectNode
-
addPOJO
Method that will construct a POJONode and add it at the end of this array node. -
addNull
public void addNull() -
add
public void add(int v) Method for setting value of a field to specified numeric value. -
add
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
add
public void add(long v) Method for setting value of a field to specified numeric value. -
add
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
add
public void add(float v) Method for setting value of a field to specified numeric value. -
add
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
add
public void add(double v) Method for setting value of a field to specified numeric value. -
add
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
add
Method for setting value of a field to specified numeric value. -
add
Method for setting value of a field to specified String value. -
add
public void add(boolean v) Method for setting value of a field to specified String value. -
add
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
add
public void add(byte[] v) Method for setting value of a field to specified binary value -
insertArray
-
insertObject
Method that will construct an ObjectNode and add it at the end of this array node.- Returns:
- Newly constructed ObjectNode
-
insertPOJO
Method that will construct a POJONode and add it at the end of this array node. -
insertNull
public void insertNull(int index) -
insert
public void insert(int index, int v) Method for setting value of a field to specified numeric value. -
insert
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
insert
public void insert(int index, long v) Method for setting value of a field to specified numeric value. -
insert
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
insert
public void insert(int index, float v) Method for setting value of a field to specified numeric value. -
insert
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
insert
public void insert(int index, double v) Method for setting value of a field to specified numeric value. -
insert
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
insert
Method for setting value of a field to specified numeric value. -
insert
Method for setting value of a field to specified String value. -
insert
public void insert(int index, boolean v) Method for setting value of a field to specified String value. -
insert
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
insert
public void insert(int index, byte[] v) Method for setting value of a field to specified binary value -
addContentsTo
- Since:
- 1.6
-
equals
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
. -
hashCode
public int hashCode() -
toString
Description copied from class:JsonNode
Note: marked as abstract to ensure all implementation classes define it properly.
-
_set
-