com.fasterxml.jackson.databind.node

Class ObjectNode

java.lang.Object

com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.node.BaseJsonNode

com.fasterxml.jackson.databind.node.ContainerNode<ObjectNode>

com.fasterxml.jackson.databind.node.ObjectNode

All Implemented Interfaces:

TreeNode, JsonSerializable, Iterable<JsonNode>

public final class ObjectNode
extends ContainerNode<ObjectNode>

Override of Jackson's ObjectNode

We override it to make it final (the original implementation isn't), which also allows for code simplification all around.

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.node.ContainerNode

ContainerNode.NoNodesIterator, ContainerNode.NoStringsIterator

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode

_nodeFactory

Fields inherited from class com.fasterxml.jackson.databind.JsonNode

NO_NODES, NO_STRINGS

Constructor Summary

Constructors

Constructor and Description
ObjectNode(JsonNodeFactory nc)

Method Summary

Methods

Modifier and Type	Method and Description
JsonToken	asToken()
ObjectNode	deepCopy()
Iterator<JsonNode>	elements()
boolean	equals(Object o)
Iterator<String>	fieldNames()
Iterator<Map.Entry<String,JsonNode>>	fields() Method to use for accessing all fields (with both names and values) of this JSON Object.
ObjectNode	findParent(String fieldName)
List<JsonNode>	findParents(String fieldName, List<JsonNode> foundSoFar)
JsonNode	findValue(String fieldName)
List<JsonNode>	findValues(String fieldName, List<JsonNode> foundSoFar)
List<String>	findValuesAsText(String fieldName, List<String> foundSoFar)
JsonNode	get(int index)
JsonNode	get(String fieldName)
int	hashCode()
boolean	isObject()
JsonNode	path(int index)
JsonNode	path(String fieldName)
ObjectNode	put(String fieldName, BigDecimal v) Method for setting value of a field to specified numeric value.
ObjectNode	put(String fieldName, boolean v) Method for setting value of a field to specified String value.
ObjectNode	put(String fieldName, Boolean value) Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
ObjectNode	put(String fieldName, byte[] v) Method for setting value of a field to specified binary value
ObjectNode	put(String fieldName, double v) Method for setting value of a field to specified numeric value.
ObjectNode	put(String fieldName, Double value) Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
ObjectNode	put(String fieldName, float v) Method for setting value of a field to specified numeric value.
ObjectNode	put(String fieldName, Float value) Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
ObjectNode	put(String fieldName, int v) Method for setting value of a field to specified numeric value.
ObjectNode	put(String fieldName, Integer value) Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
JsonNode	put(String fieldName, JsonNode value) Method that will set specified field, replacing old value, if any.
ObjectNode	put(String fieldName, long v) Method for setting value of a field to specified numeric value.
ObjectNode	put(String fieldName, Long value) Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.
ObjectNode	put(String fieldName, String v) Method for setting value of a field to specified String value.
JsonNode	putAll(Map<String,JsonNode> properties) Method for adding given properties to this object node, overriding any existing values for those properties.
JsonNode	putAll(ObjectNode other) Method for adding all properties of the given Object, overriding any existing values for those properties.
ArrayNode	putArray(String fieldName) Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.
ObjectNode	putNull(String fieldName)
ObjectNode	putObject(String fieldName) Method that will construct an ObjectNode and add it as a field of this ObjectNode, replacing old value, if any.
ObjectNode	putPOJO(String fieldName, Object pojo)
ObjectNode	remove(Collection<String> fieldNames) Method for removing specified field properties out of this ObjectNode.
JsonNode	remove(String fieldName) Method for removing field entry from this ObjectNode.
ObjectNode	removeAll() Method for removing all field properties, such that this ObjectNode will contain no properties after call.
JsonNode	replace(String fieldName, JsonNode value) Method for replacing value of specific property with passed value, and returning value (or null if none).
ObjectNode	retain(Collection<String> fieldNames) Method for removing all field properties out of this ObjectNode except for ones specified in argument.
ObjectNode	retain(String... fieldNames) Method for removing all field properties out of this ObjectNode except for ones specified in argument.
void	serialize(JsonGenerator jgen, SerializerProvider provider) Method that can be called to serialize this node and all of its descendants using specified JSON generator.
void	serializeWithType(JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer)
JsonNode	set(String fieldName, JsonNode value) Method that will set specified field, replacing old value, if any.
JsonNode	setAll(Map<String,JsonNode> properties) Method for adding given properties to this object node, overriding any existing values for those properties.
JsonNode	setAll(ObjectNode other) Method for adding all properties of the given Object, overriding any existing values for those properties.
int	size()
String	toString()
ObjectNode	with(String propertyName)
ArrayNode	withArray(String propertyName)
ObjectNode	without(Collection<String> fieldNames) Method for removing specified field properties out of this ObjectNode.
JsonNode	without(String fieldName) Method for removing field entry from this ObjectNode, and returning instance after removal.

Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode

arrayNode, asText, binaryNode, binaryNode, booleanNode, isContainerNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, POJONode, textNode

Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

findPath, numberType, traverse

Methods inherited from class com.fasterxml.jackson.databind.JsonNode

asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, bigIntegerValue, binaryValue, booleanValue, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isDouble, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isTextual, isValueNode, iterator, longValue, numberValue, textValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectNode

public ObjectNode(JsonNodeFactory nc)

Method Detail

deepCopy

public ObjectNode deepCopy()

Specified by:

deepCopy in class JsonNode

asToken

public JsonToken asToken()

Specified by:

asToken in interface TreeNode

Specified by:

asToken in class ContainerNode<ObjectNode>

isObject

public boolean isObject()

Overrides:

isObject in class JsonNode

size

public int size()

Specified by:

size in class ContainerNode<ObjectNode>

elements

public Iterator<JsonNode> elements()

Overrides:

elements in class JsonNode

get

public JsonNode get(int index)

Specified by:

get in class ContainerNode<ObjectNode>

get

public JsonNode get(String fieldName)

Specified by:

get in class ContainerNode<ObjectNode>

fieldNames

public Iterator<String> fieldNames()

Overrides:

fieldNames in class JsonNode

path

public JsonNode path(int index)

Specified by:

path in class JsonNode

path

public JsonNode path(String fieldName)

Specified by:

path in class JsonNode

fields

public Iterator<Map.Entry<String,JsonNode>> fields()

Method to use for accessing all fields (with both names and values) of this JSON Object.

Overrides:

fields in class JsonNode

with

public ObjectNode with(String propertyName)

Overrides:

with in class JsonNode

withArray

public ArrayNode withArray(String propertyName)

Overrides:

withArray in class JsonNode

findValue

public JsonNode findValue(String fieldName)

Specified by:

findValue in class ContainerNode<ObjectNode>

findValues

public List<JsonNode> findValues(String fieldName,
                        List<JsonNode> foundSoFar)

Specified by:

findValues in class ContainerNode<ObjectNode>

findValuesAsText

public List<String> findValuesAsText(String fieldName,
                            List<String> foundSoFar)

Specified by:

findValuesAsText in class ContainerNode<ObjectNode>

findParent

public ObjectNode findParent(String fieldName)

Overrides:

findParent in class ContainerNode<ObjectNode>

findParents

public List<JsonNode> findParents(String fieldName,
                         List<JsonNode> foundSoFar)

Specified by:

findParents in class ContainerNode<ObjectNode>

serialize

public void serialize(JsonGenerator jgen,
             SerializerProvider provider)
               throws IOException

Method that can be called to serialize this node and all of its descendants using specified JSON generator.

Specified by:

serialize in interface JsonSerializable

Specified by:

serialize in class BaseJsonNode

Throws:

IOException

serializeWithType

public void serializeWithType(JsonGenerator jgen,
                     SerializerProvider provider,
                     TypeSerializer typeSer)
                       throws IOException

Specified by:

serializeWithType in interface JsonSerializable

Specified by:

serializeWithType in class BaseJsonNode

Throws:

IOException

set

public JsonNode set(String fieldName,
           JsonNode value)

Method that will set specified field, replacing old value, if any. Note that this is identical to replace(String, JsonNode), except for return value.

NOTE: added to replace those uses of put(String, JsonNode) where chaining with 'this' is desired.

Parameters:

value - to set field to; if null, will be converted to a NullNode first (to remove field entry, call remove(java.lang.String) instead)

Returns:

This node after adding/replacing property value (to allow chaining)

Since:

2.1

setAll

public JsonNode setAll(Map<String,JsonNode> properties)

Method for adding given properties to this object node, overriding any existing values for those properties.

Parameters:

properties - Properties to add

Returns:

This node after adding/replacing property values (to allow chaining)

Since:

2.1

setAll

public JsonNode setAll(ObjectNode other)

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 after addition (to allow chaining)

Since:

2.1

replace

public JsonNode replace(String fieldName,
               JsonNode value)

Method for replacing value of specific property with passed value, and returning value (or null if none).

Parameters:

fieldName - Property of which value to replace

value - Value to set property to, replacing old value if any

Returns:

Old value of the property; null if there was no such property with value

Since:

2.1

without

public JsonNode without(String fieldName)

Method for removing field entry from this ObjectNode, and returning instance after removal.

Returns:

This node after removing entry (if any)

Since:

2.1

without

public ObjectNode without(Collection<String> fieldNames)

Method for removing specified field properties out of this ObjectNode.

Parameters:

fieldNames - Names of fields to remove

Returns:

This node after removing entries

Since:

2.1

put

public JsonNode put(String fieldName,
           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 a NullNode first (to remove field entry, call remove(java.lang.String) instead)

NOTE: this method will be deprecated in 2.2; and should be replace with either set(String, JsonNode) or replace(String, JsonNode), depending on which return value is desired for possible chaining.

Returns:

Old value of the field, if any; null if there was no old value.

remove

public JsonNode remove(String fieldName)

Method for removing field entry from this ObjectNode. Will return value of the field, if such field existed; null if not.

Returns:

Value of specified field, if it existed; null if not

remove

public ObjectNode remove(Collection<String> fieldNames)

Method for removing specified field properties out of this ObjectNode.

Parameters:

fieldNames - Names of fields to remove

Returns:

This node after removing entries

removeAll

public ObjectNode removeAll()

Method for removing all field properties, such that this ObjectNode will contain no properties after call.

Specified by:

removeAll in class ContainerNode<ObjectNode>

Returns:

This node after removing all entries

putAll

public JsonNode putAll(Map<String,JsonNode> properties)

Method for adding given properties to this object node, overriding any existing values for those properties.

NOTE: this method will be deprecated in 2.2; and should be replace with setAll(Map).

Parameters:

properties - Properties to add

Returns:

This node after adding/replacing property values (to allow chaining)

putAll

public JsonNode putAll(ObjectNode other)

Method for adding all properties of the given Object, overriding any existing values for those properties.

NOTE: this method will be deprecated in 2.2; and should be replace with setAll(ObjectNode).

Parameters:

other - Object of which properties to add to this object

Returns:

This node (to allow chaining)

retain

public ObjectNode retain(Collection<String> fieldNames)

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 node (to allow call chaining)

retain

public ObjectNode retain(String... fieldNames)

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 node (to allow call chaining)

putArray

public ArrayNode putArray(String fieldName)

Method that will construct an ArrayNode and add it as a field of this ObjectNode, replacing old value, if any.

NOTE: Unlike all put(...) methods, return value is NOT this ObjectNode, but the newly created ArrayNode instance.

Returns:

Newly constructed ArrayNode (NOT the old value, which could be of any type)

putObject

public ObjectNode putObject(String fieldName)

Method that will construct an ObjectNode and add it as a field of this ObjectNode, replacing old value, if any.

NOTE: Unlike all put(...) methods, return value is NOT this ObjectNode, but the newly created ObjectNode instance.

Returns:

Newly constructed ObjectNode (NOT the old value, which could be of any type)

putPOJO

public ObjectNode putPOJO(String fieldName,
                 Object pojo)

Returns:

This node (to allow chaining)

putNull

public ObjectNode putNull(String fieldName)

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             int v)

Method for setting value of a field to specified numeric value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             Integer value)

Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             long v)

Method for setting value of a field to specified numeric value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             Long value)

Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             float v)

Method for setting value of a field to specified numeric value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             Float value)

Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             double v)

Method for setting value of a field to specified numeric value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             Double value)

Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             BigDecimal v)

Method for setting value of a field to specified numeric value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             String v)

Method for setting value of a field to specified String value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             boolean v)

Method for setting value of a field to specified String value.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             Boolean value)

Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.

Returns:

This node (to allow chaining)

put

public ObjectNode put(String fieldName,
             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)

Specified by:

equals in class JsonNode

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in class JsonNode