JsonNode (Argo version 7.4)

java.lang.Object
- argo.jdom.JsonNode

Direct Known Subclasses:

JsonStringNode
```
public abstract class JsonNode
extends java.lang.Object
```
A node (leaf or otherwise) in a JSON document.

Supplies methods for examining the node, and also examining and navigating the hierarchy at and below this node. Methods for navigating the hierarchy are of the form getXXXValue(Object... pathElements).

For example, getStringValue(Object...) takes a series of Strings and Integers as its argument which tell it how to navigate down a hierarchy to a particular JSON string. The Strings tell it to select a field with the given name from an object, and the Integers tell it to select an element with the given index from an array. If no field of that name exists, or the field exists, but it isn't a JSON string, an IllegalArgumentException is thrown.

Methods for examining the hierarchy work on the same principal as the getXXXValue(Object... pathElements) methods, but return a boolean indicating whether or not the element at the given path exists and is of the type specified, for example, getStringValue("my field") returns true if the node has a field called "my field", and its value is a JSON string.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<JsonNode>`	`getArrayNode(java.lang.Object... pathElements)` Gets a `List` of `JsonNode`s, representing a JSON array, by navigating the hierarchy below this node.
`java.lang.Boolean`	`getBooleanValue(java.lang.Object... pathElements)` Gets a `Boolean` by navigating the hierarchy below this node.
`abstract java.util.List<JsonNode>`	`getElements()`
`abstract java.util.List<JsonField>`	`getFieldList()` Gets the fields associated with this node as a list of `JsonFields`.
`abstract java.util.Map<JsonStringNode,JsonNode>`	`getFields()` Gets the fields associated with this node as a map of name to value.
`JsonNode`	`getNode(java.lang.Object... pathElements)` Gets a `JsonNode` by navigating the hierarchy below this node.
`java.util.List<JsonNode>`	`getNullableArrayNode(java.lang.Object... pathElements)` Gets a `List` of `JsonNode`s, representing a JSON array, or `null` by navigating the hierarchy below this node.
`java.lang.Boolean`	`getNullableBooleanValue(java.lang.Object... pathElements)` Gets a `Boolean` or `null` by navigating the hierarchy below this node.
`java.lang.String`	`getNullableNumberValue(java.lang.Object... pathElements)` Gets a numeric `String` or `null` by navigating the hierarchy below this node.
`java.util.Map<JsonStringNode,JsonNode>`	`getNullableObjectNode(java.lang.Object... pathElements)` Gets a `Map` of `String` field names to `JsonNode`s, representing a JSON object, or `null` by navigating the hierarchy below this node.
`java.lang.String`	`getNullableStringValue(java.lang.Object... pathElements)` Gets a `String` or `null` by navigating the hierarchy below this node.
`JsonNode`	`getNullNode(java.lang.Object... pathElements)` Gets a `JsonNode` representing null by navigating the hierarchy below this node.
`java.lang.String`	`getNumberValue(java.lang.Object... pathElements)` Gets a numeric `String` by navigating the hierarchy below this node.
`java.util.Map<JsonStringNode,JsonNode>`	`getObjectNode(java.lang.Object... pathElements)` Gets a `Map` of `String` field names to `JsonNode`s, representing a JSON object, by navigating the hierarchy below this node.
`java.lang.String`	`getStringValue(java.lang.Object... pathElements)` Gets a `String` by navigating the hierarchy below this node.
`abstract java.lang.String`	`getText()`
`abstract JsonNodeType`	`getType()`
`abstract boolean`	`hasElements()`
`abstract boolean`	`hasFields()`
`abstract boolean`	`hasText()`
`boolean`	`isArrayNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON array.
`boolean`	`isBooleanValue(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON boolean.
`boolean`	`isNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists.
`boolean`	`isNullableArrayNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON array or a JSON null.
`boolean`	`isNullableBooleanValue(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON boolean or a JSON null.
`boolean`	`isNullableNumberNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON number or a JSON null.
`boolean`	`isNullableObjectNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON object or a JSON null.
`boolean`	`isNullableStringValue(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON string or a JSON null.
`boolean`	`isNullNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON null.
`boolean`	`isNumberValue(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON number.
`boolean`	`isObjectNode(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON object.
`boolean`	`isStringValue(java.lang.Object... pathElements)` Determines whether the node at the given path exists and is a JSON string.
`abstract void`	`visit(JsonNodeVisitor jsonNodeVisitor)` Executes a callback to the method corresponding to the type of this `JsonNode`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getType
```
public abstract JsonNodeType getType()
```
  - hasText
```
public abstract boolean hasText()
```
  - getText
```
public abstract java.lang.String getText()
```
    Returns:
    
    the text associated with this node
    
    Throws:
    
    java.lang.IllegalStateException - if hasText() returns false, indicating this type of node doesn't have text.
  - hasFields
```
public abstract boolean hasFields()
```
  - getFields
```
public abstract java.util.Map<JsonStringNode,JsonNode> getFields()
```
    Gets the fields associated with this node as a map of name to value. Note that JSON permits duplicated keys in an object, though in practice this is rare, and in this case, this method will return a map containing a single entry of each unique key.
    
    Returns:
    
    the fields associated with this node
    
    Throws:
    
    java.lang.IllegalStateException - if hasFields() returns false, indicating this type of node doesn't support fields.
  - getFieldList
```
public abstract java.util.List<JsonField> getFieldList()
```
    Gets the fields associated with this node as a list of JsonFields. This method allows the retrieval of all fields in an object even when the fields have duplicate keys. This method also preserves the order of the fields.
    
    Returns:
    
    the fields associated with this node
    
    Throws:
    
    java.lang.IllegalStateException - if hasFields() returns false, indicating this type of node doesn't support fields.
  - hasElements
```
public abstract boolean hasElements()
```
  - getElements
```
public abstract java.util.List<JsonNode> getElements()
```
    Returns:
    
    the elements associated with this node
    
    Throws:
    
    java.lang.IllegalStateException - if hasElements() returns false, indicating this type of node doesn't support elements.
  - isNode
```
public boolean isNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON node exists at the path given.
  - getNode
```
public JsonNode getNode(java.lang.Object... pathElements)
```
    Gets a JsonNode by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the JsonNode at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path.
  - isBooleanValue
```
public final boolean isBooleanValue(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON boolean.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON boolean exists at the path given.
  - getBooleanValue
```
public final java.lang.Boolean getBooleanValue(java.lang.Object... pathElements)
```
    Gets a Boolean by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the Boolean at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON boolean.
  - isNullableBooleanValue
```
public final boolean isNullableBooleanValue(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON boolean or a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON boolean or a JSON null exists at the path given.
  - getNullableBooleanValue
```
public final java.lang.Boolean getNullableBooleanValue(java.lang.Object... pathElements)
```
    Gets a Boolean or null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the Boolean at the path given, or null, if there is a JSON null at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON boolean or a JSON null.
  - isStringValue
```
public final boolean isStringValue(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON string.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON string exists at the path given.
  - getStringValue
```
public final java.lang.String getStringValue(java.lang.Object... pathElements)
```
    Gets a String by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the String at the path given
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON string.
  - isNullableStringValue
```
public final boolean isNullableStringValue(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON string or a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON string or a JSON null exists at the path given.
  - getNullableStringValue
```
public final java.lang.String getNullableStringValue(java.lang.Object... pathElements)
```
    Gets a String or null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the String at the path given, or null, if there is a JSON null at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON string or a JSON null.
  - isNumberValue
```
public final boolean isNumberValue(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON number.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON number exists at the path given.
  - getNumberValue
```
public final java.lang.String getNumberValue(java.lang.Object... pathElements)
```
    Gets a numeric String by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the numeric String at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON number.
  - isNullableNumberNode
```
public final boolean isNullableNumberNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON number or a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON number or a JSON null exists at the path given.
  - getNullableNumberValue
```
public final java.lang.String getNullableNumberValue(java.lang.Object... pathElements)
```
    Gets a numeric String or null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    the numeric String at the path given, or null, if there is a JSON null at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON number or a JSON null.
  - isNullNode
```
public final boolean isNullNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON null exists at the path given.
  - getNullNode
```
public final JsonNode getNullNode(java.lang.Object... pathElements)
```
    Gets a JsonNode representing null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    a JsonNode representing null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON null.
  - isObjectNode
```
public final boolean isObjectNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON object.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON object exists at the path given.
  - getObjectNode
```
public final java.util.Map<JsonStringNode,JsonNode> getObjectNode(java.lang.Object... pathElements)
```
    Gets a Map of String field names to JsonNodes, representing a JSON object, by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    a Map of String field names to JsonNodes representing a JSON object.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON object.
  - isNullableObjectNode
```
public final boolean isNullableObjectNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON object or a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON object or a JSON null exists at the path given.
  - getNullableObjectNode
```
public final java.util.Map<JsonStringNode,JsonNode> getNullableObjectNode(java.lang.Object... pathElements)
```
    Gets a Map of String field names to JsonNodes, representing a JSON object, or null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    a Map of String field names to JsonNodes representing a JSON object at the path given, or null, if there is a JSON null at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON object or a JSON null.
  - isArrayNode
```
public final boolean isArrayNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON array.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON array exists at the path given.
  - getArrayNode
```
public final java.util.List<JsonNode> getArrayNode(java.lang.Object... pathElements)
```
    Gets a List of JsonNodes, representing a JSON array, by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    a List of JsonNodes representing a JSON array.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON array.
  - isNullableArrayNode
```
public final boolean isNullableArrayNode(java.lang.Object... pathElements)
```
    Determines whether the node at the given path exists and is a JSON array or a JSON null.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    whether a JSON array or a JSON null exists at the path given.
  - getNullableArrayNode
```
public final java.util.List<JsonNode> getNullableArrayNode(java.lang.Object... pathElements)
```
    Gets a List of JsonNodes, representing a JSON array, or null by navigating the hierarchy below this node.
    
    Parameters:
    
    pathElements - a series of Strings, representing the names of fields on objects, and Integers, representing elements of arrays indicating how to navigate from this node.
    
    Returns:
    
    a List of JsonNodes representing a JSON array, or null, if there is a JSON null at the path given.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is no node at the given path, or the node at the given path is not a JSON array or a JSON null.
  - visit
```
public abstract void visit(JsonNodeVisitor jsonNodeVisitor)
```
    Executes a callback to the method corresponding to the type of this JsonNode.
    
    Parameters:
    
    jsonNodeVisitor - the JsonNodeVisitor to call back.

Class JsonNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getType

hasText

getText

hasFields

getFields

getFieldList

hasElements

getElements

isNode

getNode

isBooleanValue

getBooleanValue

isNullableBooleanValue

getNullableBooleanValue

isStringValue

getStringValue

isNullableStringValue

getNullableStringValue

isNumberValue

getNumberValue

isNullableNumberNode

getNullableNumberValue

isNullNode

getNullNode

isObjectNode

getObjectNode

isNullableObjectNode

getNullableObjectNode

isArrayNode

getArrayNode

isNullableArrayNode

getNullableArrayNode

visit