Package org.codehaus.jackson.node
Class ContainerNode
java.lang.Object
org.codehaus.jackson.JsonNode
org.codehaus.jackson.node.BaseJsonNode
org.codehaus.jackson.node.ContainerNode
- All Implemented Interfaces:
Iterable<JsonNode>
,JsonSerializable
,JsonSerializableWithType
- Direct Known Subclasses:
ArrayNode
,ObjectNode
This intermediate base class is used for all container nodes,
specifically, array and object nodes.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
protected static class
-
Field Summary
Fields inherited from class org.codehaus.jackson.JsonNode
NO_NODES, NO_STRINGS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal ArrayNode
Factory method that constructs and returns an emptyArrayNode
Construction is done using registeredJsonNodeFactory
.asText()
Method that will return valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()
returns true), otherwise empty String.abstract JsonToken
asToken()
Method that can be used for efficient type detection when using stream abstraction for traversing nodes.final BinaryNode
binaryNode
(byte[] data) final BinaryNode
binaryNode
(byte[] data, int offset, int length) final BooleanNode
booleanNode
(boolean v) abstract ObjectNode
findParent
(String fieldName) Method for finding a JSON Object that contains specified field, within this node or its descendants.findParents
(String fieldName, List<JsonNode> foundSoFar) abstract JsonNode
Method for finding a JSON Object field with specified name in this node or its child nodes, and returning value it has.findValues
(String fieldName, List<JsonNode> foundSoFar) findValuesAsText
(String fieldName, List<String> foundSoFar) abstract JsonNode
get
(int index) Method for accessing value of the specified element of an array node.abstract JsonNode
Method for accessing value of the specified field of an object node.Method that will return valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()
returns true), otherwise null.boolean
Method that returns true for container nodes: Arrays and Objects.final NullNode
nullNode()
final NumericNode
numberNode
(byte v) final NumericNode
numberNode
(double v) final NumericNode
numberNode
(float v) final NumericNode
numberNode
(int v) final NumericNode
numberNode
(long v) final NumericNode
numberNode
(short v) final NumericNode
final ObjectNode
Factory method that constructs and returns an emptyObjectNode
Construction is done using registeredJsonNodeFactory
.final POJONode
abstract ContainerNode
Method for removing all children container has (if any)abstract 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.final TextNode
Methods inherited from class org.codehaus.jackson.node.BaseJsonNode
findPath, getNumberType, serialize, serializeWithType, traverse
Methods inherited from class org.codehaus.jackson.JsonNode
asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, equals, findParents, findValues, findValuesAsText, getBigIntegerValue, getBinaryValue, getBooleanValue, getDecimalValue, getDoubleValue, getElements, getFieldNames, getFields, getIntValue, getLongValue, getNumberValue, getPath, getPath, getTextValue, getValueAsBoolean, getValueAsBoolean, getValueAsDouble, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, has, has, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isDouble, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isObject, isPojo, isTextual, isValueNode, iterator, path, path, toString, with
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
ContainerNode
-
-
Method Details
-
isContainerNode
public boolean isContainerNode()Description copied from class:JsonNode
Method that returns true for container nodes: Arrays and Objects.Note: one and only one of methods
JsonNode.isValueNode()
,JsonNode.isContainerNode()
andJsonNode.isMissingNode()
ever returns true for any given node.- Overrides:
isContainerNode
in classJsonNode
-
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 classBaseJsonNode
-
getValueAsText
Description copied from class:JsonNode
Method that will return valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()
returns true), otherwise null.Note: to serialize nodes of any type, you should call
JsonNode.toString()
instead.- Overrides:
getValueAsText
in classJsonNode
-
asText
Description copied from class:JsonNode
Method that will return valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()
returns true), otherwise empty String. -
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.- Overrides:
findValue
in classBaseJsonNode
- Parameters:
fieldName
- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
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.- Overrides:
findParent
in classBaseJsonNode
- Parameters:
fieldName
- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findValues
- Overrides:
findValues
in classBaseJsonNode
-
findParents
- Overrides:
findParents
in classBaseJsonNode
-
findValuesAsText
- Overrides:
findValuesAsText
in classBaseJsonNode
-
size
public abstract int size()Description copied from class:JsonNode
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. -
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. -
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. -
arrayNode
Factory method that constructs and returns an emptyArrayNode
Construction is done using registeredJsonNodeFactory
. -
objectNode
Factory method that constructs and returns an emptyObjectNode
Construction is done using registeredJsonNodeFactory
. -
nullNode
-
booleanNode
-
numberNode
-
numberNode
-
numberNode
-
numberNode
-
numberNode
-
numberNode
-
numberNode
-
textNode
-
binaryNode
-
binaryNode
-
POJONode
-
removeAll
Method for removing all children container has (if any)- Returns:
- Container node itself (to allow method call chaining)
- Since:
- 1.3
-