Package org.codehaus.jackson.node
Class ObjectNode
java.lang.Object
org.codehaus.jackson.JsonNode
org.codehaus.jackson.node.BaseJsonNode
org.codehaus.jackson.node.ContainerNode
org.codehaus.jackson.node.ObjectNode
- All Implemented Interfaces:
Iterable<JsonNode>
,JsonSerializable
,JsonSerializableWithType
Node that maps to JSON Object structures in JSON content.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
For efficiency, let's share the "no fields" iterator...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 TypeMethodDescriptionasToken()
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.Method for accessing names of all fields for this Node, iff this node is a JSON Object node.Method to use for accessing all fields (with both names and values) of this JSON Object.int
hashCode()
boolean
isObject()
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.void
Method for setting value of a field to specified String value.void
Method for setting value of a field to specified binary valuevoid
Method for setting value of a field to specified numeric value.void
Method for setting value of a field to specified numeric value.void
Method for setting value of a field to specified numeric value.void
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
put
(String fieldName, BigDecimal v) Method for setting value of a field to specified numeric value.Method that will set specified field, replacing old value, if any.Method for adding given properties to this object node, overriding any existing values for those properties.putAll
(ObjectNode other) Method for adding all properties of the given Object, overriding any existing values for those properties.Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.protected void
putContentsTo
(Map<String, JsonNode> dst) void
Method that will construct an ObjectNode and add it as a field of this ObjectNode, replacing old value, if any.void
Method for removing field entry from this ObjectNode.remove
(Collection<String> fieldNames) Method for removing specified field properties out of this ObjectNode.Method for removing all field properties, such that this ObjectNode will contain no properties after call.Method for removing all field properties out of this ObjectNode except for ones specified in argument.retain
(Collection<String> fieldNames) Method for removing all field properties out of this ObjectNode except for ones specified in argument.final void
serialize
(JsonGenerator jg, SerializerProvider provider) Method that can be called to serialize this node and all of its descendants using specified JSON 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.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.Method that can be called on object nodes, to access a property that has object value; or if no such property exists, to create and return such object node.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, getIntValue, getLongValue, getNumberValue, getPath, getPath, getTextValue, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, has, has, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isDouble, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isTextual, isValueNode, iterator
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
-
ObjectNode
-
-
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
-
isObject
public boolean isObject() -
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.
-
getFieldNames
Description copied from class:JsonNode
Method for accessing names of all fields for this Node, iff this node is a JSON Object node.- Overrides:
getFieldNames
in classJsonNode
-
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. -
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. -
getFields
Method to use for accessing all fields (with both names and values) of this JSON Object. -
with
Description copied from class:JsonNode
Method that can be called on object nodes, to access a property that has object value; or if no such property exists, to create and return such object node. If node method is called on is not Object node, or if property exists and has value that is not object node,UnsupportedOperationException
is thrown -
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
-
serialize
public final void serialize(JsonGenerator jg, SerializerProvider provider) throws IOException, JsonProcessingException Method that can be called to serialize this node and all of its descendants using specified JSON 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
-
put
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(java.lang.String)
instead)- Returns:
- Old value of the field, if any; null if there was no old value.
-
remove
Method for removing field entry from this ObjectNode. Will return value of the field, if such field existed; null if not. -
remove
Method for removing specified field properties out of this ObjectNode.- Parameters:
fieldNames
- Names of fields to remove- Returns:
- This ObjectNode after removing entries
- Since:
- 1.6
-
removeAll
Method for removing all field properties, such that this ObjectNode will contain no properties after call.- Specified by:
removeAll
in classContainerNode
- Returns:
- Container node itself (to allow method call chaining)
-
putAll
Method for adding given properties to this object node, overriding any existing values for those properties.- Parameters:
properties
- Properties to add- Returns:
- This node (to allow chaining)
- Since:
- 1.3
-
putAll
Method for adding all properties of the given Object, overriding any existing values for those properties.- Parameters:
other
- Object of which properties to add to this object- Returns:
- This node (to allow chaining)
- Since:
- 1.3
-
retain
Method for removing all field properties out of this ObjectNode except for ones specified in argument.- Parameters:
fieldNames
- Fields to retain in this ObjectNode- Returns:
- This ObjectNode (to allow call chaining)
- Since:
- 1.6
-
retain
Method for removing all field properties out of this ObjectNode except for ones specified in argument.- Parameters:
fieldNames
- Fields to retain in this ObjectNode- Returns:
- This ObjectNode (to allow call chaining)
- Since:
- 1.6
-
putArray
Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.- Returns:
- Newly constructed ArrayNode (NOT the old value, which could be of any type)
-
putObject
Method that will construct an ObjectNode and add it as a field of this ObjectNode, replacing old value, if any.- Returns:
- Newly constructed ObjectNode (NOT the old value, which could be of any type)
-
putPOJO
-
putNull
-
put
Method for setting value of a field to specified numeric value. -
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
put
Method for setting value of a field to specified numeric value. -
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
put
Method for setting value of a field to specified numeric value. -
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
put
Method for setting value of a field to specified numeric value. -
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
put
Method for setting value of a field to specified numeric value. -
put
Method for setting value of a field to specified String value. -
put
Method for setting value of a field to specified String value. -
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Since:
- 1.9
-
put
Method for setting value of a field to specified binary value -
putContentsTo
- 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.
-