AbstractGettableData (DataStax Java Driver for Apache Cassandra

java.lang.Object
- com.datastax.driver.core.AbstractGettableData

All Implemented Interfaces:

GettableByIndexData, GettableByNameData, GettableData

Direct Known Subclasses:

UDTValue
```
public abstract class AbstractGettableData
extends Object
implements GettableData
```

Field Summary

Fields
Modifier and Type Field and Description

protected ProtocolVersion protocolVersion

Fields
Modifier and Type	Field and Description
`protected ProtocolVersion`	`protocolVersion`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractGettableData(int protocolVersion)` Deprecated. This constructor is provided for backward compatibility, use `AbstractGettableData(ProtocolVersion)` instead.
`protected`	`AbstractGettableData(ProtocolVersion protocolVersion)` Creates a new AbstractGettableData object.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkType(int i, DataType.Name name)`
`protected DataType.Name`	`checkType(int i, DataType.Name name1, DataType.Name name2)`
`protected DataType.Name`	`checkType(int i, DataType.Name name1, DataType.Name name2, DataType.Name name3)`
`boolean`	`getBool(int i)` Returns the `i`th value as a boolean.
`boolean`	`getBool(String name)` Returns the value for `name` as a boolean.
`ByteBuffer`	`getBytes(int i)` Returns the `i`th value as a byte array.
`ByteBuffer`	`getBytes(String name)` Returns the value for `name` as a byte array.
`ByteBuffer`	`getBytesUnsafe(int i)` Returns the `i`th value as a ByteBuffer.
`ByteBuffer`	`getBytesUnsafe(String name)` Returns the value for `name` as a ByteBuffer.
`Date`	`getDate(int i)` Returns the `i`th value as a date.
`Date`	`getDate(String name)` Returns the value for `name` as a date.
`BigDecimal`	`getDecimal(int i)` Returns the `i`th value as a variable length decimal.
`BigDecimal`	`getDecimal(String name)` Returns the value for `name` as a variable length decimal.
`double`	`getDouble(int i)` Returns the `i`th value as a double.
`double`	`getDouble(String name)` Returns the value for `name` as a double.
`float`	`getFloat(int i)` Returns the `i`th value as a float.
`float`	`getFloat(String name)` Returns the value for `name` as a float.
`protected abstract int`	`getIndexOf(String name)` Returns the index corresponding to a given name.
`InetAddress`	`getInet(int i)` Returns the `i`th value as an InetAddress.
`InetAddress`	`getInet(String name)` Returns the value for `name` as an InetAddress.
`int`	`getInt(int i)` Returns the `i`th value as an integer.
`int`	`getInt(String name)` Returns the value for `name` as an integer.
`<T> List<T>`	`getList(int i, Class<T> elementsClass)` Returns the `i`th value as a list.
`<T> List<T>`	`getList(String name, Class<T> elementsClass)` Returns the value for `name` as a list.
`long`	`getLong(int i)` Returns the `i`th value as a long.
`long`	`getLong(String name)` Returns the value for `name` as a long.
`<K,V> Map<K,V>`	`getMap(int i, Class<K> keysClass, Class<V> valuesClass)` Returns the `i`th value as a map.
`<K,V> Map<K,V>`	`getMap(String name, Class<K> keysClass, Class<V> valuesClass)` Returns the value for `name` as a map.
`protected abstract String`	`getName(int i)` Returns the name corresponding to the value at index `i`.
`<T> Set<T>`	`getSet(int i, Class<T> elementsClass)` Returns the `i`th value as a set.
`<T> Set<T>`	`getSet(String name, Class<T> elementsClass)` Returns the value for `name` as a set.
`String`	`getString(int i)` Returns the `i`th value as a string.
`String`	`getString(String name)` Returns the value for `name` as a string.
`TupleValue`	`getTupleValue(int i)` Return the `i`th value as a tuple value.
`TupleValue`	`getTupleValue(String name)` Return the value for `name` as a tuple value.
`protected abstract DataType`	`getType(int i)` Returns the type for the value at index `i`.
`UDTValue`	`getUDTValue(int i)` Return the `i`th value as a UDT value.
`UDTValue`	`getUDTValue(String name)` Return the value for `name` as a UDT value.
`UUID`	`getUUID(int i)` Returns the `i`th value as a UUID.
`UUID`	`getUUID(String name)` Returns the value for `name` as a UUID.
`protected abstract ByteBuffer`	`getValue(int i)` Returns the value at index `i`.
`BigInteger`	`getVarint(int i)` Returns the `i`th value as a variable length integer.
`BigInteger`	`getVarint(String name)` Returns the value for `name` as a variable length integer.
`boolean`	`isNull(int i)` Returns whether the `i`th value is NULL.
`boolean`	`isNull(String name)` Returns whether the value for `name` is NULL.

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

Methods inherited from interface com.datastax.driver.core.GettableByIndexData
getBool, getBytes, getBytesUnsafe, getDate, getDecimal, getDouble, getFloat, getInet, getInt, getList, getLong, getMap, getSet, getString, getTupleValue, getUDTValue, getUUID, getVarint, isNull

- Field Detail
  - protocolVersion
```
protected final ProtocolVersion protocolVersion
```
- Constructor Detail
  - AbstractGettableData
```
protected AbstractGettableData(ProtocolVersion protocolVersion)
```
    Creates a new AbstractGettableData object.
    
    Parameters:
    protocolVersion - the protocol version in which values returned by getValue(int) will be returned. This must be a protocol version supported by this driver. In general, the correct value will be the value returned by ProtocolOptions.getProtocolVersion().
    
    Throws:
    
    IllegalArgumentException - if protocolVersion is not a valid protocol version.
  - AbstractGettableData
```
@Deprecated
protected AbstractGettableData(int protocolVersion)
```
    Deprecated. This constructor is provided for backward compatibility, use AbstractGettableData(ProtocolVersion) instead.
    
    Throws:
    
    IllegalArgumentException - if protocolVersion does not correspond to any known version.
- Method Detail
  - getIndexOf
```
protected abstract int getIndexOf(String name)
```
    Returns the index corresponding to a given name.
    
    Parameters:
    name - the name for which to return the index of.
    
    Returns:
    the index for the value coressponding to name.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
  - isNull
```
public boolean isNull(String name)
```
    Returns whether the value for name is NULL.
    
    Specified by:
    
    isNull in interface GettableByNameData
    
    Parameters:
    name - the name to check.
    
    Returns:
    whether the value for name is NULL.
  - getBool
```
public boolean getBool(String name)
```
    Returns the value for name as a boolean.
    
    Specified by:
    
    getBool in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the boolean value for name. If the value is NULL, false is returned.
  - getInt
```
public int getInt(String name)
```
    Returns the value for name as an integer.
    
    Specified by:
    
    getInt in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as an integer. If the value is NULL, 0 is returned.
  - getLong
```
public long getLong(String name)
```
    Returns the value for name as a long.
    
    Specified by:
    
    getLong in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a long. If the value is NULL, 0L is returned.
  - getDate
```
public Date getDate(String name)
```
    Returns the value for name as a date.
    
    Specified by:
    
    getDate in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a date. If the value is NULL, null is returned.
  - getFloat
```
public float getFloat(String name)
```
    Returns the value for name as a float.
    
    Specified by:
    
    getFloat in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a float. If the value is NULL, 0.0f is returned.
  - getDouble
```
public double getDouble(String name)
```
    Returns the value for name as a double.
    
    Specified by:
    
    getDouble in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a double. If the value is NULL, 0.0 is returned.
  - getBytesUnsafe
```
public ByteBuffer getBytesUnsafe(String name)
```
    Returns the value for name as a ByteBuffer. Note: this method always return the bytes composing the value, even if the column is not of type BLOB. That is, this method never throw an InvalidTypeException. However, if the type is not BLOB, it is up to the caller to handle the returned value correctly.
    
    Specified by:
    
    getBytesUnsafe in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a ByteBuffer. If the value is NULL, null is returned.
  - getBytes
```
public ByteBuffer getBytes(String name)
```
    Returns the value for name as a byte array.
    Note that this method validate that the column is of type BLOB. If you want to retrieve the bytes for any type, use GettableByNameData.getBytesUnsafe(String) instead.
    
    Specified by:
    
    getBytes in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a byte array. If the value is NULL, null is returned.
  - getString
```
public String getString(String name)
```
    Returns the value for name as a string.
    
    Specified by:
    
    getString in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a string. If the value is NULL, null is returned.
  - getVarint
```
public BigInteger getVarint(String name)
```
    Returns the value for name as a variable length integer.
    
    Specified by:
    
    getVarint in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a variable length integer. If the value is NULL, null is returned.
  - getDecimal
```
public BigDecimal getDecimal(String name)
```
    Returns the value for name as a variable length decimal.
    
    Specified by:
    
    getDecimal in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a variable length decimal. If the value is NULL, null is returned.
  - getUUID
```
public UUID getUUID(String name)
```
    Returns the value for name as a UUID.
    
    Specified by:
    
    getUUID in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a UUID. If the value is NULL, null is returned.
  - getInet
```
public InetAddress getInet(String name)
```
    Returns the value for name as an InetAddress.
    
    Specified by:
    
    getInet in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as an InetAddress. If the value is NULL, null is returned.
  - getList
```
public <T> List<T> getList(String name,
                  Class<T> elementsClass)
```
    Returns the value for name as a list.
    
    Specified by:
    
    getList in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    elementsClass - the class for the elements of the list to retrieve.
    
    Returns:
    the value of the ith element as a list of elementsClass objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.
  - getSet
```
public <T> Set<T> getSet(String name,
                Class<T> elementsClass)
```
    Returns the value for name as a set.
    
    Specified by:
    
    getSet in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    elementsClass - the class for the elements of the set to retrieve.
    
    Returns:
    the value of the ith element as a set of elementsClass objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.
  - getMap
```
public <K,V> Map<K,V> getMap(String name,
                    Class<K> keysClass,
                    Class<V> valuesClass)
```
    Returns the value for name as a map.
    
    Specified by:
    
    getMap in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    keysClass - the class for the keys of the map to retrieve.
    valuesClass - the class for the values of the map to retrieve.
    
    Returns:
    the value of name as a map of keysClass to valuesClass objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.
  - getUDTValue
```
public UDTValue getUDTValue(String name)
```
    Return the value for name as a UDT value.
    
    Specified by:
    
    getUDTValue in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value of name as a UDT value. If the value is NULL, then null will be returned.
  - getTupleValue
```
public TupleValue getTupleValue(String name)
```
    Return the value for name as a tuple value.
    
    Specified by:
    
    getTupleValue in interface GettableByNameData
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value of name as a tuple value. If the value is NULL, then null will be returned.
  - getType
```
protected abstract DataType getType(int i)
```
    Returns the type for the value at index i.
    
    Parameters:
    i - the index of the type to fetch.
    
    Returns:
    the type of the value at index i.
    
    Throws:
    
    IndexOutOfBoundsException - if i is not a valid index.
  - getName
```
protected abstract String getName(int i)
```
    Returns the name corresponding to the value at index i.
    
    Parameters:
    i - the index of the name to fetch.
    
    Returns:
    the name corresponding to the value at index i.
    
    Throws:
    
    IndexOutOfBoundsException - if i is not a valid index.
  - getValue
```
protected abstract ByteBuffer getValue(int i)
```
    Returns the value at index i.
    
    Parameters:
    i - the index to fetch.
    
    Returns:
    the value at index i.
    
    Throws:
    
    IndexOutOfBoundsException - if i is not a valid index.
  - checkType
```
protected void checkType(int i,
             DataType.Name name)
```
  - checkType
```
protected DataType.Name checkType(int i,
                      DataType.Name name1,
                      DataType.Name name2)
```
  - checkType
```
protected DataType.Name checkType(int i,
                      DataType.Name name1,
                      DataType.Name name2,
                      DataType.Name name3)
```
  - isNull
```
public boolean isNull(int i)
```
    Returns whether the ith value is NULL.
    
    Specified by:
    
    isNull in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) of the value to check.
    
    Returns:
    whether the ith value is NULL.
  - getBool
