Jackson 3.0.1 · tools.jackson.core.TreeNode · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public JsonToken	Returns: `JsonToken` that is most closely associated with the node type asToken() Method that can be used for efficient type detection when using stream abstraction for traversing nodes.
public TreeNode	Returns: Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which `TreeNode#isMissingNode()` returns `true`). at(JsonPointer `JsonPointer` expression for descendant node to return ptr) Method for locating node specified by given JSON pointer instances.
public TreeNode	Returns: Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which `TreeNode#isMissingNode()` returns `true`). at(String Expression to compile as a `JsonPointer` instance ptrExpr) Convenience method that is functionally equivalent to: return at(JsonPointer.valueOf(jsonPointerExpression));
public TreeNode	Returns: Node that represent value of the specified property, if this node is an Object and has value for the specified property; `null` otherwise. get(String Name of the property to access propertyName) Method for accessing value of the specified property of an Object node.
public TreeNode	Returns: Node that represent value of the specified element, if this node is an array and has specified element; `null` otherwise. get(int Index of the Array node element to access index) Method for accessing value of the specified element of an array node.
public boolean	Returns: `True` for Array nodes, `false` for everything else isArray() Method that returns true if this node is an Array node, false otherwise.
public boolean	Returns: `True` for Array and Object nodes, `false` otherwise isContainer() Method that returns true for container nodes: Arrays and Objects.
public boolean	Returns: `True` for nodes representing "embedded" (or format-specific, native) value -- ones that streaming api exposes as `JsonToken#VALUE_EMBEDDED_OBJECT` -- `false` for other nodes isEmbeddedValue() Method that returns true if this node represents an embedded "foreign" (or perhaps native?) object (like POJO), not represented as regular content.
public boolean	Returns: `True` if this node represents a "missing" node isMissingNode() Method that returns true for "virtual" nodes which represent missing entries constructed by path accessor methods when there is no actual node matching given criteria.
public boolean	Returns: `True` for nodes representing explicit input `null`, `false` for everything else isNull() Method that returns true if this node is a node that represents logical `null` value.
public boolean	Returns: `True` for Object nodes, `false` for everything else isObject() Method that returns true if this node is an Object node, false otherwise.
public boolean	Returns: True if this node is considered a value node; something that represents either a scalar value or explicit `null` isValueNode() Method that returns true for all value nodes: ones that are not containers, and that do not represent "missing" nodes in the path.
public JsonParser.NumberType	Returns: Type of number contained, if any; or null if node does not contain numeric value. numberType() If this node is a numeric type (as per `JsonToken#isNumeric`), returns native type that node uses to store the numeric value; otherwise returns null.
public TreeNode	Returns: Node that represent value of the specified Object property, if this node is an object and has value for the specified property; otherwise "missing node" is returned. path(String Name of the property to access propertyName) Method for accessing value of the specified property of an Object node.
public TreeNode	Returns: Node that represent value of the specified element, if this node is an array and has specified element; otherwise "missing node" is returned. path(int Index of the Array node element to access index) Method for accessing value of the specified element of an array node.
public Collection<String>	Returns: `Collection` of names of all properties this Object node has (if Object node); empty `Collection` otherwise (never `null`). propertyNames() Method for accessing names of all properties for this node, if (and only if) this node is an Object node.
public int	Returns: For non-container nodes returns 0; for arrays number of contained elements, and for objects number of properties. size() Method that returns number of child nodes this node contains: for Array nodes, number of child elements, for Object nodes, number of properties, and for all other nodes 0.
public JsonParser	Returns: `JsonParser` that will stream over contents of this node traverse(ObjectReadContext `ObjectReadContext` to associate with parser constructed (to allow seamless databinding functionality) readCtxt) Method for constructing a `JsonParser` instance for iterating over contents of the tree that this node is root of.

Method Detail

asToken back to summary

asToken	back to summary
public JsonToken asToken() Method that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the first `JsonToken` that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple) Returns:JsonToken `JsonToken` that is most closely associated with the node type

public JsonToken asToken()

