Class ObjectNode
- All Implemented Interfaces:
TreeNode
,JsonSerializable
,JsonNodeCreator
,Serializable
,Iterable<JsonNode>
Note: class was final
temporarily for Jackson 2.2.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
Field Summary
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.node.ContainerNode
_nodeFactory
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected JsonNode
_at
(JsonPointer ptr) 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.protected boolean
_childrenEqual
(ObjectNode other) protected ObjectNode
asToken()
Method that can be used for efficient type detection when using stream abstraction for traversing nodes.deepCopy()
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.elements()
Method for accessing all value nodes of this Node, iff this node is a JSON Array or Object node.boolean
Equality for node objects is defined as full (deep) value equality.boolean
equals
(Comparator<JsonNode> comparator, JsonNode o) Entry method for invoking customizable comparison, using passed-inComparator
object.Method for accessing names of all fields for this node, iff this node is an Object node.fields()
Method to use for accessing all properties (with both names and values) of this JSON Object.findParent
(String propertyName) Method for finding a JSON Object that contains specified field, within this node or its descendants.findParents
(String propertyName, 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 propertyName, List<JsonNode> foundSoFar) findValuesAsText
(String propertyName, 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.Return the type of this nodeint
hashCode()
boolean
isEmpty()
Convenience method that is functionally same as:boolean
isEmpty
(SerializerProvider serializers) Method that may be called on instance to determine if it is considered "empty" for purposes of serialization filtering or not.final boolean
isObject()
Method that returns true if this node is an Object node, false otherwise.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.Method for setting value of a field to specified String value.Method for setting value of a field to specified binary valueMethod for setting value of a field to specified numeric value.Method for setting value of a field to specified numeric value.Method for setting value of a field to specified numeric value.Method for setting value of a field to specified numeric value.Method for setting value of a property to specified numeric value.Deprecated.Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.Method for setting value of a field to specified numeric value.Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.Method for setting value of a field to specified String value.put
(String fieldName, BigDecimal v) Method for setting value of a field to specified numeric value.put
(String fieldName, BigInteger v) Method for setting value of a field to specified numeric value.putAll
(ObjectNode other) Deprecated.Since 2.4 usesetAll(ObjectNode)
,Deprecated.Since 2.4 usesetAll(Map)
,Method that will construct an ArrayNode and add it as a property of thisObjectNode
, replacing old value, if any.putIfAbsent
(String propertyName, JsonNode value) Method that will set value of specified property if (and only if) it had no set value previously.Method for setting value of a property to explicitnull
value.Method that will construct an ObjectNode and add it as a property of thisObjectNode
, replacing old value, if any.Method for adding an opaque Java value as the value of specified property.putRawValue
(String propertyName, RawValue raw) Method for removing a property from thisObjectNode
.remove
(Collection<String> propertyNames) Method for removing specified field properties out of this ObjectNode.Method for removing all properties, such that this ObjectNode will contain no properties after call.Method for replacing value of specific property with passed value, and returning value (or null if none).Method is functionally equivalent topath(fieldName).required()
and can be used to check that this node is anObjectNode
(that is, represents JSON Object value) and has value for specified property with keyfieldName
(but note that value may be explicit JSON null value).Method for removing all properties out of this ObjectNode except for ones specified in argument.retain
(Collection<String> propertyNames) Method for removing all properties out of this ObjectNode except for ones specified in argument.void
serialize
(JsonGenerator g, SerializerProvider provider) Method that can be called to serialize this node and all of its descendants using specified JSON generator.void
serializeWithType
(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.<T extends JsonNode>
TMethod that will set specified property, replacing old value, if any.<T extends JsonNode>
TsetAll
(ObjectNode other) Method for adding all properties of the given Object, overriding any existing values for those properties.<T extends JsonNode>
TMethod for adding given properties to this object node, overriding any existing values for those properties.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.Method that can be called on Object nodes, to access a property that has Object value; or if no such property exists, to create, add and return such Object node.Method that can be called on Object nodes, to access a property that hasArray
value; or if no such property exists, to create, add and return such Array node.<T extends JsonNode>
TMethod for removing property from this ObjectNode, and returning instance after removal.<T extends JsonNode>
Twithout
(Collection<String> propertyNames) Method for removing specified field properties out of this ObjectNode.Methods inherited from class edu.internet2.middleware.grouperClientExt.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 edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.node.BaseJsonNode
findPath, numberType, required, toPrettyString, toString, traverse, traverse
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonNode
_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue
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
-
ObjectNode
- Since:
- 2.4
-
-
Method Details
-
_at
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. -
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.
-
isEmpty
Description copied from class:JsonSerializable.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 classJsonSerializable.Base
-
getNodeType
Description copied from class:JsonNode
Return the type of this node- Specified by:
getNodeType
in classJsonNode
- Returns:
- the node type as a
JsonNodeType
enum value
-
isObject
public final boolean isObject()Description copied from interface:TreeNode
Method that returns true if this node is an Object node, false otherwise. Note that if true is returned,TreeNode.isContainerNode()
must also return true. -
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 interfaceTreeNode
- Specified by:
asToken
in classContainerNode<ObjectNode>
- Returns:
JsonToken
that is most closely associated with the node type
-
size
public int size()Description copied from interface:TreeNode
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 interfaceTreeNode
- Specified by:
size
in classContainerNode<ObjectNode>
- Returns:
- For non-container nodes returns 0; for arrays number of contained elements, and for objects number of fields.
-
isEmpty
public boolean isEmpty()Description copied from class:JsonNode
Convenience method that is functionally same as:size() == 0
for all node types. -
elements
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. -
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.NOTE: if the element value has been explicitly set as
null
(which is different from removal!), aNullNode
will be returned, not null.- Specified by:
get
in interfaceTreeNode
- Specified by:
get
in classContainerNode<ObjectNode>
- Parameters:
index
- Index of the Array node element to access- 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.NOTE: if the property value has been explicitly set as
null
(which is different from removal!), aNullNode
will be returned, not null.- Specified by:
get
in interfaceTreeNode
- Specified by:
get
in classContainerNode<ObjectNode>
- Parameters:
propertyName
- Name of the field (of Object node) to access- Returns:
- Node that represent value of the specified field, if this node is an object and has value for the specified field. Null otherwise.
-
fieldNames
Description copied from interface:TreeNode
Method for accessing names of all fields for this node, iff this node is an Object node. Number of field names accessible will beTreeNode.size()
.- Specified by:
fieldNames
in interfaceTreeNode
- Overrides:
fieldNames
in classJsonNode
- Returns:
- An iterator for traversing names of all fields this Object node
has (if Object node); empty
Iterator
otherwise (nevernull
).
-
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.- Specified by:
path
in interfaceTreeNode
- Specified by:
path
in classJsonNode
- Parameters:
propertyName
- Name of the field (of Object node) to access- Returns:
- Node that represent value of the specified field, if this node is an object and has value for the specified field; otherwise "missing node" is returned.
-
required
Description copied from class:JsonNode
Method is functionally equivalent topath(fieldName).required()
and can be used to check that this node is anObjectNode
(that is, represents JSON Object value) and has value for specified property with keyfieldName
(but note that value may be explicit JSON null value). If this node is Object Node and has value for specified property, matching value is returned; otherwiseIllegalArgumentException
is thrown.- Overrides:
required
in classBaseJsonNode
- Parameters:
propertyName
- Name of property to access- Returns:
- Value of the specified property of this Object node
-
fields
Method to use for accessing all properties (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, add and return such Object node. If the node method is called on is not Object node, or if property exists and has value that is not Object node,UnsupportedOperationException
is thrownNOTE: since 2.10 has had co-variant return type
-
withArray
Description copied from class:JsonNode
Method that can be called on Object nodes, to access a property that hasArray
value; or if no such property exists, to create, add and return such Array node. If the node method is called on is not Object node, or if property exists and has value that is not Array node,UnsupportedOperationException
is thrownNOTE: since 2.10 has had co-variant return type
-
equals
Description copied from class:JsonNode
Entry method for invoking customizable comparison, using passed-inComparator
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 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
, withthis
as the first argument, andother
as the second argument. -
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. -
findValues
- Specified by:
findValues
in classJsonNode
-
findValuesAsText
- Specified by:
findValuesAsText
in classJsonNode
-
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 classJsonNode
- Parameters:
propertyName
- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findParents
- Specified by:
findParents
in classJsonNode
-
serialize
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
-
serializeWithType
public void serializeWithType(JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException 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 interfaceJsonSerializable
- Specified by:
serializeWithType
in classBaseJsonNode
- Throws:
IOException
-
set
Method that will set specified property, replacing old value, if any. Note that this is identical toreplace(String, JsonNode)
, except for return value.NOTE: added to replace those uses of
put(String, JsonNode)
where chaining with 'this' is desired.NOTE: co-variant return type since 2.10
- Parameters:
propertyName
- Name of property to setvalue
- Value to set property to; if null, will be converted to aNullNode
first (to remove a property, callremove(java.lang.String)
instead)- Returns:
- This node after adding/replacing property value (to allow chaining)
- Since:
- 2.1
-
setAll
Method for adding given properties to this object node, overriding any existing values for those properties.NOTE: co-variant return type since 2.10
- Parameters:
properties
- Properties to add- Returns:
- This node after adding/replacing property values (to allow chaining)
- Since:
- 2.1
-
setAll
Method for adding all properties of the given Object, overriding any existing values for those properties.NOTE: co-variant return type since 2.10
- Parameters:
other
- Object of which properties to add to this object- Returns:
- This node after addition (to allow chaining)
- Since:
- 2.1
-
replace
Method for replacing value of specific property with passed value, and returning value (or null if none).- Parameters:
propertyName
- Property of which value to replacevalue
- 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
Method for removing property from this ObjectNode, and returning instance after removal.NOTE: co-variant return type since 2.10
- Returns:
- This node after removing property (if any)
- Since:
- 2.1
-
without
Method for removing specified field properties out of this ObjectNode.NOTE: co-variant return type since 2.10
- Parameters:
propertyNames
- Names of properties to remove- Returns:
- This node after removing entries
- Since:
- 2.1
-
put
Deprecated.Since 2.4 use eitherset(String,JsonNode)
orreplace(String,JsonNode)
,Method that will set specified property, replacing old value, if any.- Parameters:
propertyName
- Name of property to setvalue
- Value to set to property; if null, will be converted to aNullNode
first (to remove a property, callremove(java.lang.String)
instead).- Returns:
- Old value of the property, if any;
null
if there was no old value.
-
putIfAbsent
Method that will set value of specified property if (and only if) it had no set value previously. Note that explicitly setnull
is a value. Functionally equivalent to:if (get(propertyName) == null) { set(propertyName, value); return null; } else { return get(propertyName); }
- Parameters:
propertyName
- Name of property to setvalue
- Value to set to property (if and only if it had no value previously); if null, will be converted to aNullNode
first.- Returns:
- Old value of the property, if any (in which case value was not changed); null if there was no old value (in which case value is now set)
- Since:
- 2.13
-
remove
Method for removing a property from thisObjectNode
. Will return previous value of the property, if such property existed; null if not.- Returns:
- Value of specified property, if it existed; null if not
-
remove
Method for removing specified field properties out of this ObjectNode.- Parameters:
propertyNames
- Names of fields to remove- Returns:
- This node after removing entries
-
removeAll
Method for removing all properties, such that this ObjectNode will contain no properties after call.- Specified by:
removeAll
in classContainerNode<ObjectNode>
- Returns:
- This node after removing all entries
-
putAll
Deprecated.Since 2.4 usesetAll(Map)
,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)
-
putAll
Deprecated.Since 2.4 usesetAll(ObjectNode)
,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)
-
retain
Method for removing all properties out of this ObjectNode except for ones specified in argument.- Parameters:
propertyNames
- Fields to retain in this ObjectNode- Returns:
- This node (to allow call chaining)
-
retain
Method for removing all properties out of this ObjectNode except for ones specified in argument.- Parameters:
propertyNames
- Fields to retain in this ObjectNode- Returns:
- This node (to allow call chaining)
-
putArray
Method that will construct an ArrayNode and add it as a property of thisObjectNode
, replacing old value, if any.NOTE: Unlike all put(...) methods, return value is NOT this
ObjectNode
, but the newly createdArrayNode
instance.- 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 property of thisObjectNode
, replacing old value, if any.NOTE: Unlike all put(...) methods, return value is NOT this
ObjectNode
, but the newly createdObjectNode
instance.- Returns:
- Newly constructed ObjectNode (NOT the old value, which could be of any type)
-
putPOJO
Method for adding an opaque Java value as the value of specified property. Value can be serialized like any other property, as long as Jackson can serialize it. Despite term "POJO" this allows use of about any Java type, includingMap
s,Collection
s, as well as Beans (POJOs), primitives/wrappers and evenJsonNode
s. Method is most commonly useful when composing content to serialize from heterogenous sources.NOTE: if using
JsonNode.toString()
(orJsonNode.toPrettyString()
support for serialization may be more limited, compared to serializing node with specifically configuredObjectMapper
.- Parameters:
propertyName
- Name of property to set.pojo
- Java value to set as the property value- Returns:
- This
ObjectNode
(to allow chaining)
-
putRawValue
- Since:
- 2.6
-
putNull
Method for setting value of a property to explicitnull
value.- Parameters:
propertyName
- Name of property to set.- Returns:
- This
ObjectNode
(to allow chaining)
-
put
Method for setting value of a property to specified numeric value.- Returns:
- This node (to allow chaining)
-
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value. The underlyingJsonNode
that will be added is constructed usingJsonNodeFactory.numberNode(int)
, and may be "smaller" (likeShortNode
) in cases where value fits within range of a smaller integral numeric value.- Returns:
- This node (to allow chaining)
-
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value. The underlyingJsonNode
that will be added is constructed usingJsonNodeFactory.numberNode(long)
, and may be "smaller" (likeIntNode
) in cases where value fits within range of a smaller integral numeric value.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value. The underlyingJsonNode
that will be added is constructed usingJsonNodeFactory.numberNode(Long)
, and may be "smaller" (likeIntNode
) in cases where value fits within range of a smaller integral numeric value.Note that this is alternative to
put(String, long)
needed to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value.- Returns:
- This node (to allow chaining)
-
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value.- Returns:
- This node (to allow chaining)
-
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified numeric value.- Returns:
- This node (to allow chaining)
- Since:
- 2.9
-
put
Method for setting value of a field to specified String value.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified String value.- Returns:
- This node (to allow chaining)
-
put
Alternative method that we need to avoid bumping into NPE issues with auto-unboxing.- Returns:
- This node (to allow chaining)
-
put
Method for setting value of a field to specified binary value- Returns:
- This node (to allow chaining)
-
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
. -
_childrenEqual
- Since:
- 2.3
-
hashCode
public int hashCode()- Specified by:
hashCode
in classBaseJsonNode
-
_put
-
set(String,JsonNode)
orreplace(String,JsonNode)
,