GettableByNameData (DataStax Java Driver for Apache Cassandra

All Known Subinterfaces:

GettableData, Row

All Known Implementing Classes:

AbstractGettableData, BoundStatement, UDTValue
```
public interface GettableByNameData
```
Collection of (typed) CQL values that can be retrieved by name.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBool(String name)` Returns the value for `name` as a boolean.
`ByteBuffer`	`getBytes(String name)` Returns the value for `name` as a byte array.
`ByteBuffer`	`getBytesUnsafe(String name)` Returns the value for `name` as a ByteBuffer.
`Date`	`getDate(String name)` Returns the value for `name` as a date.
`BigDecimal`	`getDecimal(String name)` Returns the value for `name` as a variable length decimal.
`double`	`getDouble(String name)` Returns the value for `name` as a double.
`float`	`getFloat(String name)` Returns the value for `name` as a float.
`InetAddress`	`getInet(String name)` Returns the value for `name` as an InetAddress.
`int`	`getInt(String name)` Returns the value for `name` as an integer.
`<T> List<T>`	`getList(String name, Class<T> elementsClass)` Returns the value for `name` as a list.
`long`	`getLong(String name)` Returns the value for `name` as a long.
`<K,V> Map<K,V>`	`getMap(String name, Class<K> keysClass, Class<V> valuesClass)` Returns the value for `name` as a map.
`<T> Set<T>`	`getSet(String name, Class<T> elementsClass)` Returns the value for `name` as a set.
`String`	`getString(String name)` Returns the value for `name` as a string.
`TupleValue`	`getTupleValue(String name)` Return the value for `name` as a tuple value.
`UDTValue`	`getUDTValue(String name)` Return the value for `name` as a UDT value.
`UUID`	`getUUID(String name)` Returns the value for `name` as a UUID.
`BigInteger`	`getVarint(String name)` Returns the value for `name` as a variable length integer.
`boolean`	`isNull(String name)` Returns whether the value for `name` is NULL.

- Method Detail
  - isNull
```
boolean isNull(String name)
```
    Returns whether the value for name is NULL.
    
    Parameters:
    name - the name to check.
    
    Returns:
    whether the value for name is NULL.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
  - getBool
```
boolean getBool(String name)
```
    Returns the value for name as a boolean.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the boolean value for name. If the value is NULL, false is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type BOOLEAN.
  - getInt
```
int getInt(String name)
```
    Returns the value for name as an integer.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as an integer. If the value is NULL, 0 is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type INT.
  - getLong
```
long getLong(String name)
```
    Returns the value for name as a long.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a long. If the value is NULL, 0L is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value i is not of type BIGINT or COUNTER.
  - getDate
```
Date getDate(String name)
```
    Returns the value for name as a date.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a date. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type TIMESTAMP.
  - getFloat
```
float getFloat(String name)
```
    Returns the value for name as a float.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a float. If the value is NULL, 0.0f is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type FLOAT.
  - getDouble
```
double getDouble(String name)
```
    Returns the value for name as a double.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a double. If the value is NULL, 0.0 is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type DOUBLE.
  - getBytesUnsafe
```
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.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a ByteBuffer. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
  - getBytes
```
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 getBytesUnsafe(String) instead.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a byte array. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value i type is not of type BLOB.
  - getString
```
String getString(String name)
```
    Returns the value for name as a string.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a string. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name type is none of: VARCHAR, TEXT or ASCII.
  - getVarint
```
BigInteger getVarint(String name)
```
    Returns the value for name as a variable length integer.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a variable length integer. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type VARINT.
  - getDecimal
```
BigDecimal getDecimal(String name)
```
    Returns the value for name as a variable length decimal.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a variable length decimal. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type DECIMAL.
  - getUUID
```
UUID getUUID(String name)
```
    Returns the value for name as a UUID.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as a UUID. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type UUID or TIMEUUID.
  - getInet
```
InetAddress getInet(String name)
```
    Returns the value for name as an InetAddress.
    
    Parameters:
    name - the name to retrieve.
    
    Returns:
    the value for name as an InetAddress. If the value is NULL, null is returned.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not of type INET.
  - getList
```
<T> List<T> getList(String name,
                  Class<T> elementsClass)
```
    Returns the value for name as a list.
    
    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.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not a list or if its elements are not of class elementsClass.
  - getSet
```
<T> Set<T> getSet(String name,
                Class<T> elementsClass)
```
    Returns the value for name as a set.
    
    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.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not a set or if its elements are not of class elementsClass.
  - getMap
```
<K,V> Map<K,V> getMap(String name,
                    Class<K> keysClass,
                    Class<V> valuesClass)
```
    Returns the value for name as a map.
    
    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.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value name is not a map, if its keys are not of class keysClass or if its values are not of class valuesClass.
  - getUDTValue
```
UDTValue getUDTValue(String name)
```
    Return the value for name as a UDT value.
    
    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.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value i is not a UDT value.
  - getTupleValue
```
TupleValue getTupleValue(String name)
```
    Return the value for name as a tuple value.
    
    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.
    
    Throws:
    
    IllegalArgumentException - if name is not valid name for this object.
    
    InvalidTypeException - if value i is not a tuple value.

Interface GettableByNameData

Method Summary

Method Detail

isNull

getBool

getInt

getLong

getDate

getFloat

getDouble

getBytesUnsafe

getBytes

getString

getVarint

getDecimal

getUUID

getInet

getList

getSet

getMap

getUDTValue

getTupleValue