Method that can be used for efficient type detection when using stream abstraction for traversing nodes. Will return the first JsonToken that equivalent stream event would produce (for most nodes there is just one token but for structured/container types multiple)

Returns:JsonToken: JsonToken that is most closely associated with the node type

at back to summary

at	back to summary
public TreeNode at(JsonPointer ptr) Method for locating node specified by given JSON pointer instances. Method will never return null; if no matching node exists, will return a node for which `TreeNode#isMissingNode()` returns true. Parameters ptr:JsonPointer `JsonPointer` expression for descendant node to return Returns:TreeNode Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which `TreeNode#isMissingNode()` returns `true`).

public TreeNode at(JsonPointer ptr)

Method for locating node specified by given JSON pointer instances. Method will never return null; if no matching node exists, will return a node for which TreeNode#isMissingNode() returns true.

Parameters

ptr:JsonPointer: JsonPointer expression for descendant node to return

Returns:TreeNode

Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which TreeNode#isMissingNode() returns true).

at back to summary

at	back to summary
public TreeNode at(String ptrExpr) throws IllegalArgumentException Convenience method that is functionally equivalent to: return at(JsonPointer.valueOf(jsonPointerExpression)); Note that if the same expression is used often, it is preferable to construct `JsonPointer` instance once and reuse it: this method will not perform any caching of compiled expressions. Parameters ptrExpr:String Expression to compile as a `JsonPointer` instance Returns:TreeNode Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which `TreeNode#isMissingNode()` returns `true`).

public TreeNode at(String ptrExpr) throws IllegalArgumentException

Convenience method that is functionally equivalent to:

   return at(JsonPointer.valueOf(jsonPointerExpression));

Note that if the same expression is used often, it is preferable to construct JsonPointer instance once and reuse it: this method will not perform any caching of compiled expressions.

Parameters

ptrExpr:String: Expression to compile as a JsonPointer instance

Returns:TreeNode

