JNode

java.lang.Object
- com.jaunt.JNode

All Implemented Interfaces:

Iterable<JNode>
```
public class JNode
extends Object
implements Iterable<JNode>
```
A JNode (JSON Node) represents a node of a JSON tree; depending on its type, it can represent an object node, array node, or a primitive node (String, numerics, booleans).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JNode.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`JNode.Type`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JNode`	`findEach(String query)` Searches descendant nodes and returns a JNodes container that holds all JNodes matching the query, not including those nodes that are descendants of any matching nodes (ie, excludes nested matches); returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
`JNode`	`findEvery(String query)` Searches descendant nodes and returns a JNodes container that holds all JNodes matching the query; returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
`JNode`	`findFirst(String query)` Searches descendant nodes and retrieves the first JNode that matches the specified query, or throws a NotFound Exception if no matching JNode is found; throws a NotFound Exception if no matching JNode is found, or if this method is invoked on a leaf node.
`JNode`	`get(int index)` Returns the JNode at the specified position or throws a NotFound Exception if the specified position is out of bounds.
`JNode`	`get(String name)` Returns the child node associated with the specified name or throws a NotFound Exception if the name does not exist as a key; if the specified name is associated with the value null, then a JNode of Type.UNDEFINED is returned.
`JNode`	`getEach(String query)` Searches only child nodes (not all descendants) and returns a JNodes container that holds all JNodes matching the query; returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
`JNode`	`getFirst(String query)` Searches only child nodes (not all descendants) and retrieves the first JNode that matches the specified query; throws a NotFound Exception if no matching JNode is found, or if this method is invoked on a leaf node.
`String`	`getName()` Returns the name associated with this node, or null if the node is not associated with a name (such as the root node, or nodes in an array).
`JNode`	`getParent()` Returns the parent node or null if no parent node exists (such as for the root Node).
`JNode.Type`	`getType()` Returns the node type as defined by the node type constants in this class.
`boolean`	`isPrimitive()` Returns true if this node is a primitive type; ie, if the `getType()` method returns TYPE_STRING, TYPE_BOOLEAN, TYPE_NUMBER, or TYPE_UNDEFINED)
`Iterator<JNode>`	`iterator()` If this JNode is of TYPE_OBJECT, returns returns an iterator over the child JNodes; otherwise returns null.
`int`	`size()` If this Node does not represent a JSON object or array, return -1; otherwise returns the number of child nodes in the object/array.
`boolean`	`toBoolean()` Returns a primitive boolean representation of this Node.
`double`	`toDouble()` Returns a primitive double representation of this Node.
`float`	`toFloat()` Returns a primitive float representation of this Node.
`int`	`toInt()` Returns a primitive int representation of this Node.
`long`	`toLong()` Returns a primitive long representation of this Node.
`String`	`toString()` Returns a String representation of this Node.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - isPrimitive
```
public boolean isPrimitive()
```
    Returns true if this node is a primitive type; ie, if the getType() method returns TYPE_STRING, TYPE_BOOLEAN, TYPE_NUMBER, or TYPE_UNDEFINED)
  - getFirst
```
public JNode getFirst(String query)
               throws NotFound
```
    Searches only child nodes (not all descendants) and retrieves the first JNode that matches the specified query; throws a NotFound Exception if no matching JNode is found, or if this method is invoked on a leaf node.
    
    Parameters:
    
    query - a query that has the general form:
    
    "nodeNameRegex": {"attributeName":"attributeValueRegex"}
    
    where multiple attributeName/attributeValueRegex pairs are comma-separated and quotes are optional or can be substituted with apostrophes. In order for the query to match a candidate JNode, all specified fields of the query must match, though each field is optional.
    
    Query Components:
    nodeNameRegex: if specified, the node name is matched as a regular expression. The colon is not required if the query consists of only the nodeNameRegex.
    attributeName: if specified, the attribute name is matched as a case-sensitive string or as a regular expression if enclosed in parenthesis. If no attributeName/attributeValueRegex pairs are specified in the query, the query will match any attribute attributeName/attributeValue in a candidate object.
    attributeValueRegex: if specified, the attribute value is matched as a regular expression. If the attributeValueRegex is not present in the query, the attributeName will be matched against candidate attributeNames irrespective of their attributeValues.
    
    Returns:
    
    first child JNode that matches the specified query
    
    Throws:
    
    NotFound
  - getEach
```
public JNode getEach(String query)
              throws NotFound