```
public boolean getBool(int i)
```
    Returns the ith value as a boolean.
    
    Specified by:
    
    getBool in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the boolean value of the ith element. If the value is NULL, false is returned.
  - getInt
```
public int getInt(int i)
```
    Returns the ith value as an integer.
    
    Specified by:
    
    getInt in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as an integer. If the value is NULL, 0 is returned.
  - getLong
```
public long getLong(int i)
```
    Returns the ith value as a long.
    
    Specified by:
    
    getLong in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a long. If the value is NULL, 0L is returned.
  - getDate
```
public Date getDate(int i)
```
    Returns the ith value as a date.
    
    Specified by:
    
    getDate in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a data. If the value is NULL, null is returned.
  - getFloat
```
public float getFloat(int i)
```
    Returns the ith value as a float.
    
    Specified by:
    
    getFloat in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a float. If the value is NULL, 0.0f is returned.
  - getDouble
```
public double getDouble(int i)
```
    Returns the ith value as a double.
    
    Specified by:
    
    getDouble in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a double. If the value is NULL, 0.0 is returned.
  - getBytesUnsafe
```
public ByteBuffer getBytesUnsafe(int i)
```
    Returns the ith value as a ByteBuffer. Note: this method always return the bytes composing the value, even if the column is not of type BLOB. That is, this method never throw an InvalidTypeException. However, if the type is not BLOB, it is up to the caller to handle the returned value correctly.
    
    Specified by:
    
    getBytesUnsafe in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a ByteBuffer. If the value is NULL, null is returned.
  - getBytes
