public class ArrayNode extends ContainerNode<ArrayNode> implements Serializable
Note: class was final temporarily for Jackson 2.2.
JsonNode.OverwriteModeJsonSerializable.Base_nodeFactory| Constructor and Description |
|---|
ArrayNode(JsonNodeFactory nf) |
ArrayNode(JsonNodeFactory nf,
int capacity) |
ArrayNode(JsonNodeFactory nf,
List<JsonNode> children) |
| Modifier and Type | Method and Description |
|---|---|
protected ArrayNode |
_add(JsonNode node) |
protected JsonNode |
_at(com.fasterxml.jackson.core.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(ArrayNode other) |
protected ArrayNode |
_insert(int index,
JsonNode node) |
protected ArrayNode |
_set(int index,
JsonNode node) |
protected ArrayNode |
_withArray(com.fasterxml.jackson.core.JsonPointer origPtr,
com.fasterxml.jackson.core.JsonPointer currentPtr,
JsonNode.OverwriteMode overwriteMode,
boolean preferIndex) |
protected ArrayNode |
_withArrayAddTailElement(com.fasterxml.jackson.core.JsonPointer tail,
boolean preferIndex) |
protected ObjectNode |
_withObject(com.fasterxml.jackson.core.JsonPointer origPtr,
com.fasterxml.jackson.core.JsonPointer currentPtr,
JsonNode.OverwriteMode overwriteMode,
boolean preferIndex) |
protected ObjectNode |
_withObjectAddTailElement(com.fasterxml.jackson.core.JsonPointer tail,
boolean preferIndex) |
protected void |
_withXxxSetArrayElement(int index,
JsonNode value) |
ArrayNode |
add(BigDecimal v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(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(Boolean v)
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(Double v)
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(Float v)
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(Integer v)
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(Long v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(short v)
Method for adding specified number at the end of this array.
|
ArrayNode |
add(Short v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
add(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(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(Object pojo)
Method that will construct a POJONode and add it at the end
of this array node.
|
ArrayNode |
addRawValue(RawValue raw) |
com.fasterxml.jackson.core.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.
|
Iterator<JsonNode> |
elements()
Method for accessing all value nodes of this Node, iff
this node is a JSON Array or Object node.
|
boolean |
equals(Comparator<JsonNode> comparator,
JsonNode o)
Entry method for invoking customizable comparison, using passed-in
Comparator object. |
boolean |
equals(Object o)
Equality for node objects is defined as full (deep) value
equality.
|
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() |
ArrayNode |
insert(int index,
BigDecimal v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
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,
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,
Double v)
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,
Float v)
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,
Integer v)
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,
Long v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
short v)
Method that will insert specified numeric value
at specified position in this array.
|
ArrayNode |
insert(int index,
Short value)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
insert(int index,
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,
Object pojo)
Method that will construct a POJONode and
insert it at specified position in this array.
|
ArrayNode |
insertRawValue(int index,
RawValue raw) |
boolean |
isArray() |
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.
|
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. |
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.
|
JsonNode |
required(int index)
Method is functionally equivalent to
path(index).required()
and can be used to check that this node is an ArrayNode (that is, represents
JSON Array value) and has value for specified index
(but note that value may be explicit JSON null value). |
void |
serialize(com.fasterxml.jackson.core.JsonGenerator g,
SerializerProvider provider)
Method called to serialize node instances using given generator.
|
void |
serializeWithType(com.fasterxml.jackson.core.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.
|
ArrayNode |
set(int index,
BigDecimal v)
Method for setting value of a field to specified numeric value.
|
ArrayNode |
set(int index,
BigInteger v)
Method for setting value of a field to specified numeric value.
|
ArrayNode |
set(int index,
boolean v)
Method for setting value of a field to specified String value.
|
ArrayNode |
set(int index,
Boolean v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
set(int index,
byte[] v)
Method for setting value of a field to specified binary value
|
ArrayNode |
set(int index,
double v)
Method for setting value of a field to specified numeric value.
|
ArrayNode |
set(int index,
Double v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
set(int index,
float v)
Method for setting value of a field to specified numeric value.
|
ArrayNode |
set(int index,
Float v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
set(int index,
int v) |
ArrayNode |
set(int index,
Integer v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
JsonNode |
set(int index,
JsonNode value)
Method that will set specified field, replacing old value,
if any.
|
ArrayNode |
set(int index,
long v) |
ArrayNode |
set(int index,
Long v) |
ArrayNode |
set(int index,
short v) |
ArrayNode |
set(int index,
Short v)
Alternative method that we need to avoid bumping into NPE issues
with auto-unboxing.
|
ArrayNode |
set(int index,
String v)
Method for setting value of a field to specified String value.
|
ArrayNode |
setNull(int index) |
ArrayNode |
setPOJO(int index,
Object pojo) |
ArrayNode |
setRawValue(int index,
RawValue raw) |
int |
size() |
ObjectNode |
with(String exprOrProperty)
Deprecated.
|
ArrayNode |
withArray(String exprOrProperty)
Method that works in one of possible ways, depending on whether
exprOrProperty is a valid JsonPointer expression or
not (valid expression is either empty String "" or starts
with leading slash / character). |
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_jsonPointerIfValid, _reportWrongNodeOperation, _reportWrongNodeType, _withXxxMayReplace, _withXxxVerifyReplace, findPath, numberType, required, toPrettyString, toString, traverse, traverse, withArray, withObject_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, 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, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, withObject, withObject, withObjectclone, finalize, getClass, notify, notifyAll, wait, wait, waitforEach, spliteratorpublic ArrayNode(JsonNodeFactory nf)
public ArrayNode(JsonNodeFactory nf, int capacity)
public ArrayNode(JsonNodeFactory nf, List<JsonNode> children)
protected JsonNode _at(com.fasterxml.jackson.core.JsonPointer ptr)
JsonNodenull is returned.public ArrayNode deepCopy()
JsonNodeNote: 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.
@Deprecated public ObjectNode with(String exprOrProperty)
JsonNodeexprOrProperty is a valid JsonPointer expression or
not (valid expression is either empty String "" or starts
with leading slash / character).
If it is, works as a short-cut to:
withObject(JsonPointer.compile(exprOrProperty));If it is NOT a valid
JsonPointer expression, value is taken
as a literal Object property name and traversed like a single-segment
JsonPointer.
NOTE: before Jackson 2.14 behavior was always that of non-expression usage;
that is, exprOrProperty was always considered as a simple property name.
public ArrayNode withArray(String exprOrProperty)
JsonNodeexprOrProperty is a valid JsonPointer expression or
not (valid expression is either empty String "" or starts
with leading slash / character).
If it is, works as a short-cut to:
withObject(JsonPointer.compile(exprOrProperty));If it is NOT a valid
JsonPointer expression, value is taken
as a literal Object property name and traversed like a single-segment
JsonPointer.
NOTE: before Jackson 2.14 behavior was always that of non-expression usage;
that is, exprOrProperty was always considered as a simple property name.
protected ObjectNode _withObject(com.fasterxml.jackson.core.JsonPointer origPtr, com.fasterxml.jackson.core.JsonPointer currentPtr, JsonNode.OverwriteMode overwriteMode, boolean preferIndex)
_withObject in class ContainerNode<ArrayNode>protected ArrayNode _withArray(com.fasterxml.jackson.core.JsonPointer origPtr, com.fasterxml.jackson.core.JsonPointer currentPtr, JsonNode.OverwriteMode overwriteMode, boolean preferIndex)
_withArray in class BaseJsonNodeprotected ObjectNode _withObjectAddTailElement(com.fasterxml.jackson.core.JsonPointer tail, boolean preferIndex)
protected ArrayNode _withArrayAddTailElement(com.fasterxml.jackson.core.JsonPointer tail, boolean preferIndex)
protected void _withXxxSetArrayElement(int index,
JsonNode value)
public boolean isEmpty(SerializerProvider serializers)
JsonSerializable.BaseisEmpty in class JsonSerializable.Basepublic JsonNodeType getNodeType()
JsonNodegetNodeType in class JsonNodeJsonNodeType enum valuepublic boolean isArray()
public com.fasterxml.jackson.core.JsonToken asToken()
BaseJsonNodeJsonToken that equivalent
stream event would produce (for most nodes there is just
one token but for structured/container types multiple)asToken in interface com.fasterxml.jackson.core.TreeNodeasToken in class ContainerNode<ArrayNode>public int size()
size in interface com.fasterxml.jackson.core.TreeNodesize in class ContainerNode<ArrayNode>public boolean isEmpty()
JsonNode
size() == 0
for all node types.public Iterator<JsonNode> elements()
JsonNodepublic 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 com.fasterxml.jackson.core.TreeNodeget in class ContainerNode<ArrayNode>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 com.fasterxml.jackson.core.TreeNodeget in class ContainerNode<ArrayNode>public JsonNode path(String fieldName)
JsonNodeJsonNode.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)
JsonNodeJsonNode.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 required(int index)
JsonNodepath(index).required()
and can be used to check that this node is an ArrayNode (that is, represents
JSON Array value) and has value for specified index
(but note that value may be explicit JSON null value).
If this node is Array Node and has value for specified index, value at index
is returned; otherwise IllegalArgumentException is thrown.required in class BaseJsonNodeindex - Index of the value of this Array node to accesspublic boolean equals(Comparator<JsonNode> comparator, JsonNode o)
JsonNodeComparator 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(com.fasterxml.jackson.core.JsonGenerator g,
SerializerProvider provider)
throws IOException
BaseJsonNodeserialize in interface JsonSerializableserialize in class BaseJsonNodeIOExceptionpublic void serializeWithType(com.fasterxml.jackson.core.JsonGenerator g,
SerializerProvider provider,
TypeSerializer typeSer)
throws IOException
BaseJsonNodeserializeWithType in interface JsonSerializableserializeWithType in class BaseJsonNodeIOExceptionpublic JsonNode findValue(String fieldName)
JsonNodepublic List<JsonNode> findValues(String fieldName, List<JsonNode> foundSoFar)
findValues in class JsonNodepublic List<String> findValuesAsText(String fieldName, List<String> foundSoFar)
findValuesAsText in class JsonNodepublic ObjectNode findParent(String fieldName)
JsonNodefindParent in class JsonNodefieldName - Name of field to look forpublic List<JsonNode> findParents(String fieldName, List<JsonNode> foundSoFar)
findParents in class JsonNodepublic 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(Collection<? extends JsonNode> nodes)
nodes - Nodes to addpublic ArrayNode insert(int index, JsonNode value)
>= size(), appended at the end, and otherwise
inserted before existing element in specified index.
No exceptions are thrown for any index.public JsonNode remove(int index)
public ArrayNode removeAll()
removeAll in class ContainerNode<ArrayNode>public ArrayNode addArray()
public ObjectNode addObject()
public ArrayNode addPOJO(Object pojo)
public ArrayNode addRawValue(RawValue raw)
public ArrayNode addNull()
public ArrayNode add(short v)
public ArrayNode add(Short v)
public ArrayNode add(int v)
public ArrayNode add(Integer v)
public ArrayNode add(long v)
public ArrayNode add(Long v)
public ArrayNode add(float v)
public ArrayNode add(Float v)
public ArrayNode add(double v)
public ArrayNode add(Double v)
public ArrayNode add(BigDecimal v)
public ArrayNode add(BigInteger v)
public ArrayNode add(String v)
public ArrayNode add(boolean v)
public ArrayNode add(Boolean v)
public ArrayNode add(byte[] v)
public ArrayNode insertArray(int index)
ArrayNode (note! NOT `this` ArrayNode)public ObjectNode insertObject(int index)
ObjectNode, appending it at the end
of this array, and returning the newly created node
(note: NOT 'this' array)ObjectNode (note! NOT `this` ArrayNode)public ArrayNode insertNull(int index)
public ArrayNode insertPOJO(int index, Object pojo)
public ArrayNode insertRawValue(int index, RawValue raw)
public ArrayNode insert(int index, short v)
public ArrayNode insert(int index, Short value)
public ArrayNode insert(int index, int v)
public ArrayNode insert(int index, Integer v)
public ArrayNode insert(int index, long v)
public ArrayNode insert(int index, Long v)
public ArrayNode insert(int index, float v)
public ArrayNode insert(int index, Float v)
public ArrayNode insert(int index, double v)
public ArrayNode insert(int index, Double v)
public ArrayNode insert(int index, BigDecimal v)
public ArrayNode insert(int index, BigInteger v)
public ArrayNode insert(int index, String v)
public ArrayNode insert(int index, boolean v)
public ArrayNode insert(int index, Boolean value)
public ArrayNode insert(int index, byte[] v)
public ArrayNode setNull(int index)
public ArrayNode setPOJO(int index, Object pojo)
public ArrayNode setRawValue(int index, RawValue raw)
public ArrayNode set(int index, short v)
public ArrayNode set(int index, Short v)
public ArrayNode set(int index, int v)
public ArrayNode set(int index, Integer v)
public ArrayNode set(int index, long v)
public ArrayNode set(int index, float v)
public ArrayNode set(int index, Float v)
public ArrayNode set(int index, double v)
public ArrayNode set(int index, Double v)
public ArrayNode set(int index, BigDecimal v)
public ArrayNode set(int index, BigInteger v)
public ArrayNode set(int index, String v)
public ArrayNode set(int index, boolean v)
public ArrayNode set(int index, Boolean v)
public ArrayNode set(int index, 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(ArrayNode other)
public int hashCode()
hashCode in class BaseJsonNodeCopyright © 2008–2023 FasterXML. All rights reserved.