public class ObjectNode extends ContainerNode<ObjectNode> implements java.io.Serializable
Note: class was final
temporarily for Jackson 2.2.
JsonSerializable.Base
Constructor and Description |
---|
ObjectNode(JsonNodeFactory nc) |
ObjectNode(JsonNodeFactory nc,
java.util.Map<java.lang.String,JsonNode> kids) |
Modifier and Type | Method and Description |
---|---|
JsonToken |
asToken()
Method that can be used for efficient type detection
when using stream abstraction for traversing nodes.
|
ObjectNode |
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.
|
java.util.Iterator<JsonNode> |
elements()
Method for accessing all value nodes of this Node, iff
this node is a JSON Array or Object node.
|
boolean |
equals(java.util.Comparator<JsonNode> comparator,
JsonNode o)
Entry method for invoking customizable comparison, using passed-in
Comparator object. |
boolean |
equals(java.lang.Object o)
Equality for node objects is defined as full (deep) value
equality.
|
java.util.Iterator<java.lang.String> |
fieldNames()
Method for accessing names of all fields for this node, iff
this node is an Object node.
|
java.util.Iterator<java.util.Map.Entry<java.lang.String,JsonNode>> |
fields()
Method to use for accessing all fields (with both names
and values) of this JSON Object.
|
ObjectNode |
findParent(java.lang.String fieldName)
Method for finding a JSON Object that contains specified field,
within this node or its descendants.
|
java.util.List<JsonNode> |
findParents(java.lang.String fieldName,
java.util.List<JsonNode> foundSoFar) |
JsonNode |
findValue(java.lang.String fieldName)
Method for finding a JSON Object field with specified name in this
node or its child nodes, and returning value it has.
|
java.util.List<JsonNode> |
findValues(java.lang.String fieldName,
java.util.List<JsonNode> foundSoFar) |
java.util.List<java.lang.String> |
findValuesAsText(java.lang.String fieldName,
java.util.List<java.lang.String> foundSoFar) |
JsonNode |
get(int index)
Method for accessing value of the specified element of
an array node.
|
JsonNode |
get(java.lang.String fieldName)
Method for accessing value of the specified field of
an object node.
|
JsonNodeType |
getNodeType()
Return the type of this node
|
int |
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.
|
boolean |
isObject()
Method that returns true if this node is an Object node, false
otherwise.
|
JsonNode |
path(int index)
This method is similar to
JsonNode.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 for
JsonNode.isMissingNode() ) will be returned. |
JsonNode |
path(java.lang.String fieldName)
This method is similar to
JsonNode.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 for
JsonNode.isMissingNode() ) will be returned. |
ObjectNode |
put(java.lang.String fieldName,
java.math.BigDecimal v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.math.BigInteger v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
boolean v)
Method for setting value of a field to specified String value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Boolean v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ObjectNode |
put(java.lang.String fieldName,
byte[] v)
Method for setting value of a field to specified binary value
|
ObjectNode |
put(java.lang.String fieldName,
double v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Double v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ObjectNode |
put(java.lang.String fieldName,
float v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Float v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ObjectNode |
put(java.lang.String fieldName,
int v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Integer v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
JsonNode |
put(java.lang.String fieldName,
JsonNode value)
Deprecated.
Since 2.4 use either
set(String,JsonNode) or replace(String,JsonNode) , |
ObjectNode |
put(java.lang.String fieldName,
long v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Long v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
short v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.Short v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ObjectNode |
put(java.lang.String fieldName,
java.lang.String v)
Method for setting value of a field to specified String value.
|
JsonNode |
putAll(java.util.Map<java.lang.String,? extends JsonNode> properties)
Deprecated.
Since 2.4 use
setAll(Map) , |
JsonNode |
putAll(ObjectNode other)
Deprecated.
Since 2.4 use
setAll(ObjectNode) , |
ArrayNode |
putArray(java.lang.String fieldName)
Method that will construct an ArrayNode and add it as a
field of this ObjectNode, replacing old value, if any.
|
ObjectNode |
putNull(java.lang.String fieldName) |
ObjectNode |
putObject(java.lang.String fieldName)
Method that will construct an ObjectNode and add it as a
field of this ObjectNode, replacing old value, if any.
|
ObjectNode |
putPOJO(java.lang.String fieldName,
java.lang.Object pojo) |
ObjectNode |
putRawValue(java.lang.String fieldName,
RawValue raw) |
ObjectNode |
remove(java.util.Collection<java.lang.String> fieldNames)
Method for removing specified field properties out of
this ObjectNode.
|
JsonNode |
remove(java.lang.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(java.lang.String fieldName,
JsonNode value)
Method for replacing value of specific property with passed
value, and returning value (or null if none).
|
JsonNode |
required(java.lang.String fieldName)
Method is functionally equivalent to
path(fieldName).required()
and can be used to check that this node is an ObjectNode (that is, represents
JSON Object value) and has value for specified property with key fieldName
(but note that value may be explicit JSON null value). |
ObjectNode |
retain(java.util.Collection<java.lang.String> fieldNames)
Method for removing all field properties out of this ObjectNode
except for ones specified in argument.
|
ObjectNode |
retain(java.lang.String... fieldNames)
Method for removing all field 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> |
set(java.lang.String fieldName,
JsonNode value)
Method that will set specified field, replacing old value, if any.
|
<T extends JsonNode> |
setAll(java.util.Map<java.lang.String,? extends JsonNode> properties)
Method for adding given properties to this object node, overriding
any existing values for those properties.
|
<T extends JsonNode> |
setAll(ObjectNode other)
Method for adding all properties of the given Object, 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.
|
ObjectNode |
with(java.lang.String propertyName)
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.
|
ArrayNode |
withArray(java.lang.String propertyName)
Method that can be called on Object nodes, to access a property
that has
Array value; or if no such property exists, to create,
add and return such Array node. |
<T extends JsonNode> |
without(java.util.Collection<java.lang.String> fieldNames)
Method for removing specified field properties out of
this ObjectNode.
|
<T extends JsonNode> |
without(java.lang.String fieldName)
Method for removing field entry from this ObjectNode, and
returning instance after removal.
|
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
findPath, numberType, required, toPrettyString, toString, traverse, traverse
asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, 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
public ObjectNode(JsonNodeFactory nc)
public ObjectNode(JsonNodeFactory nc, java.util.Map<java.lang.String,JsonNode> kids)
public ObjectNode deepCopy()
JsonNode
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.
public boolean isEmpty(SerializerProvider serializers)
JsonSerializable.Base
isEmpty
in class JsonSerializable.Base
public JsonNodeType getNodeType()
JsonNode
getNodeType
in class JsonNode
JsonNodeType
enum valuepublic final boolean isObject()
TreeNode
TreeNode.isContainerNode()
must also return true.public JsonToken asToken()
BaseJsonNode
JsonToken
that equivalent
stream event would produce (for most nodes there is just
one token but for structured/container types multiple)asToken
in interface TreeNode
asToken
in class ContainerNode<ObjectNode>
public int size()
TreeNode
size
in interface TreeNode
size
in class ContainerNode<ObjectNode>
public boolean isEmpty()
JsonNode
size() == 0for all node types.
public java.util.Iterator<JsonNode> elements()
JsonNode
public JsonNode get(int index)
JsonNode
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!),
a NullNode
will be returned,
not null.
get
in interface TreeNode
get
in class ContainerNode<ObjectNode>
public JsonNode get(java.lang.String fieldName)
JsonNode
NOTE: if the property value has been explicitly set as null
(which is different from removal!),
a NullNode
will be returned,
not null.
get
in interface TreeNode
get
in class ContainerNode<ObjectNode>
public java.util.Iterator<java.lang.String> fieldNames()
TreeNode
TreeNode.size()
.fieldNames
in interface TreeNode
fieldNames
in class JsonNode
public JsonNode path(int index)
JsonNode
JsonNode.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 for
JsonNode.isMissingNode()
) will be returned. This allows for
convenient and safe chained access via path calls.public JsonNode path(java.lang.String fieldName)
JsonNode
JsonNode.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 for
JsonNode.isMissingNode()
) will be returned. This allows for
convenient and safe chained access via path calls.public JsonNode required(java.lang.String fieldName)
JsonNode
path(fieldName).required()
and can be used to check that this node is an ObjectNode
(that is, represents
JSON Object value) and has value for specified property with key fieldName
(but note that value may be explicit JSON null value).
If this node is Object Node and has value for specified property, this
is returned
to allow chaining; otherwise IllegalArgumentException
is thrown.required
in class BaseJsonNode
this
node to allow chainingpublic java.util.Iterator<java.util.Map.Entry<java.lang.String,JsonNode>> fields()
public ObjectNode with(java.lang.String propertyName)
JsonNode
UnsupportedOperationException
is thrown
NOTE: since 2.10 has had co-variant return type
public ArrayNode withArray(java.lang.String propertyName)
JsonNode
Array
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 thrown
NOTE: since 2.10 has had co-variant return type
public boolean equals(java.util.Comparator<JsonNode> comparator, JsonNode o)
JsonNode
Comparator
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 calls equals()
on one of arguments, passing the other
-- implementation is the same as directly calling equals()
on node.
Default implementation simply delegates to passed in comparator
,
with this
as the first argument, and other
as
the second argument.
public JsonNode findValue(java.lang.String fieldName)
JsonNode
public java.util.List<JsonNode> findValues(java.lang.String fieldName, java.util.List<JsonNode> foundSoFar)
findValues
in class JsonNode
public java.util.List<java.lang.String> findValuesAsText(java.lang.String fieldName, java.util.List<java.lang.String> foundSoFar)
findValuesAsText
in class JsonNode
public ObjectNode findParent(java.lang.String fieldName)
JsonNode
findParent
in class JsonNode
fieldName
- Name of field to look forpublic java.util.List<JsonNode> findParents(java.lang.String fieldName, java.util.List<JsonNode> foundSoFar)
findParents
in class JsonNode
public void serialize(JsonGenerator g, SerializerProvider provider) throws java.io.IOException
serialize
in interface JsonSerializable
serialize
in class BaseJsonNode
java.io.IOException
public void serializeWithType(JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws java.io.IOException
BaseJsonNode
serializeWithType
in interface JsonSerializable
serializeWithType
in class BaseJsonNode
java.io.IOException
public <T extends JsonNode> T set(java.lang.String fieldName, JsonNode value)
replace(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
value
- to set field to; if null, will be converted
to a NullNode
first (to remove field entry, call
remove(java.lang.String)
instead)public <T extends JsonNode> T setAll(java.util.Map<java.lang.String,? extends JsonNode> properties)
NOTE: co-variant return type since 2.10
properties
- Properties to addpublic <T extends JsonNode> T setAll(ObjectNode other)
NOTE: co-variant return type since 2.10
other
- Object of which properties to add to this objectpublic JsonNode replace(java.lang.String fieldName, JsonNode value)
fieldName
- Property of which value to replacevalue
- Value to set property to, replacing old value if anypublic <T extends JsonNode> T without(java.lang.String fieldName)
NOTE: co-variant return type since 2.10
public <T extends JsonNode> T without(java.util.Collection<java.lang.String> fieldNames)
NOTE: co-variant return type since 2.10
fieldNames
- Names of fields to remove@Deprecated public JsonNode put(java.lang.String fieldName, JsonNode value)
set(String,JsonNode)
or replace(String,JsonNode)
,value
- to set field to; if null, will be converted
to a NullNode
first (to remove field entry, call
remove(java.lang.String)
instead)public JsonNode remove(java.lang.String fieldName)
public ObjectNode remove(java.util.Collection<java.lang.String> fieldNames)
fieldNames
- Names of fields to removepublic ObjectNode removeAll()
removeAll
in class ContainerNode<ObjectNode>
@Deprecated public JsonNode putAll(java.util.Map<java.lang.String,? extends JsonNode> properties)
setAll(Map)
,properties
- Properties to add@Deprecated public JsonNode putAll(ObjectNode other)
setAll(ObjectNode)
,other
- Object of which properties to add to this objectpublic ObjectNode retain(java.util.Collection<java.lang.String> fieldNames)
fieldNames
- Fields to retain in this ObjectNodepublic ObjectNode retain(java.lang.String... fieldNames)
fieldNames
- Fields to retain in this ObjectNodepublic ArrayNode putArray(java.lang.String fieldName)
NOTE: Unlike all put(...) methods, return value
is NOT this ObjectNode
, but the
newly created ArrayNode
instance.
public ObjectNode putObject(java.lang.String fieldName)
NOTE: Unlike all put(...) methods, return value
is NOT this ObjectNode
, but the
newly created ObjectNode
instance.
public ObjectNode putPOJO(java.lang.String fieldName, java.lang.Object pojo)
public ObjectNode putRawValue(java.lang.String fieldName, RawValue raw)
public ObjectNode putNull(java.lang.String fieldName)
public ObjectNode put(java.lang.String fieldName, short v)
public ObjectNode put(java.lang.String fieldName, java.lang.Short v)
public ObjectNode put(java.lang.String fieldName, int v)
JsonNode
that will be added is constructed
using JsonNodeFactory.numberNode(int)
, and may be
"smaller" (like ShortNode
) in cases where value fits within
range of a smaller integral numeric value.public ObjectNode put(java.lang.String fieldName, java.lang.Integer v)
public ObjectNode put(java.lang.String fieldName, long v)
JsonNode
that will be added is constructed
using JsonNodeFactory.numberNode(long)
, and may be
"smaller" (like IntNode
) in cases where value fits within
range of a smaller integral numeric value.public ObjectNode put(java.lang.String fieldName, java.lang.Long v)
JsonNode
that will be added is constructed
using JsonNodeFactory.numberNode(Long)
, and may be
"smaller" (like IntNode
) 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.
public ObjectNode put(java.lang.String fieldName, float v)
public ObjectNode put(java.lang.String fieldName, java.lang.Float v)
public ObjectNode put(java.lang.String fieldName, double v)
public ObjectNode put(java.lang.String fieldName, java.lang.Double v)
public ObjectNode put(java.lang.String fieldName, java.math.BigDecimal v)
public ObjectNode put(java.lang.String fieldName, java.math.BigInteger v)
public ObjectNode put(java.lang.String fieldName, java.lang.String v)
public ObjectNode put(java.lang.String fieldName, boolean v)
public ObjectNode put(java.lang.String fieldName, java.lang.Boolean v)
public ObjectNode put(java.lang.String fieldName, byte[] v)
public boolean equals(java.lang.Object o)
JsonNode
Note: marked as abstract to ensure all implementation
classes define it properly and not rely on definition
from Object
.
public int hashCode()
hashCode
in class BaseJsonNode
Copyright © 2010 - 2020 Adobe. All Rights Reserved