```
public ByteBuffer getBytes(int i)
```
    Returns the ith value as a byte array.
    Note that this method validate that the column is of type BLOB. If you want to retrieve the bytes for any type, use GettableByIndexData.getBytesUnsafe(int) instead.
    
    Specified by:
    
    getBytes in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a byte array. If the value is NULL, null is returned.
  - getString
```
public String getString(int i)
```
    Returns the ith value as a string.
    
    Specified by:
    
    getString in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a string. If the value is NULL, null is returned.
  - getVarint
```
public BigInteger getVarint(int i)
```
    Returns the ith value as a variable length integer.
    
    Specified by:
    
    getVarint in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a variable length integer. If the value is NULL, null is returned.
  - getDecimal
```
public BigDecimal getDecimal(int i)
```
    Returns the ith value as a variable length decimal.
    
    Specified by:
    
    getDecimal in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a variable length decimal. If the value is NULL, null is returned.
  - getUUID
```
public UUID getUUID(int i)
```
    Returns the ith value as a UUID.
    
    Specified by:
    
    getUUID in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a UUID. If the value is NULL, null is returned.
  - getInet
```
public InetAddress getInet(int i)
```
    Returns the ith value as an InetAddress.
    
    Specified by:
    
    getInet in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as an InetAddress. If the value is NULL, null is returned.
  - getList
