Node (DataStax Enterprise Java Driver - Binary distribution 1.8.2 API)

All Known Subinterfaces:

GraphNode

All Known Implementing Classes:

ObjectGraphNode
```
public interface Node
```
A node in a tree-like structure, represented in a generic way.
This interface provide convenience methods to convert the node that it represents into more specific types, such as primitive types (boolean, string, int, long, double); it also contains two generic methods: as(Class) and as(TypeToken) that can convert this node into any arbitrary Java type, provided that the underlying serialization runtime has been correctly configured to support the requested conversion.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T> T`	`as(Class<T> clazz)` Deserializes and returns this node as an instance of `clazz`.
`<T> T`	`as(TypeToken<T> type)` Deserializes and returns this node as an instance of the given `type`.
`boolean`	`asBoolean()` Returns this node as a boolean.
`double`	`asDouble()` Returns this node as a double.
`int`	`asInt()` Returns this node as an integer.
`long`	`asLong()` Returns this node as a long integer.
`Map<String,Object>`	`asMap()` Deserializes and returns this node as an instance of `Map<String, Object>`.
`String`	`asString()` Returns a valid String representation of this node, if the node is a simple node (i.e.
`Iterator<String>`	`fieldNames()` Returns all the field names of the current node, if it is an object, or an empty iterator otherwise.
`Node`	`get(int index)` Returns the element node at the specified `index` of an array node.
`Node`	`get(String fieldName)` Returns the value of the specified field of an object node.
`boolean`	`isArray()` Returns whether this node is an array.
`boolean`	`isNull()` Returns whether this node is `null`.
`boolean`	`isObject()` Returns whether this node is an object.
`boolean`	`isValue()` Returns whether this node is a simple value, i.e.
`int`	`size()` Returns the size of the current node, if it is an array, or `0` otherwise.

- Method Detail
  - isNull
```
boolean isNull()
```
    Returns whether this node is null.
    
    Returns:
    
    true if this node is null, false otherwise.
  - isObject
```
boolean isObject()
```
    Returns whether this node is an object.
    Only one method out of isObject(), isArray() and isValue() should ever return true for one given node.
    
    Returns:
    
    true if this node is an object, false otherwise.
  - isArray
```
boolean isArray()
```
    Returns whether this node is an array.
    Only one method out of isObject(), isArray() and isValue() should ever return true for one given node.
    
    Returns:
    
    true if this node is an array, false otherwise.
  - isValue
```
boolean isValue()
```
    Returns whether this node is a simple value, i.e. either a string, a boolean, a number, or null.
    Only one method out of isObject(), isArray() and isValue() should ever return true for one given node.
    
    Returns:
    
    whether this node is a simple value, false otherwise.
  - fieldNames
```
Iterator<String> fieldNames()
```
    Returns all the field names of the current node, if it is an object, or an empty iterator otherwise.
    
    Returns:
    
    a Iterator of all the field names of the current node.
  - size
```
int size()
```
    Returns the size of the current node, if it is an array, or 0 otherwise.
    
    Returns:
    
    the size of the current node f it is an array, or 0 otherwise.
  - asInt
```
int asInt()
```
    Returns this node as an integer.
    If this node can not be converted to an int (including structured types like Objects and Arrays), 0 will be returned; no exceptions will be thrown.
    
    Returns:
    
    an integer representation of this node, or 0 if this node can not be converted to an int.
  - asBoolean
```
boolean asBoolean()
```
    Returns this node as a boolean.
    If this node can not be converted to a boolean (including structured types like Objects and Arrays), false will be returned; no exceptions will be thrown.
    
    Returns:
    
    a boolean representation of this node, or false if this node can not be converted to a boolean.
  - asLong
```
long asLong()
```
    Returns this node as a long integer.
    
    Returns:
    
    a long integer representation of this node, or 0L if this node is null.
  - asDouble
```
double asDouble()
```
    Returns this node as a double.
    
    Returns:
    
    a double representation of this node, or 0.0D if this node is null.
  - asString
```
String asString()
```
    Returns a valid String representation of this node, if the node is a simple node (i.e. it is not an object nor an array), otherwise returns an empty String.
    
    Returns:
    
    a String representation of this node, or an empty string, if this node is not a simple node.
  - asMap
```
Map<String,Object> asMap()
```
    Deserializes and returns this node as an instance of Map<String, Object>.
    
    Returns:
    
    this node converted into an instance of Map<String, Object>.
    
    Throws:
    
    DriverException - if this node cannot be converted to a map.
  - as
```
<T> T as(Class<T> clazz)
```
    Deserializes and returns this node as an instance of clazz.
    Before attempting such a conversion, there must be an appropriate converter configured on the underlying serialization runtime.
    
    Parameters:
    
    clazz - the class to convert this node into.
    
    Returns:
    
    this node converted into an instance of clazz.
    
    Throws:
    
    DriverException - if this node cannot be converted to the given class.
  - as
```
<T> T as(TypeToken<T> type)
```
    Deserializes and returns this node as an instance of the given type.
    Before attempting such a conversion, there must be an appropriate converter configured on the underlying serialization runtime.
    
    Parameters:
    
    type - the type to convert this node into.
    
    Returns:
    
    this node converted into an instance of type.
    
    Throws:
    
    DriverException - if this node cannot be converted to the given type.
  - get
```
Node get(String fieldName)
```
    Returns the value of the specified field of an object node.
    If this node is not an object (or it does not have a value for the specified field name), or if there is no field with such name, null is returned.
    If the property value has been explicitly set to null, implementors may return a special "null node" instead of null.
    
    Parameters:
    
    fieldName - the field name to fetch.
    
    Returns:
    
    a node containing the requested field value, or null if it does not exist.
  - get
```
Node get(int index)
```
    Returns the element node at the specified index of an array node.
    For all other node types, null is returned.
    If index is out of bounds, (i.e. less than zero or >= size(), null is returned; no exception will be thrown.
    If the requested element has been explicitly set to null, implementors may return a special "null node" instead of null.
    
    Parameters:
    
    index - the element index to fetch.
    
    Returns:
    
    a node containing the requested element, or null if it does not exist.

Interface Node

Method Summary

Method Detail

isNull

isObject

isArray

isValue

fieldNames

size

asInt

asBoolean

asLong

asDouble

asString

asMap

as

as

get

get