ObjectGraphNode (DataStax Enterprise Java Driver - Binary distribution 1.3.0 API)

java.lang.Object
- com.datastax.driver.dse.graph.ObjectGraphNode

All Implemented Interfaces:: GraphNode, Node

public class ObjectGraphNode
extends Object
implements GraphNode

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

Property as
Returns this node as a Property.

VertexProperty asVertex
Returns this node as a VertexProperty.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`Property`	`as` Returns this node as a `Property`.
`VertexProperty`	`asVertex` Returns this node as a `VertexProperty`.

Constructor Summary

Constructors
Constructor and Description

ObjectGraphNode(Object delegate)

Constructors
Constructor and Description
`ObjectGraphNode(Object delegate)`

Method Summary

All Methods Instance Methods Concrete 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.
`Edge`	`asEdge()` Returns this node as an `Edge`.
`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>`.
`Path`	`asPath()` Returns this node as a `Path`.
`Property`	`asProperty()` Returns this node as a `Property`.
`String`	`asString()` Returns a valid String representation of this node, if the node is a simple node (i.e.
`Vertex`	`asVertex()` Returns this node as a `Vertex`.
`VertexProperty`	`asVertexProperty()` Returns this node as a `VertexProperty`.
`boolean`	`equals(Object other)`
`Iterator<String>`	`fieldNames()` Returns all the field names of the current node, if it is an object, or an empty iterator otherwise.
`GraphNode`	`get(int index)` Returns the element node at the specified `index` of an array node.
`GraphNode`	`get(String fieldName)` Returns the value of the specified field of an object node.
`int`	`hashCode()`
`boolean`	`isArray()` Returns whether this node is an array.
`boolean`	`isEdge()` Returns `true` if this node is an edge.
`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.
`boolean`	`isVertex()` Returns `true` if this node is a vertex.
`int`	`size()` Returns the size of the current node, if it is an array, or `0` otherwise.
`String`	`toString()`

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

- Property Detail
  - as
```
public Property asProperty
```
    Specified by:
    
    asProperty in interface GraphNode
  - asVertex
```
public VertexProperty asVertexProperty
```
    Specified by:
    
    asVertexProperty in interface GraphNode
- Constructor Detail
  - ObjectGraphNode
```
public ObjectGraphNode(Object delegate)
```
- Method Detail
  - isNull
```
public boolean isNull()
```
    Description copied from interface: Node
    
    Returns whether this node is null.
    
    Specified by:
    
    isNull in interface Node
    
    Returns:
    
    true if this node is null, false otherwise.
  - isObject
```
public boolean isObject()
```
    Description copied from interface: Node
    
    Returns whether this node is an object.
    Only one method out of Node.isObject(), Node.isArray() and Node.isValue() should ever return true for one given node.
    
    Specified by:
    
    isObject in interface Node
    
    Returns:
    
    true if this node is an object, false otherwise.
  - isArray
```
public boolean isArray()
```
    Description copied from interface: Node
    
    Returns whether this node is an array.
    Only one method out of Node.isObject(), Node.isArray() and Node.isValue() should ever return true for one given node.
    
    Specified by:
    
    isArray in interface Node
    
    Returns:
    
    true if this node is an array, false otherwise.
  - isValue
```
public boolean isValue()
```
    Description copied from interface: Node
    
    Returns whether this node is a simple value, i.e. either a string, a boolean, a number, or null.
    Only one method out of Node.isObject(), Node.isArray() and Node.isValue() should ever return true for one given node.
    
    Specified by:
    
    isValue in interface Node
    
    Returns:
    
    whether this node is a simple value, false otherwise.
  - fieldNames
```
public Iterator<String> fieldNames()
```
    Description copied from interface: Node
    
    Returns all the field names of the current node, if it is an object, or an empty iterator otherwise.
    
    Specified by:
    
    fieldNames in interface Node
    
    Returns:
    
    a Iterator of all the field names of the current node.
  - size
```
public int size()
```
    Description copied from interface: Node
    
    Returns the size of the current node, if it is an array, or 0 otherwise.
    
    Specified by:
    
    size in interface Node
    
    Returns:
    
    the size of the current node f it is an array, or 0 otherwise.
  - asInt
```
public int asInt()
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    asInt in interface Node
    
    Returns:
    
    an integer representation of this node, or 0 if this node can not be converted to an int.
  - asBoolean
```
public boolean asBoolean()
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    asBoolean in interface Node
    
    Returns:
    
    a boolean representation of this node, or false if this node can not be converted to a boolean.
  - asLong
```
public long asLong()
```
    Description copied from interface: Node
    
    Returns this node as a long integer.
    
    Specified by:
    
    asLong in interface Node
    
    Returns:
    
    a long integer representation of this node, or 0L if this node is null.
  - asDouble
```
public double asDouble()
```
    Description copied from interface: Node
    
    Returns this node as a double.
    
    Specified by:
    
    asDouble in interface Node
    
    Returns:
    
    a double representation of this node, or 0.0D if this node is null.
  - asString
```
public String asString()
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    asString in interface Node
    
    Returns:
    
    a String representation of this node, or an empty string, if this node is not a simple node.
  - asMap
```
public Map<String,Object> asMap()
```
    Description copied from interface: Node
    
    Deserializes and returns this node as an instance of Map<String, Object>.
    
    Specified by:
    
    asMap in interface Node
    
    Returns:
    
    this node converted into an instance of Map<String, Object>.
  - as
```
public <T> T as(Class<T> clazz)
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    as in interface Node
    
    Parameters:
    
    clazz - the class to convert this node into.
    
    Returns:
    
    this node converted into an instance of clazz.
  - as
```
public <T> T as(TypeToken<T> type)
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    as in interface Node
    
    Parameters:
    
    type - the type to convert this node into.
    
    Returns:
    
    this node converted into an instance of type.
  - get
```
public GraphNode get(String fieldName)
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    get in interface GraphNode
    
    Specified by:
    
    get in interface Node
    
    Parameters:
    
    fieldName - the field name to fetch.
    
    Returns:
    
    a node containing the requested field value, or null if it does not exist.
  - get
```
public GraphNode get(int index)
```
    Description copied from interface: Node
    
    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.
    
    Specified by:
    
    get in interface GraphNode
    
    Specified by:
    
    get in interface Node
    
    Parameters:
    
    index - the element index to fetch.
    
    Returns:
    
    a node containing the requested element, or null if it does not exist.
  - isVertex
```
public boolean isVertex()
```
    Description copied from interface: GraphNode
    
    Returns true if this node is a vertex. If this node is a vertex, then GraphNode.asVertex() can be safely called.
    
    Specified by:
    
    isVertex in interface GraphNode
    
    Returns:
    
    true if this node is a vertex, false otherwise.
  - isEdge
```
public boolean isEdge()
```
    Description copied from interface: GraphNode
    
    Returns true if this node is an edge. If this node is an edge, then GraphNode.asEdge() can be safely called.
    
    Specified by:
    
    isEdge in interface GraphNode
    
    Returns:
    
    true if this node is an edge, false otherwise.
  - asVertex
```
public Vertex asVertex()
```
    Description copied from interface: GraphNode
    
    Returns this node as a Vertex.
    
    Specified by:
    
    asVertex in interface GraphNode
    
    Returns:
    
    a Vertex representation of this node.
  - asEdge
```
public Edge asEdge()
```
    Description copied from interface: GraphNode
    
    Returns this node as an Edge.
    
    Specified by:
    
    asEdge in interface GraphNode
    
    Returns:
    
    an Edge representation of this node.
  - asPath
```
public Path asPath()
```
    Description copied from interface: GraphNode
    
    Returns this node as a Path.
    
    Specified by:
    
    asPath in interface GraphNode
    
    Returns:
    
    a Path representation of this node.
  - asProperty
```
public Property asProperty()
```
    Description copied from interface: GraphNode
    
    Returns this node as a Property.
    
    Specified by:
    
    asProperty in interface GraphNode
  - asVertexProperty
```
public VertexProperty asVertexProperty()
```
    Description copied from interface: GraphNode
    
    Returns this node as a VertexProperty.
    
    Specified by:
    
    asVertexProperty in interface GraphNode
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ObjectGraphNode

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

as

asVertex

Constructor Detail

ObjectGraphNode

Method Detail

isNull

isObject

isArray

isValue

fieldNames

size

asInt

asBoolean

asLong

asDouble

asString

asMap

as

as

get

get

isVertex

isEdge

asVertex

asEdge

asPath

asProperty

asVertexProperty

toString

equals

hashCode