public class ObjectNode extends ContainerNode<ObjectNode>
Note: class was final
temporarily for Jackson 2.2.
Modifier and Type | Field and Description |
---|---|
protected Map<String,JsonNode> |
_children |
_nodeFactory
Constructor and Description |
---|
ObjectNode(JsonNodeFactory nc) |
ObjectNode(JsonNodeFactory nc,
Map<String,JsonNode> kids) |
Modifier and Type | Method and Description |
---|---|
protected JsonNode |
_at(JsonPointer ptr) |
protected boolean |
_childrenEqual(ObjectNode other) |
protected ObjectNode |
_put(String fieldName,
JsonNode value) |
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.
|
Iterator<JsonNode> |
elements()
Method for accessing all value nodes of this Node, iff
this node is a JSON Array or Object node.
|
boolean |
equals(Object o)
Equality for node objects is defined as full (deep) value
equality.
|
Iterator<String> |
fieldNames()
Method for accessing names of all fields for this node, iff
this node is an Object node.
|
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)
Method for finding a JSON Object that contains specified field,
within this node or its descendants.
|
List<JsonNode> |
findParents(String fieldName,
List<JsonNode> foundSoFar) |
JsonNode |
findValue(String fieldName)
Method for finding a JSON Object field with specified name in this
node or its child nodes, and returning value it has.
|
List<JsonNode> |
findValues(String fieldName,
List<JsonNode> foundSoFar) |
List<String> |
findValuesAsText(String fieldName,
List<String> foundSoFar) |
JsonNode |
get(int index)
Method for accessing value of the specified element of
an array node.
|
JsonNode |
get(String fieldName)
Method for accessing value of the specified field of
an object node.
|
JsonNodeType |
getNodeType()
Return the type of this node
|
int |
hashCode() |
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(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(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 v)
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 v)
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 v)
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 v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
JsonNode |
put(String fieldName,
JsonNode value)
Deprecated.
Since 2.4 use either
set(String,JsonNode) or replace(String,JsonNode) , |
ObjectNode |
put(String fieldName,
long v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(String fieldName,
Long v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(String fieldName,
short v)
Method for setting value of a field to specified numeric value.
|
ObjectNode |
put(String fieldName,
Short v)
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,? extends JsonNode> properties)
Deprecated.
Since 2.4 use
setAll(Map) , |
JsonNode |
putAll(ObjectNode other)
Deprecated.
Since 2.4 use
setAll(ObjectNode) , |
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 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.
|
JsonNode |
set(String fieldName,
JsonNode value)
Method that will set specified field, replacing old value, if any.
|
JsonNode |
setAll(Map<String,? extends 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()
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.
|
String |
toString()
Note: marked as abstract to ensure all implementation
classes define it properly.
|
ObjectNode |
with(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(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. |
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.
|
arrayNode, asText, binaryNode, binaryNode, booleanNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, POJONode, textNode
findPath, numberType, 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, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, shortValue, textValue
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
forEach, spliterator
public ObjectNode(JsonNodeFactory nc)
public ObjectNode(JsonNodeFactory nc, Map<String,JsonNode> kids)
protected JsonNode _at(JsonPointer ptr)
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 JsonNodeType getNodeType()
JsonNode
getNodeType
in class JsonNode
JsonNodeType
enum valuepublic 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 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(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 Iterator<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(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 Iterator<Map.Entry<String,JsonNode>> fields()
public ObjectNode with(String propertyName)
JsonNode
UnsupportedOperationException
is thrownpublic ArrayNode withArray(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 thrownpublic JsonNode findValue(String fieldName)
JsonNode
public List<JsonNode> findValues(String fieldName, List<JsonNode> foundSoFar)
findValues
in class JsonNode
public List<String> findValuesAsText(String fieldName, List<String> foundSoFar)
findValuesAsText
in class JsonNode
public ObjectNode findParent(String fieldName)
JsonNode
findParent
in class JsonNode
fieldName
- Name of field to look forpublic List<JsonNode> findParents(String fieldName, List<JsonNode> foundSoFar)
findParents
in class JsonNode
public void serialize(JsonGenerator jg, SerializerProvider provider) throws IOException, JsonProcessingException
serialize
in interface JsonSerializable
serialize
in class BaseJsonNode
IOException
JsonProcessingException
public void serializeWithType(JsonGenerator jg, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonProcessingException
BaseJsonNode
serializeWithType
in interface JsonSerializable
serializeWithType
in class BaseJsonNode
IOException
JsonProcessingException
public JsonNode set(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.
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 setAll(Map<String,? extends JsonNode> properties)
properties
- Properties to addpublic JsonNode setAll(ObjectNode other)
other
- Object of which properties to add to this objectpublic JsonNode replace(String fieldName, JsonNode value)
fieldName
- Property of which value to replacevalue
- Value to set property to, replacing old value if anypublic JsonNode without(String fieldName)
public ObjectNode without(Collection<String> fieldNames)
fieldNames
- Names of fields to remove@Deprecated public JsonNode put(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(String fieldName)
public ObjectNode remove(Collection<String> fieldNames)
fieldNames
- Names of fields to removepublic ObjectNode removeAll()
removeAll
in class ContainerNode<ObjectNode>
@Deprecated public JsonNode putAll(Map<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(Collection<String> fieldNames)
fieldNames
- Fields to retain in this ObjectNodepublic ObjectNode retain(String... fieldNames)
fieldNames
- Fields to retain in this ObjectNodepublic ArrayNode putArray(String fieldName)
NOTE: Unlike all put(...) methods, return value
is NOT this ObjectNode
, but the
newly created ArrayNode
instance.
public ObjectNode putObject(String fieldName)
NOTE: Unlike all put(...) methods, return value
is NOT this ObjectNode
, but the
newly created ObjectNode
instance.
public ObjectNode putPOJO(String fieldName, Object pojo)
public ObjectNode putNull(String fieldName)
public ObjectNode put(String fieldName, short v)
public ObjectNode put(String fieldName, Short v)
public ObjectNode put(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(String fieldName, Integer v)
public ObjectNode put(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(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.
Note that this is alternative to put(String, long)
needed to avoid
bumping into NPE issues with auto-unboxing.
public ObjectNode put(String fieldName, float v)
public ObjectNode put(String fieldName, Float v)
public ObjectNode put(String fieldName, double v)
public ObjectNode put(String fieldName, Double v)
public ObjectNode put(String fieldName, BigDecimal v)
public ObjectNode put(String fieldName, String v)
public ObjectNode put(String fieldName, boolean v)
public ObjectNode put(String fieldName, Boolean v)
public ObjectNode put(String fieldName, byte[] v)
public boolean equals(Object o)
JsonNode
Note: marked as abstract to ensure all implementation
classes define it properly and not rely on definition
from Object
.
protected boolean _childrenEqual(ObjectNode other)
public String toString()
JsonNode
Note: marked as abstract to ensure all implementation classes define it properly.
protected ObjectNode _put(String fieldName, JsonNode value)
Copyright © 2016 JBoss by Red Hat. All rights reserved.