```
public <T> List<T> getList(int i,
                  Class<T> elementsClass)
```
    Returns the ith value as a list.
    
    Specified by:
    
    getList in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    elementsClass - the class for the elements of the list to retrieve.
    
    Returns:
    the value of the ith element as a list of elementsClass objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.
  - getSet
```
public <T> Set<T> getSet(int i,
                Class<T> elementsClass)
```
    Returns the ith value as a set.
    
    Specified by:
    
    getSet in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    elementsClass - the class for the elements of the set to retrieve.
    
    Returns:
    the value of the ith element as a set of elementsClass objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.
  - getMap
```
public <K,V> Map<K,V> getMap(int i,
                    Class<K> keysClass,
                    Class<V> valuesClass)
```
    Returns the ith value as a map.
    
    Specified by:
    
    getMap in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    keysClass - the class for the keys of the map to retrieve.
    valuesClass - the class for the values of the map to retrieve.
    
    Returns:
    the value of the ith element as a map of keysClass to valuesClass objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.
  - getUDTValue
```
public UDTValue getUDTValue(int i)
```
    Return the ith value as a UDT value.
    
    Specified by:
    
    getUDTValue in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a UDT value. If the value is NULL, then null will be returned.
  - getTupleValue
```
public TupleValue getTupleValue(int i)
```
    Return the ith value as a tuple value.
    
    Specified by:
    
    getTupleValue in interface GettableByIndexData
    
    Parameters:
    i - the index (0 <= i < size()) to retrieve.
    
    Returns:
    the value of the ith element as a tuple value. If the value is NULL, then null will be returned.

Class AbstractGettableData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.datastax.driver.core.GettableByIndexData

Field Detail

protocolVersion

Constructor Detail

AbstractGettableData

AbstractGettableData

Method Detail

getIndexOf

isNull

getBool

getInt

getLong

getDate

getFloat

getDouble

getBytesUnsafe

getBytes

getString

getVarint

getDecimal

getUUID

getInet

getList

getSet

getMap

getUDTValue

getTupleValue

getType

getName

getValue

checkType

checkType

checkType

isNull

getBool

getInt

getLong

getDate

getFloat

getDouble

getBytesUnsafe

getBytes

getString

getVarint

getDecimal

getUUID

getInet

getList

getSet

getMap

getUDTValue

getTupleValue