public class ArrayNode extends ContainerNode<ArrayNode>
Note: class was final
temporarily for Jackson 2.2.
JsonSerializable.Base
Constructor and Description |
---|
ArrayNode(JsonNodeFactory nf) |
ArrayNode(JsonNodeFactory nf,
int capacity) |
ArrayNode(JsonNodeFactory nf,
java.util.List<JsonNode> children) |
Modifier and Type | Method and Description |
---|---|
ArrayNode |
add(java.math.BigDecimal v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(java.math.BigInteger v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(boolean v)
Method for adding specified boolean value at the end of this array.
|
ArrayNode |
add(java.lang.Boolean value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(byte[] v)
Method for adding specified binary value at the end of this array
(note: when serializing as JSON, will be output Base64 encoded)
|
ArrayNode |
add(double v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(java.lang.Double value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(float v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(java.lang.Float value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(int v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(java.lang.Integer value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(JsonNode value)
Method for adding specified node at the end of this array.
|
ArrayNode |
add(long v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(java.lang.Long value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(java.lang.String v)
Method for adding specified String value at the end of this array.
|
ArrayNode |
addAll(ArrayNode other)
Method for adding all child nodes of given Array, appending to
child nodes this array contains
|
ArrayNode |
addAll(java.util.Collection<? extends JsonNode> nodes)
Method for adding given nodes as child nodes of this array node.
|
ArrayNode |
addArray()
Method that will construct an ArrayNode and add it at the end
of this array node.
|
ArrayNode |
addNull()
Method that will add a null value at the end of this array node.
|
ObjectNode |
addObject()
Method that will construct an ObjectNode and add it at the end
of this array node.
|
ArrayNode |
addPOJO(java.lang.Object value)
Method that will construct a POJONode and add it at the end
of this array node.
|
ArrayNode |
addRawValue(RawValue raw) |
JsonToken |
asToken()
Method that can be used for efficient type detection
when using stream abstraction for traversing nodes.
|
ArrayNode |
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.
|
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() |
ArrayNode |
insert(int index,
java.math.BigDecimal v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
java.math.BigInteger v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
boolean v)
Method that will insert specified String
at specified position in this array.
|
ArrayNode |
insert(int index,
java.lang.Boolean value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
byte[] v)
Method that will insert specified binary value
at specified position in this array
(note: when written as JSON, will be Base64 encoded)
|
ArrayNode |
insert(int index,
double v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
java.lang.Double value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
float v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
java.lang.Float value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
int v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
java.lang.Integer value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
JsonNode value)
Method for inserting specified child node as an element
of this Array.
|
ArrayNode |
insert(int index,
long v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
java.lang.Long value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
java.lang.String v)
Method that will insert specified String
at specified position in this array.
|
ArrayNode |
insertArray(int index)
Method for creating an array node, inserting it at the
specified point in the array,
and returning the newly created array
(note: NOT 'this' array)
|
ArrayNode |
insertNull(int index)
Method that will insert a null value
at specified position in this array.
|
ObjectNode |
insertObject(int index)
Method for creating an
ObjectNode , appending it at the end
of this array, and returning the newly created node
(note: NOT 'this' array) |
ArrayNode |
insertPOJO(int index,
java.lang.Object value)
Method that will construct a POJONode and
insert it at specified position in this array.
|
boolean |
isArray()
Method that returns true if this node is an Array node, false
otherwise.
|
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.
|
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. |
JsonNode |
remove(int index)
Method for removing an entry from this ArrayNode.
|
ArrayNode |
removeAll()
Method for removing all elements of this array, leaving the
array empty.
|
void |
serialize(JsonGenerator f,
SerializerProvider provider)
Method called to serialize node instances using given 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.
|
JsonNode |
set(int index,
JsonNode value)
Method that will set specified field, replacing old value,
if any.
|
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.
|
java.lang.String |
toString()
Method that will produce developer-readable representation of the
node; which may or may not be as valid JSON.
|
arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, textNode
findPath, numberType, traverse, traverse
asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToInt, canConvertToLong, decimalValue, doubleValue, fieldNames, fields, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, shortValue, textValue, with, withArray
public ArrayNode(JsonNodeFactory nf)
public ArrayNode(JsonNodeFactory nf, int capacity)
public ArrayNode(JsonNodeFactory nf, java.util.List<JsonNode> children)
public ArrayNode 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 boolean isArray()
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<ArrayNode>
public int size()
TreeNode
size
in interface TreeNode
size
in class ContainerNode<ArrayNode>
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<ArrayNode>
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<ArrayNode>
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 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 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 void serialize(JsonGenerator f, SerializerProvider provider) throws java.io.IOException
BaseJsonNode
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 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 JsonNode set(int index, JsonNode value)
value
- to set field to; if null, will be converted
to a NullNode
first (to remove field entry, call
remove(int)
instead)public ArrayNode add(JsonNode value)
public ArrayNode addAll(ArrayNode other)
other
- Array to add contents frompublic ArrayNode addAll(java.util.Collection<? extends JsonNode> nodes)
nodes
- Nodes to addpublic ArrayNode insert(int index, JsonNode value)
public JsonNode remove(int index)
public ArrayNode removeAll()
removeAll
in class ContainerNode<ArrayNode>
public ArrayNode addArray()
public ObjectNode addObject()
public ArrayNode addPOJO(java.lang.Object value)
public ArrayNode addRawValue(RawValue raw)
public ArrayNode addNull()
public ArrayNode add(int v)
public ArrayNode add(java.lang.Integer value)
public ArrayNode add(long v)
public ArrayNode add(java.lang.Long value)
public ArrayNode add(float v)
public ArrayNode add(java.lang.Float value)
public ArrayNode add(double v)
public ArrayNode add(java.lang.Double value)
public ArrayNode add(java.math.BigDecimal v)
public ArrayNode add(java.math.BigInteger v)
public ArrayNode add(java.lang.String v)
public ArrayNode add(boolean v)
public ArrayNode add(java.lang.Boolean value)
public ArrayNode add(byte[] v)
public ArrayNode insertArray(int index)
public ObjectNode insertObject(int index)
ObjectNode
, appending it at the end
of this array, and returning the newly created node
(note: NOT 'this' array)public ArrayNode insertPOJO(int index, java.lang.Object value)
public ArrayNode insertNull(int index)
public ArrayNode insert(int index, int v)
public ArrayNode insert(int index, java.lang.Integer value)
public ArrayNode insert(int index, long v)
public ArrayNode insert(int index, java.lang.Long value)
public ArrayNode insert(int index, float v)
public ArrayNode insert(int index, java.lang.Float value)
public ArrayNode insert(int index, double v)
public ArrayNode insert(int index, java.lang.Double value)
public ArrayNode insert(int index, java.math.BigDecimal v)
public ArrayNode insert(int index, java.math.BigInteger v)
public ArrayNode insert(int index, java.lang.String v)
public ArrayNode insert(int index, boolean v)
public ArrayNode insert(int index, java.lang.Boolean value)
public ArrayNode insert(int index, 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
public java.lang.String toString()
JsonNode
ObjectMapper
or ObjectWriter
to serialize an
instance, for example:
String json = objectMapper.writeValueAsString(rootNode);
Note: method defined as abstract to ensure all implementation
classes explicitly implement method, instead of relying
on Object.toString()
definition.
"Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"