Top Fields Constructors Methods
com.fasterxml.jackson.jr.stree

public Class JrsObject

extends JrsValue
Class Inheritance
Imports
java.io.IOException, java.util.Collections, .Iterator, .Map, com.fasterxml.jackson.core.JsonGenerator, .JsonPointer, .JsonToken

Field Summary

Modifier and TypeField and Description
private final Map<String, JrsValue>
_values

Constructor Summary

AccessConstructor and Description
public
JrsObject()

public
JrsObject(Map<String, JrsValue> values)

Method Summary

Modifier and TypeMethod and Description
protected JrsValue
_at(JsonPointer ptr)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue._at.

public JsonToken
asToken()

Implements com.fasterxml.jackson.core.TreeNode.asToken.

Method that can be used for efficient type detection when using stream abstraction for traversing nodes.

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Iterator<String>
fieldNames()

Overrides com.fasterxml.jackson.jr.stree.JrsValue.fieldNames.

Implements com.fasterxml.jackson.core.TreeNode.fieldNames.

Method for accessing names of all fields for this node, if (and only if) this node is an Object node.

public Iterator<Map.Entry<String, JrsValue>>
fields()

public JrsValue
get(int
Index of the Array node element to access
i)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.get.

Implements com.fasterxml.jackson.core.TreeNode.get.

Method for accessing value of the specified element of an array node.

public JrsValue
get(String
Name of the field (of Object node) to access
name)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.get.

Implements com.fasterxml.jackson.core.TreeNode.get.

Method for accessing value of the specified field of an object node.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isContainerNode()

Implements com.fasterxml.jackson.core.TreeNode.isContainerNode.

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

public boolean
isObject()

Overrides com.fasterxml.jackson.jr.stree.JrsValue.isObject.

Implements com.fasterxml.jackson.core.TreeNode.isObject.

Method that returns true if this node is an Object node, false otherwise.

public boolean
isValueNode()

Implements com.fasterxml.jackson.core.TreeNode.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 JrsValue
path(int
Index of the Array node element to access
i)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.path.

Implements com.fasterxml.jackson.core.TreeNode.path.

Method for accessing value of the specified element of an array node.

public JrsValue
path(String
Name of the field (of Object node) to access
name)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.path.

Implements com.fasterxml.jackson.core.TreeNode.path.

Method for accessing value of the specified field of an object node.

public int
size()

Implements com.fasterxml.jackson.core.TreeNode.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.

protected void
write(JsonGenerator g, JacksonJrsTreeCodec codec)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.write.

Inherited from com.fasterxml.jackson.jr.stree.JrsValue:
asTextatatisArrayisEmbeddedValueisMissingNodeisNullisNumbernumberTypetraversetraverse

Field Detail

_valuesback to summary
private final Map<String, JrsValue> _values

Constructor Detail

JrsObjectback to summary
public JrsObject()
JrsObjectback to summary
public JrsObject(Map<String, JrsValue> values)

Method Detail

_atback to summary
protected JrsValue _at(JsonPointer ptr)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue._at.

Annotations
@Override
asTokenback to summary
public JsonToken asToken()

Implements com.fasterxml.jackson.core.TreeNode.asToken.

Doc from com.fasterxml.jackson.core.TreeNode.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

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
fieldNamesback to summary
public Iterator<String> fieldNames()

Overrides com.fasterxml.jackson.jr.stree.JrsValue.fieldNames.

Implements com.fasterxml.jackson.core.TreeNode.fieldNames.

Doc from com.fasterxml.jackson.core.TreeNode.fieldNames.

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

Returns:Iterator<String>

An iterator for traversing names of all fields this Object node has (if Object node); empty Iterator otherwise (never null).

Annotations
@Override
fieldsback to summary
public Iterator<Map.Entry<String, JrsValue>> fields()
getback to summary
public JrsValue get(int i)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.get.

Implements com.fasterxml.jackson.core.TreeNode.get.

Doc from com.fasterxml.jackson.core.TreeNode.get.

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
i:int

Index of the Array node element to access

Returns:JrsValue

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

Annotations
@Override
getback to summary
public JrsValue get(String name)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.get.

Implements com.fasterxml.jackson.core.TreeNode.get.

Doc from com.fasterxml.jackson.core.TreeNode.get.

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.

Note

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

Parameters
name:String

Name of the field (of Object node) to access

Returns:JrsValue

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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isContainerNodeback to summary
public boolean isContainerNode()

Implements com.fasterxml.jackson.core.TreeNode.isContainerNode.

Doc from com.fasterxml.jackson.core.TreeNode.isContainerNode.

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

Note

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

Returns:boolean

True for Array and Object nodes, false otherwise

Annotations
@Override
isObjectback to summary
public boolean isObject()

Overrides com.fasterxml.jackson.jr.stree.JrsValue.isObject.

Implements com.fasterxml.jackson.core.TreeNode.isObject.

Doc from com.fasterxml.jackson.core.TreeNode.isObject.

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

Returns:boolean

True for Object nodes, false for everything else

Annotations
@Override
isValueNodeback to summary
public boolean isValueNode()

Implements com.fasterxml.jackson.core.TreeNode.isValueNode.

Doc from com.fasterxml.jackson.core.TreeNode.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, isContainerNode 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

Annotations
@Override
pathback to summary
public JrsValue path(int i)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.path.

Implements com.fasterxml.jackson.core.TreeNode.path.

Doc from com.fasterxml.jackson.core.TreeNode.path.

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
i:int

Index of the Array node element to access

Returns:JrsValue

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

Annotations
@Override
pathback to summary
public JrsValue path(String name)

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.path.

Implements com.fasterxml.jackson.core.TreeNode.path.

Doc from com.fasterxml.jackson.core.TreeNode.path.

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

Parameters
name:String

Name of the field (of Object node) to access

Returns:JrsValue

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

Annotations
@Override
sizeback to summary
public int size()

Implements com.fasterxml.jackson.core.TreeNode.size.

Doc from com.fasterxml.jackson.core.TreeNode.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.

Returns:int

For non-container nodes returns 0; for arrays number of contained elements, and for objects number of fields.

Annotations
@Override
writeback to summary
protected void write(JsonGenerator g, JacksonJrsTreeCodec codec) throws IOException

Implements abstract com.fasterxml.jackson.jr.stree.JrsValue.write.

Annotations
@Override