```
    Searches only child nodes (not all descendants) and returns a JNodes container that holds all JNodes matching the query; returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
    
    Parameters:
    
    query - a query that has the general form:
    
    "nodeNameRegex": {"attributeName":"attributeValueRegex"}
    
    where multiple attributeName/attributeValueRegex pairs are comma-separated and quotes are optional or can be substituted with apostrophes. In order for the query to match a candidate JNode, all specified fields of the query must match, though each field is optional.
    
    Query Components:
    nodeNameRegex: if specified, the node name is matched as a regular expression. The colon is not required if the query consists of only the nodeNameRegex.
    attributeName: if specified, the attribute name is matched as a case-sensitive string or as a regular expression if enclosed in parenthesis. If no attributeName/attributeValueRegex pairs are specified in the query, the query will match any attribute attributeName/attributeValue in a candidate object.
    attributeValueRegex: if specified, the attribute value is matched as a regular expression. If the attributeValueRegex is not present in the query, the attributeName will be matched against candidate attributeNames irrespective of their attributeValues.
    
    Returns:
    
    a JNodes container whose children are the JNodes that matched the search query.
    
    Throws:
    
    NotFound
  - findFirst
```
public JNode findFirst(String query)
                throws NotFound
```
    Searches descendant nodes and retrieves the first JNode that matches the specified query, or throws a NotFound Exception if no matching JNode is found; throws a NotFound Exception if no matching JNode is found, or if this method is invoked on a leaf node.
    
    Parameters:
    
    query - a query that has the general form:
    
    "nodeNameRegex": {"attributeName":"attributeValueRegex"}
    
    where multiple attributeName/attributeValueRegex pairs are comma-separated and quotes are optional or can be substituted with apostrophes. In order for the query to match a candidate JNode, all specified fields of the query must match, though each field is optional.
    
    Query Components:
    nodeNameRegex: if specified, the node name is matched as a regular expression. The colon is not required if the query consists of only the nodeNameRegex.
    attributeName: if specified, the attribute name is matched as a case-sensitive string or as a regular expression if enclosed in parenthesis. If no attributeName/attributeValueRegex pairs are specified in the query, the query will match any attribute attributeName/attributeValue in a candidate object.
    attributeValueRegex: if specified, the attribute value is matched as a regular expression. If the attributeValueRegex is not present in the query, the attributeName will be matched against candidate attributeNames irrespective of their attributeValues.
    
    Returns:
    
    first child JNode that matches the specified query
    
    Throws:
    
    NotFound
  - findEach
```
public JNode findEach(String query)
               throws NotFound
```
    Searches descendant nodes and returns a JNodes container that holds all JNodes matching the query, not including those nodes that are descendants of any matching nodes (ie, excludes nested matches); returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
    
    Parameters:
    
    query - a query that has the general form:
    
    "nodeNameRegex": {"attributeName":"attributeValueRegex"}
    
    where multiple attributeName/attributeValueRegex pairs are comma-separated and quotes are optional or can be substituted with apostrophes. In order for the query to match a candidate JNode, all specified fields of the query must match, though each field is optional.
    
    Query Components:
    nodeNameRegex: if specified, the node name is matched as a regular expression. The colon is not required if the query consists of only the nodeNameRegex.
    attributeName: if specified, the attribute name is matched as a case-sensitive string or as a regular expression if enclosed in parenthesis. If no attributeName/attributeValueRegex pairs are specified in the query, the query will match any attribute attributeName/attributeValue in a candidate object.
    attributeValueRegex: if specified, the attribute value is matched as a regular expression. If the attributeValueRegex is not present in the query, the attributeName will be matched against candidate attributeNames irrespective of their attributeValues.
    
    Returns:
    
    a JNodes container whose children are the JNodes that matched the search query.
    
    Throws:
    
    NotFound
  - findEvery
```
public JNode findEvery(String query)
                throws NotFound
