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
public abstract class ContainerNode extends BaseJsonNode
This intermediate base class is used for all container nodes, specifically, array and object nodes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classContainerNode.NoNodesIteratorprotected static classContainerNode.NoStringsIterator
-
Field Summary
-
Fields inherited from class org.codehaus.jackson.JsonNode
NO_NODES, NO_STRINGS
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedContainerNode(JsonNodeFactory nc)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ArrayNodearrayNode()Factory method that constructs and returns an emptyArrayNodeConstruction is done using registeredJsonNodeFactory.StringasText()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 JsonTokenasToken()Method that can be used for efficient type detection when using stream abstraction for traversing nodes.BinaryNodebinaryNode(byte[] data)BinaryNodebinaryNode(byte[] data, int offset, int length)BooleanNodebooleanNode(boolean v)abstract ObjectNodefindParent(String fieldName)Method for finding a JSON Object that contains specified field, within this node or its descendants.abstract List<JsonNode>findParents(String fieldName, List<JsonNode> foundSoFar)abstract JsonNodefindValue(String fieldName)Method for finding a JSON Object field with specified name in this node or its child nodes, and returning value it has.abstract List<JsonNode>findValues(String fieldName, List<JsonNode> foundSoFar)abstract List<String>findValuesAsText(String fieldName, List<String> foundSoFar)abstract JsonNodeget(int index)Method for accessing value of the specified element of an array node.abstract JsonNodeget(String fieldName)Method for accessing value of the specified field of an object node.StringgetValueAsText()Method that will return valid String representation of the container value, if the node is a value node (methodJsonNode.isValueNode()returns true), otherwise null.booleanisContainerNode()Method that returns true for container nodes: Arrays and Objects.NullNodenullNode()NumericNodenumberNode(byte v)NumericNodenumberNode(double v)NumericNodenumberNode(float v)NumericNodenumberNode(int v)NumericNodenumberNode(long v)NumericNodenumberNode(short v)NumericNodenumberNode(BigDecimal v)ObjectNodeobjectNode()Factory method that constructs and returns an emptyObjectNodeConstruction is done using registeredJsonNodeFactory.POJONodePOJONode(Object pojo)abstract ContainerNoderemoveAll()Method for removing all children container has (if any)abstract intsize()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.TextNodetextNode(String text)-
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 Detail
-
ContainerNode
protected ContainerNode(JsonNodeFactory nc)
-
-
Method Detail
-
isContainerNode
public boolean isContainerNode()
Description copied from class:JsonNodeMethod 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:
isContainerNodein classJsonNode
-
asToken
public abstract JsonToken asToken()
Description copied from class:BaseJsonNodeMethod that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the firstJsonTokenthat equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)- Specified by:
asTokenin classBaseJsonNode
-
getValueAsText
public String getValueAsText()
Description copied from class:JsonNodeMethod 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:
getValueAsTextin classJsonNode
-
asText
public String asText()
Description copied from class:JsonNodeMethod 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
public abstract JsonNode findValue(String fieldName)
Description copied from class:JsonNodeMethod 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:
findValuein classBaseJsonNode- Parameters:
fieldName- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findParent
public abstract ObjectNode findParent(String fieldName)
Description copied from class:JsonNodeMethod 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:
findParentin classBaseJsonNode- Parameters:
fieldName- Name of field to look for- Returns:
- Value of first matching node found, if any; null if none
-
findValues
public abstract List<JsonNode> findValues(String fieldName, List<JsonNode> foundSoFar)
- Overrides:
findValuesin classBaseJsonNode
-
findParents
public abstract List<JsonNode> findParents(String fieldName, List<JsonNode> foundSoFar)
- Overrides:
findParentsin classBaseJsonNode
-
findValuesAsText
public abstract List<String> findValuesAsText(String fieldName, List<String> foundSoFar)
- Overrides:
findValuesAsTextin classBaseJsonNode
-
size
public abstract int size()
Description copied from class:JsonNodeMethod 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
public abstract JsonNode get(int index)
Description copied from class:JsonNodeMethod 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
public abstract JsonNode get(String fieldName)
Description copied from class:JsonNodeMethod 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
public final ArrayNode arrayNode()
Factory method that constructs and returns an emptyArrayNodeConstruction is done using registeredJsonNodeFactory.
-
objectNode
public final ObjectNode objectNode()
Factory method that constructs and returns an emptyObjectNodeConstruction is done using registeredJsonNodeFactory.
-
nullNode
public final NullNode nullNode()
-
booleanNode
public final BooleanNode booleanNode(boolean v)
-
numberNode
public final NumericNode numberNode(byte v)
-
numberNode
public final NumericNode numberNode(short v)
-
numberNode
public final NumericNode numberNode(int v)
-
numberNode
public final NumericNode numberNode(long v)
-
numberNode
public final NumericNode numberNode(float v)
-
numberNode
public final NumericNode numberNode(double v)
-
numberNode
public final NumericNode numberNode(BigDecimal v)
-
binaryNode
public final BinaryNode binaryNode(byte[] data)
-
binaryNode
public final BinaryNode binaryNode(byte[] data, int offset, int length)
-
removeAll
public abstract ContainerNode removeAll()
Method for removing all children container has (if any)- Returns:
- Container node itself (to allow method call chaining)
- Since:
- 1.3
-
-