Node that matches given JSON Pointer, if any: if no match exists, will return a "missing" node (for which TreeNode#isMissingNode() returns true).

get back to summary

get	back to summary
public TreeNode get(String propertyName) Method for accessing value of the specified property of an Object node. If this node is not an Object (or it does not have a value for specified property) `null` is returned. Note handling of explicit null values may vary between implementations; some trees may retain explicit nulls, others not. Parameters propertyName:String Name of the property to access Returns:TreeNode Node that represent value of the specified property, if this node is an Object and has value for the specified property; `null` otherwise.

public TreeNode get(String propertyName)

Method for accessing value of the specified property of an Object node. If this node is not an Object (or it does not have a value for specified property) null is returned.

Note

handling of explicit null values may vary between implementations; some trees may retain explicit nulls, others not.

Parameters

propertyName:String: Name of the property to access

Returns:TreeNode

Node that represent value of the specified property, if this node is an Object and has value for the specified property; null otherwise.

get back to summary

get	back to summary
public TreeNode get(int index) Method for accessing value of the specified element of an array node. For other nodes, null is 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. Parameters index:int Index of the Array node element to access Returns:TreeNode Node that represent value of the specified element, if this node is an array and has specified element; `null` otherwise.

public TreeNode get(int index)

Method for accessing value of the specified element of an array node. For other nodes, null is 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.

Parameters

index:int: Index of the Array node element to access

Returns:TreeNode

Node that represent value of the specified element, if this node is an array and has specified element; null otherwise.

isArray back to summary

isArray	back to summary
public boolean isArray() Method that returns true if this node is an Array node, false otherwise. Note that if true is returned, `isContainer()` must also return true. Returns:boolean `True` for Array nodes, `false` for everything else

public boolean isArray()

Method that returns true if this node is an Array node, false otherwise. Note that if true is returned, isContainer() must also return true.

Returns:boolean: True for Array nodes, false for everything else

isContainer back to summary

isContainer	back to summary
public boolean isContainer() Method that returns true for container nodes: Arrays and Objects. Note one and only one of methods `isValueNode`, `isContainer()` and `isMissingNode` ever returns true for any given node. Returns:boolean `True` for Array and Object nodes, `false` otherwise

public boolean isContainer()

Method that returns true for container nodes: Arrays and Objects.

Note

one and only one of methods isValueNode, isContainer() and isMissingNode ever returns true for any given node.

Returns:boolean: True for Array and Object nodes, false otherwise

isEmbeddedValue back to summary

isEmbeddedValue	back to summary
public boolean isEmbeddedValue() Method that returns true if this node represents an embedded "foreign" (or perhaps native?) object (like POJO), not represented as regular content. Such nodes are used to pass information that either native format cannot express as-is, metadata not included within at all, or something else that requires special handling. Returns:boolean `True` for nodes representing "embedded" (or format-specific, native) value -- ones that streaming api exposes as `JsonToken#VALUE_EMBEDDED_OBJECT` -- `false` for other nodes Since 3.0

public boolean isEmbeddedValue()

Method that returns true if this node represents an embedded "foreign" (or perhaps native?) object (like POJO), not represented as regular content. Such nodes are used to pass information that either native format cannot express as-is, metadata not included within at all, or something else that requires special handling.

Returns:boolean: True for nodes representing "embedded" (or format-specific, native) value -- ones that streaming api exposes as JsonToken#VALUE_EMBEDDED_OBJECT -- false for other nodes
Since: 3.0

isMissingNode back to summary

isMissingNode	back to summary
public boolean isMissingNode() Method that returns true for "virtual" nodes which represent missing entries constructed by path accessor methods when there is no actual node matching given criteria. Note one and only one of methods `isValueNode`, `isContainer()` and `isMissingNode` ever returns true for any given node. Returns:boolean `True` if this node represents a "missing" node

public boolean isMissingNode()

Method that returns true for "virtual" nodes which represent missing entries constructed by path accessor methods when there is no actual node matching given criteria.

Note

one and only one of methods isValueNode, isContainer() and isMissingNode ever returns true for any given node.

Returns:boolean: True if this node represents a "missing" node

isNull back to summary

isNull	back to summary
public boolean isNull() Method that returns true if this node is a node that represents logical `null` value. Returns:boolean `True` for nodes representing explicit input `null`, `false` for everything else Since 3.0

public boolean isNull()

Method that returns true if this node is a node that represents logical null value.

Returns:boolean: True for nodes representing explicit input null, false for everything else
Since: 3.0

isObject back to summary

isObject	back to summary
public boolean isObject() Method that returns true if this node is an Object node, false otherwise. Note that if true is returned, `isContainer()` must also return true. Returns:boolean `True` for Object nodes, `false` for everything else

public boolean isObject()

Method that returns true if this node is an Object node, false otherwise. Note that if true is returned, isContainer() must also return true.

Returns:boolean: True for Object nodes, false for everything else

isValueNode back to summary

isValueNode	back to summary
public boolean isValueNode() Method that returns true for all value nodes: ones that are not containers, and that do not represent "missing" nodes in the path. Such value nodes represent String, Number, Boolean and null values from JSON. Note one and only one of methods `isValueNode`, `isContainer()` and `isMissingNode` ever returns true for any given node. Returns:boolean True if this node is considered a value node; something that represents either a scalar value or explicit `null`

public boolean isValueNode()

Method that returns true for all value nodes: ones that are not containers, and that do not represent "missing" nodes in the path. Such value nodes represent String, Number, Boolean and null values from JSON.

Note

one and only one of methods isValueNode, isContainer() and isMissingNode ever returns true for any given node.

Returns:boolean: True if this node is considered a value node; something that represents either a scalar value or explicit null

numberType back to summary

numberType	back to summary
public JsonParser.NumberType numberType() If this node is a numeric type (as per `JsonToken#isNumeric`), returns native type that node uses to store the numeric value; otherwise returns null. Returns:JsonParser.NumberType Type of number contained, if any; or null if node does not contain numeric value.

public JsonParser.NumberType numberType()

If this node is a numeric type (as per JsonToken#isNumeric), returns native type that node uses to store the numeric value; otherwise returns null.

Returns:JsonParser.NumberType: Type of number contained, if any; or null if node does not contain numeric value.

path back to summary

path	back to summary
public TreeNode path(String propertyName) Method for accessing value of the specified property of an Object node. For other nodes, a "missing node" (virtual node for which `isMissingNode` returns true) is returned. Parameters propertyName:String Name of the property to access Returns:TreeNode Node that represent value of the specified Object property, if this node is an object and has value for the specified property; otherwise "missing node" is returned.

public TreeNode path(String propertyName)

Method for accessing value of the specified property of an Object node. For other nodes, a "missing node" (virtual node for which isMissingNode returns true) is returned.

Parameters

propertyName:String: Name of the property to access

Returns:TreeNode

Node that represent value of the specified Object property, if this node is an object and has value for the specified property; otherwise "missing node" is returned.

path back to summary

path	back to summary
public TreeNode path(int index) Method for accessing value of the specified element of an array node. For other nodes, a "missing node" (virtual node for which `isMissingNode` returns true) is 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()`, "missing node" is returned; no exception is thrown for any index. Parameters index:int Index of the Array node element to access Returns:TreeNode Node that represent value of the specified element, if this node is an array and has specified element; otherwise "missing node" is returned.

public TreeNode path(int index)

Method for accessing value of the specified element of an array node. For other nodes, a "missing node" (virtual node for which isMissingNode returns true) is 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(), "missing node" is returned; no exception is thrown for any index.

Parameters

index:int: Index of the Array node element to access

Returns:TreeNode

Node that represent value of the specified element, if this node is an array and has specified element; otherwise "missing node" is returned.

propertyNames back to summary

propertyNames	back to summary
public Collection<String> propertyNames() Method for accessing names of all properties for this node, if (and only if) this node is an Object node. Number of property names accessible will be `size`. Returns:Collection<String> `Collection` of names of all properties this Object node has (if Object node); empty `Collection` otherwise (never `null`).

public Collection<String> propertyNames()

Method for accessing names of all properties for this node, if (and only if) this node is an Object node. Number of property names accessible will be size.

Returns:Collection<String>: Collection of names of all properties this Object node has (if Object node); empty Collection otherwise (never null).

size	back to summary
public int size() Method that returns number of child nodes this node contains: for Array nodes, number of child elements, for Object nodes, number of properties, and for all other nodes 0. Returns:int For non-container nodes returns 0; for arrays number of contained elements, and for objects number of properties.

size

back to summary

public int size()

Method that returns number of child nodes this node contains: for Array nodes, number of child elements, for Object nodes, number of properties, and for all other nodes 0.

Returns:int: For non-container nodes returns 0; for arrays number of contained elements, and for objects number of properties.

traverse back to summary

traverse	back to summary
public JsonParser traverse(ObjectReadContext readCtxt) Method for constructing a `JsonParser` instance for iterating over contents of the tree that this node is root of. Functionally equivalent to first serializing tree and then re-parsing but more efficient. Note constructed parser instance will NOT initially point to a token, so before passing it to deserializers, it is typically necessary to advance it to the first available token by calling `JsonParser#nextToken()`. Parameters readCtxt:ObjectReadContext `ObjectReadContext` to associate with parser constructed (to allow seamless databinding functionality) Returns:JsonParser `JsonParser` that will stream over contents of this node

public JsonParser traverse(ObjectReadContext readCtxt)

Method for constructing a JsonParser instance for iterating over contents of the tree that this node is root of. Functionally equivalent to first serializing tree and then re-parsing but more efficient.

Note

constructed parser instance will NOT initially point to a token, so before passing it to deserializers, it is typically necessary to advance it to the first available token by calling JsonParser#nextToken().

Parameters

readCtxt:ObjectReadContext: ObjectReadContext to associate with parser constructed (to allow seamless databinding functionality)

Returns:JsonParser

JsonParser that will stream over contents of this node

public Interface TreeNode

Method Summary

Method Detail