```
    Searches descendant nodes and returns a JNodes container that holds all JNodes matching the query; returns an empty JNodes container if no matching JNodes were found or if the method is invoked on a leaf node.
    
    Parameters:
    
    query - a query that has the general form:
    
    "nodeNameRegex": {"attributeName":"attributeValueRegex"}
    
    where multiple attributeName/attributeValueRegex pairs are comma-separated and quotes are optional or can be substituted with apostrophes. In order for the query to match a candidate JNode, all specified fields of the query must match, though each field is optional.
    
    Query Components:
    nodeNameRegex: if specified, the node name is matched as a regular expression. The colon is not required if the query consists of only the nodeNameRegex.
    attributeName: if specified, the attribute name is matched as a case-sensitive string or as a regular expression if enclosed in parenthesis. If no attributeName/attributeValueRegex pairs are specified in the query, the query will match any attribute attributeName/attributeValue in a candidate object.
    attributeValueRegex: if specified, the attribute value is matched as a regular expression. If the attributeValueRegex is not present in the query, the attributeName will be matched against candidate attributeNames irrespective of their attributeValues.
    
    Returns:
    
    a JNodes container whose children are the JNodes that matched the search query.
    
    Throws:
    
    NotFound
  - getParent
```
public JNode getParent()
```
    Returns the parent node or null if no parent node exists (such as for the root Node).
  - getType
```
public JNode.Type getType()
```
    Returns the node type as defined by the node type constants in this class.
  - getName
```
public String getName()
```
    Returns the name associated with this node, or null if the node is not associated with a name (such as the root node, or nodes in an array).
  - get
```
public JNode get(String name)
          throws NotFound
```
    Returns the child node associated with the specified name or throws a NotFound Exception if the name does not exist as a key; if the specified name is associated with the value null, then a JNode of Type.UNDEFINED is returned.
    
    Throws:
    
    NotFound
  - get
```
public JNode get(int index)
          throws NotFound
```
    Returns the JNode at the specified position or throws a NotFound Exception if the specified position is out of bounds.
    
    Throws:
    
    NotFound
  - size
```
public int size()
```
    If this Node does not represent a JSON object or array, return -1; otherwise returns the number of child nodes in the object/array.
  - toString
```
public String toString()
```
    Returns a String representation of this Node.
    
    Overrides:
    
    toString in class Object
  - toBoolean
```
public boolean toBoolean()
```
    Returns a primitive boolean representation of this Node.
  - toInt
```
public int toInt()
```
    Returns a primitive int representation of this Node.
  - toFloat
```
public float toFloat()
```
    Returns a primitive float representation of this Node.
  - toDouble
```
public double toDouble()
```
    Returns a primitive double representation of this Node.
  - toLong
```
public long toLong()
```
    Returns a primitive long representation of this Node.
  - iterator
```
public Iterator<JNode> iterator()
```
    If this JNode is of TYPE_OBJECT, returns returns an iterator over the child JNodes; otherwise returns null.
    
    Specified by:
    
    iterator in interface Iterable<JNode>
    
    See Also:
    
    getType()

Class JNode

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

isPrimitive

getFirst

getEach

findFirst

findEach

findEvery

getParent

getType

getName

get

get

size

toString

toBoolean

toInt

toFloat

toDouble

toLong

iterator