public interface GettableByNameData
Modifier and Type | Method and Description |
---|---|
<T> T |
get(String name,
Class<T> targetClass)
Returns the value for
name converted to the given Java type. |
<T> T |
get(String name,
TypeCodec<T> codec)
Returns the value for
name converted using the given TypeCodec . |
<T> T |
get(String name,
TypeToken<T> targetType)
Returns the value for
name converted to the given Java type. |
boolean |
getBool(String name)
Returns the value for
name as a boolean. |
byte |
getByte(String name)
Returns the value for
name as a byte. |
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. |
LocalDate |
getDate(String name)
Returns the value for
name as a date (without time). |
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. |
<T> List<T> |
getList(String name,
TypeToken<T> elementsType)
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. |
<K,V> Map<K,V> |
getMap(String name,
TypeToken<K> keysType,
TypeToken<V> valuesType)
Returns the value for
name as a map. |
Object |
getObject(String name)
Returns the value for
name as the Java type matching its CQL type. |
<T> Set<T> |
getSet(String name,
Class<T> elementsClass)
Returns the value for
name as a set. |
<T> Set<T> |
getSet(String name,
TypeToken<T> elementsType)
Returns the value for
name as a set. |
short |
getShort(String name)
Returns the value for
name as a short. |
String |
getString(String name)
Returns the value for
name as a string. |
long |
getTime(String name)
Returns the value for
name as a long in nanoseconds since midnight. |
Date |
getTimestamp(String name)
Returns the value for
name as a date. |
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. |
boolean isNull(String name)
name
is NULL.name
- the name to check.name
is NULL.IllegalArgumentException
- if name
is not valid name for this object.boolean getBool(String name)
name
as a boolean.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java boolean
(for CQL type boolean
, this will be the built-in codec).
name
- the name to retrieve.name
. If the value is NULL, false
is returned. If
you need to distinguish NULL and false values, check first with isNull(String)
or
use get(name, Boolean.class)
.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a boolean.byte getByte(String name)
name
as a byte.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java byte
(for CQL type tinyint
, this will be the built-in codec).
name
- the name to retrieve.name
as a byte. If the value is NULL, 0
is returned. If
you need to distinguish NULL and 0, check first with isNull(String)
or use get(name, Byte.class)
. 0
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a byte.short getShort(String name)
name
as a short.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java short
(for CQL type smallint
, this will be the built-in codec).
name
- the name to retrieve.name
as a short. If the value is NULL, 0
is returned. If
you need to distinguish NULL and 0, check first with isNull(String)
or use get(name, Short.class)
. 0
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a short.int getInt(String name)
name
as an integer.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java int
(for CQL type int
, this will be the built-in codec).
name
- the name to retrieve.name
as an integer. If the value is NULL, 0
is returned.
If you need to distinguish NULL and 0, check first with isNull(String)
or use
get(name, Integer.class)
. 0
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to an int.long getLong(String name)
name
as a long.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java byte
(for CQL types bigint
and counter
, this will be the
built-in codec).
name
- the name to retrieve.name
as a long. If the value is NULL, 0L
is returned. If
you need to distinguish NULL and 0L, check first with isNull(String)
or use get(name, Long.class)
.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a long.Date getTimestamp(String name)
name
as a date.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Date
(for CQL type timestamp
, this will be the built-in codec).
name
- the name to retrieve.name
as a date. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a Date
.LocalDate getDate(String name)
name
as a date (without time).
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a LocalDate
(for CQL type date
, this will be the built-in codec).
name
- the name to retrieve.name
as a date. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a LocalDate
.long getTime(String name)
name
as a long in nanoseconds since midnight.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java long
(for CQL type time
, this will be the built-in codec).
name
- the name to retrieve.name
as a long. If the value is NULL, 0L
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a long.float getFloat(String name)
name
as a float.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java float
(for CQL type float
, this will be the built-in codec).
name
- the name to retrieve.name
as a float. If the value is NULL, 0.0f
is returned.
If you need to distinguish NULL and 0.0f, check first with isNull(String)
or use
get(name, Float.class)
.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a float.double getDouble(String name)
name
as a double.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java double
(for CQL type double
, this will be the built-in codec).
name
- the name to retrieve.name
as a double. If the value is NULL, 0.0
is returned.
If you need to distinguish NULL and 0.0, check first with isNull(String)
or use
get(name, Double.class)
.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a double.ByteBuffer getBytesUnsafe(String name)
name
as a ByteBuffer.
This method does not use any codec; it returns a copy of the binary representation of the value. It is up to the caller to convert the returned value appropriately.
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.
name
- the name to retrieve.name
as a ByteBuffer. If the value is NULL, null
is
returned.IllegalArgumentException
- if name
is not valid name for this object.ByteBuffer getBytes(String name)
name
as a byte array.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java ByteBuffer
(for CQL type blob
, this will be the built-in codec).
name
- the name to retrieve.name
as a byte array. If the value is NULL, null
is
returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a ByteBuffer
.String getString(String name)
name
as a string.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a Java string (for CQL types text
, varchar
and ascii
, this will
be the built-in codec).
name
- the name to retrieve.name
as a string. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a string.BigInteger getVarint(String name)
name
as a variable length integer.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a BigInteger
(for CQL type varint
, this will be the built-in codec).
name
- the name to retrieve.name
as a variable length integer. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a BigInteger
.BigDecimal getDecimal(String name)
name
as a variable length decimal.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a BigDecimal
(for CQL type decimal
, this will be the built-in codec).
name
- the name to retrieve.name
as a variable length decimal. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a BigDecimal
.UUID getUUID(String name)
name
as a UUID.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a UUID
(for CQL types uuid
and timeuuid
, this will be the
built-in codec).
name
- the name to retrieve.name
as a UUID. If the value is NULL, null
is returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a UUID
.InetAddress getInet(String name)
name
as an InetAddress.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to an InetAddress
(for CQL type inet
, this will be the built-in codec).
name
- the name to retrieve.name
as an InetAddress. If the value is NULL, null
is
returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a InetAddress
.<T> List<T> getList(String name, Class<T> elementsClass)
name
as a list.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a list of the specified type.
If the type of the elements is generic, use getList(String, TypeToken)
.
Implementation note: the actual List
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
name
- the name to retrieve.elementsClass
- the class for the elements of the list to retrieve.i
th element as a list of T
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a list.<T> List<T> getList(String name, TypeToken<T> elementsType)
name
as a list.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a list of the specified type.
Use this variant with nested collections, which produce a generic element type:
List<List<String>> l = row.getList("theColumn", new TypeToken<List<String>>() {});
Implementation note: the actual List
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
name
- the name to retrieve.elementsType
- the type for the elements of the list to retrieve.i
th element as a list of T
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a list.<T> Set<T> getSet(String name, Class<T> elementsClass)
name
as a set.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a set of the specified type.
If the type of the elements is generic, use getSet(String, TypeToken)
.
Implementation note: the actual Set
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
name
- the name to retrieve.elementsClass
- the class for the elements of the set to retrieve.i
th element as a set of T
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a set.<T> Set<T> getSet(String name, TypeToken<T> elementsType)
name
as a set.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a set of the specified type.
Use this variant with nested collections, which produce a generic element type:
Set<List<String>> l = row.getSet("theColumn", new TypeToken<List<String>>() {});
Implementation note: the actual Set
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
name
- the name to retrieve.elementsType
- the type for the elements of the set to retrieve.i
th element as a set of T
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a set.<K,V> Map<K,V> getMap(String name, Class<K> keysClass, Class<V> valuesClass)
name
as a map.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a map of the specified types.
If the type of the keys and/or values is generic, use getMap(String, TypeToken,
TypeToken)
.
Implementation note: the actual Map
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
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.name
as a map of K
to V
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a map.<K,V> Map<K,V> getMap(String name, TypeToken<K> keysType, TypeToken<V> valuesType)
name
as a map.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a map of the specified types.
Use this variant with nested collections, which produce a generic element type:
Map<Int, List<String>> l = row.getMap("theColumn", TypeToken.of(Integer.class), new TypeToken<List<String>>() {});
Implementation note: the actual Map
implementation will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent. By default, the driver will return mutable
instances, and a CQL NULL
will mapped to an empty collection (note that Cassandra makes
no distinction between NULL
and an empty collection).
name
- the name to retrieve.keysType
- the class for the keys of the map to retrieve.valuesType
- the class for the values of the map to retrieve.name
as a map of K
to V
objects.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a map.UDTValue getUDTValue(String name)
name
as a UDT value.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a UDTValue
(if the CQL type is a UDT, the registry will generate a codec
automatically).
name
- the name to retrieve.name
as a UDT value. If the value is NULL, then null
will
be returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a UDTValue
.TupleValue getTupleValue(String name)
name
as a tuple value.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to a TupleValue
(if the CQL type is a tuple, the registry will generate a codec
automatically).
name
- the name to retrieve.name
as a tuple value. If the value is NULL, then null
will be returned.IllegalArgumentException
- if name
is not valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to a TupleValue
.Object getObject(String name)
name
as the Java type matching its CQL type.
This method uses the CodecRegistry
to find the first codec that handles the
underlying CQL type. The Java type of the returned object will be determined by the codec that
was selected.
Use this method to dynamically inspect elements when types aren't known in advance, for
instance if you're writing a generic row logger. If you know the target Java type, it is
generally preferable to use typed getters, such as the ones for built-in types (getBool(String)
, getInt(String)
, etc.), or get(String, Class)
and get(String, TypeToken)
for custom types.
name
- the name to retrieve.name
as the Java type matching its CQL type. If the value is NULL
and is a simple type, UDT or tuple, null
is returned. If it is NULL and is a
collection type, an empty (immutable) collection is returned.IllegalArgumentException
- if name
is not a valid name for this object.CodecRegistry.codecFor(DataType)
<T> T get(String name, Class<T> targetClass)
name
converted to the given Java type.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to the given Java type.
If the target type is generic, use get(String, TypeToken)
.
Implementation note: the actual object returned by this method will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent; by default, a CQL NULL
value translates to
null
for simple CQL types, UDTs and tuples, and to empty collections for all CQL
collection types.
name
- the name to retrieve.targetClass
- The Java type the value should be converted to.name
value converted to the given Java type.IllegalArgumentException
- if name
is not a valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to targetClass
.<T> T get(String name, TypeToken<T> targetType)
name
converted to the given Java type.
This method uses the CodecRegistry
to find a codec to convert the underlying CQL
type to the given Java type.
Implementation note: the actual object returned by this method will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent; by default, a CQL NULL
value translates to
null
for simple CQL types, UDTs and tuples, and to empty collections for all CQL
collection types.
name
- the name to retrieve.targetType
- The Java type the value should be converted to.name
value converted to the given Java type.IllegalArgumentException
- if name
is not a valid name for this object.CodecNotFoundException
- if there is no registered codec to convert the underlying CQL
type to targetType
.<T> T get(String name, TypeCodec<T> codec)
name
converted using the given TypeCodec
.
This method entirely bypasses the CodecRegistry
and forces the driver to use the
given codec instead. This can be useful if the codec would collide with a previously registered
one, or if you want to use the codec just once without registering it.
It is the caller's responsibility to ensure that the given codec accepts
the underlying CQL type; failing to do so may result in
InvalidTypeException
s being thrown.
Implementation note: the actual object returned by this method will depend on the codec
being used; therefore, callers should make no assumptions concerning its
mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
NULL
values is also codec-dependent; by default, a CQL NULL
value translates to
null
for simple CQL types, UDTs and tuples, and to empty collections for all CQL
collection types.
name
- the name to retrieve.codec
- The TypeCodec
to use to deserialize the value; may not be null
.i
th value converted using the given TypeCodec
.InvalidTypeException
- if the given codec does not accept
the underlying CQL type.IndexOutOfBoundsException
- if i
is not a valid index for this object.Copyright © 2012–2019. All rights reserved.