Class TupleValue
- java.lang.Object
-
- org.apache.cassandra.cql3.functions.types.TupleValue
-
- All Implemented Interfaces:
GettableByIndexData
,SettableByIndexData<TupleValue>
public class TupleValue extends java.lang.Object
A value for a Tuple.
-
-
Field Summary
Fields Modifier and Type Field Description protected ProtocolVersion
protocolVersion
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected <T> TypeCodec<T>
codecFor(int i)
protected <T> TypeCodec<T>
codecFor(int i, com.google.common.reflect.TypeToken<T> javaType)
protected <T> TypeCodec<T>
codecFor(int i, java.lang.Class<T> javaClass)
protected <T> TypeCodec<T>
codecFor(int i, T value)
boolean
equals(java.lang.Object o)
<T> T
get(int i, com.google.common.reflect.TypeToken<T> targetType)
Returns thei
th value converted to the given Java type.<T> T
get(int i, java.lang.Class<T> targetClass)
Returns thei
th value converted to the given Java type.<T> T
get(int i, TypeCodec<T> codec)
Returns thei
th value converted using the givenTypeCodec
.boolean
getBool(int i)
Returns thei
th value as a boolean.byte
getByte(int i)
Returns thei
th value as a byte.java.nio.ByteBuffer
getBytes(int i)
Returns thei
th value as a byte array.java.nio.ByteBuffer
getBytesUnsafe(int i)
Returns thei
th value as aByteBuffer
.protected CodecRegistry
getCodecRegistry()
LocalDate
getDate(int i)
Returns thei
th value as a date (without time).java.math.BigDecimal
getDecimal(int i)
Returns thei
th value as a variable length decimal.double
getDouble(int i)
Returns thei
th value as a double.float
getFloat(int i)
Returns thei
th value as a float.java.net.InetAddress
getInet(int i)
Returns thei
th value as an InetAddress.int
getInt(int i)
Returns thei
th value as an integer.<T> java.util.List<T>
getList(int i, com.google.common.reflect.TypeToken<T> elementsType)
Returns thei
th value as a list.<T> java.util.List<T>
getList(int i, java.lang.Class<T> elementsClass)
Returns thei
th value as a list.long
getLong(int i)
Returns thei
th value as a long.<K,V>
java.util.Map<K,V>getMap(int i, com.google.common.reflect.TypeToken<K> keysType, com.google.common.reflect.TypeToken<V> valuesType)
Returns thei
th value as a map.<K,V>
java.util.Map<K,V>getMap(int i, java.lang.Class<K> keysClass, java.lang.Class<V> valuesClass)
Returns thei
th value as a map.protected java.lang.String
getName(int i)
Returns the name corresponding to the value at indexi
.java.lang.Object
getObject(int i)
Returns thei
th value as the Java type matching its CQL type.<T> java.util.Set<T>
getSet(int i, com.google.common.reflect.TypeToken<T> elementsType)
Returns thei
th value as a set.<T> java.util.Set<T>
getSet(int i, java.lang.Class<T> elementsClass)
Returns thei
th value as a set.short
getShort(int i)
Returns thei
th value as a short.java.lang.String
getString(int i)
Returns thei
th value as a string.long
getTime(int i)
Returns thei
th value as a long in nanoseconds since midnight.java.util.Date
getTimestamp(int i)
Returns thei
th value as a date.TupleValue
getTupleValue(int i)
Return thei
th value as a tuple value.TupleType
getType()
The tuple type this is a value of.protected DataType
getType(int i)
Returns the type for the value at indexi
.UDTValue
getUDTValue(int i)
Return thei
th value as a UDT value.java.util.UUID
getUUID(int i)
Returns thei
th value as a UUID.protected java.nio.ByteBuffer
getValue(int i)
Returns the value at indexi
.java.math.BigInteger
getVarint(int i)
Returns thei
th value as a variable length integer.int
hashCode()
boolean
isNull(int i)
Returns whether thei
th value is NULL.<V> T
set(int i, V v, com.google.common.reflect.TypeToken<V> targetType)
Sets thei
th value to the provided value of the provided Java type.<V> T
set(int i, V v, java.lang.Class<V> targetClass)
Sets thei
th value to the provided value of the provided Java class.<V> T
set(int i, V v, TypeCodec<V> codec)
Sets thei
th value to the provided value, converted using the givenTypeCodec
.T
setBool(int i, boolean v)
Sets thei
th value to the provided boolean.T
setByte(int i, byte v)
Set thei
th value to the provided byte.T
setBytes(int i, java.nio.ByteBuffer v)
Sets thei
th value to the provided byte buffer.T
setBytesUnsafe(int i, java.nio.ByteBuffer v)
Sets thei
th value to the provided byte buffer.T
setDate(int i, LocalDate v)
Set thei
th value to the provided date (without time).T
setDecimal(int i, java.math.BigDecimal v)
Sets thei
th value to the provided big decimal.T
setDouble(int i, double v)
Sets thei
th value to the provided double.T
setFloat(int i, float v)
Sets thei
th value to the provided float.T
setInet(int i, java.net.InetAddress v)
Sets thei
th value to the provided inet address.T
setInt(int i, int v)
Set thei
th value to the provided integer.<E> T
setList(int i, java.util.List<E> v)
Sets thei
th value to the provided list.<E> T
setList(int i, java.util.List<E> v, com.google.common.reflect.TypeToken<E> elementsType)
Sets thei
th value to the provided list, which elements are of the provided Java type.<E> T
setList(int i, java.util.List<E> v, java.lang.Class<E> elementsClass)
Sets thei
th value to the provided list, which elements are of the provided Java class.T
setLong(int i, long v)
Sets thei
th value to the provided long.<K,V>
TsetMap(int i, java.util.Map<K,V> v)
Sets thei
th value to the provided map.<K,V>
TsetMap(int i, java.util.Map<K,V> v, com.google.common.reflect.TypeToken<K> keysType, com.google.common.reflect.TypeToken<V> valuesType)
Sets thei
th value to the provided map, which keys and values are of the provided Java types.<K,V>
TsetMap(int i, java.util.Map<K,V> v, java.lang.Class<K> keysClass, java.lang.Class<V> valuesClass)
Sets thei
th value to the provided map, which keys and values are of the provided Java classes.<E> T
setSet(int i, java.util.Set<E> v)
Sets thei
th value to the provided set.<E> T
setSet(int i, java.util.Set<E> v, com.google.common.reflect.TypeToken<E> elementsType)
Sets thei
th value to the provided set, which elements are of the provided Java type.<E> T
setSet(int i, java.util.Set<E> v, java.lang.Class<E> elementsClass)
Sets thei
th value to the provided set, which elements are of the provided Java class.T
setShort(int i, short v)
Set thei
th value to the provided short.T
setString(int i, java.lang.String v)
Sets thei
th value to the provided string.T
setTime(int i, long v)
Set thei
th value to the provided time as a long in nanoseconds since midnight.T
setTimestamp(int i, java.util.Date v)
Set thei
th value to the provided date.T
setToNull(int i)
Sets thei
th value tonull
.T
setTupleValue(int i, TupleValue v)
Sets thei
th value to the provided tuple value.T
setUDTValue(int i, UDTValue v)
Sets thei
th value to the provided UDT value.T
setUUID(int i, java.util.UUID v)
Sets thei
th value to the provided UUID.T
setVarint(int i, java.math.BigInteger v)
Sets thei
th value to the provided big integer.java.lang.String
toString()
-
-
-
Field Detail
-
protocolVersion
protected final ProtocolVersion protocolVersion
-
-
Method Detail
-
getType
protected DataType getType(int i)
Returns the type for the value at indexi
.- Parameters:
i
- the index of the type to fetch.- Returns:
- the type of the value at index
i
.
-
getName
protected java.lang.String getName(int i)
Returns the name corresponding to the value at indexi
.- Parameters:
i
- the index of the name to fetch.- Returns:
- the name corresponding to the value at index
i
.
-
getCodecRegistry
protected CodecRegistry getCodecRegistry()
-
getType
public TupleType getType()
The tuple type this is a value of.- Returns:
- The tuple type this is a value of.
-
equals
public boolean equals(java.lang.Object o)
-
hashCode
public int hashCode()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getValue
protected java.nio.ByteBuffer getValue(int i)
Returns the value at indexi
.- Parameters:
i
- the index to fetch.- Returns:
- the value at index
i
.
-
setBool
public T setBool(int i, boolean v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided boolean.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typeboolean
, this will be the built-in codec).- Specified by:
setBool
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Boolean.class)
- Returns:
- this object.
-
setByte
public T setByte(int i, byte v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided byte.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typetinyint
, this will be the built-in codec).- Specified by:
setByte
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Byte.class)
- Returns:
- this object.
-
setShort
public T setShort(int i, short v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided short.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typesmallint
, this will be the built-in codec).- Specified by:
setShort
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Short.class)
- Returns:
- this object.
-
setInt
public T setInt(int i, int v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided integer.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typeint
, this will be the built-in codec).- Specified by:
setInt
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Integer.class)
- Returns:
- this object.
-
setLong
public T setLong(int i, long v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided long.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typebigint
, this will be the built-in codec).- Specified by:
setLong
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Long.class)
- Returns:
- this object.
-
setTimestamp
public T setTimestamp(int i, java.util.Date v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided date.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typetimestamp
, this will be the built-in codec).- Specified by:
setTimestamp
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setDate
public T setDate(int i, LocalDate v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided date (without time).This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typedate
, this will be the built-in codec).- Specified by:
setDate
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setTime
public T setTime(int i, long v)
Description copied from interface:SettableByIndexData
Set thei
th value to the provided time as a long in nanoseconds since midnight.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typetime
, this will be the built-in codec).- Specified by:
setTime
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setFloat
public T setFloat(int i, float v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided float.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typefloat
, this will be the built-in codec).- Specified by:
setFloat
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Float.class)
- Returns:
- this object.
-
setDouble
public T setDouble(int i, double v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided double.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typedouble
, this will be the built-in codec).- Specified by:
setDouble
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. To set the value to NULL, useSettableByIndexData.setToNull(int)
orset(i, v, Double.class)
.- Returns:
- this object.
-
setString
public T setString(int i, java.lang.String v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided string.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typestext
,varchar
andascii
, this will be the built-in codec).- Specified by:
setString
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setBytes
public T setBytes(int i, java.nio.ByteBuffer v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided byte buffer.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typeblob
, this will be the built-in codec).- Specified by:
setBytes
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setBytesUnsafe
public T setBytesUnsafe(int i, java.nio.ByteBuffer v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided byte buffer.This method does not use any codec; it sets the value in its binary form directly. If you insert data that is not compatible with the underlying CQL type, you will get an
InvalidQueryException
at execute time.- Specified by:
setBytesUnsafe
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setVarint
public T setVarint(int i, java.math.BigInteger v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided big integer.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typevarint
, this will be the built-in codec).- Specified by:
setVarint
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setDecimal
public T setDecimal(int i, java.math.BigDecimal v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided big decimal.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typedecimal
, this will be the built-in codec).- Specified by:
setDecimal
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setUUID
public T setUUID(int i, java.util.UUID v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided UUID.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typesuuid
andtimeuuid
, this will be the built-in codec).- Specified by:
setUUID
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setInet
public T setInet(int i, java.net.InetAddress v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided inet address.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (for CQL typeinet
, this will be the built-in codec).- Specified by:
setInet
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setList
public <E> T setList(int i, java.util.List<E> v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided list.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (the type of the elements in the Java list is not considered). If two or more codecs target that CQL type, the one that was first registered will be used. For this reason, it is generally preferable to use the more deterministic methodsSettableByIndexData.setList(int, List, Class)
orSettableByIndexData.setList(int, List, TypeToken)
.- Specified by:
setList
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.- Returns:
- this object.
-
setList
public <E> T setList(int i, java.util.List<E> v, java.lang.Class<E> elementsClass)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided list, which elements are of the provided Java class.This method uses the
CodecRegistry
to find a codec to handle the conversion of lists of the given Java type to the underlying CQL type.If the type of the elements is generic, use
SettableByIndexData.setList(int, List, TypeToken)
.- Specified by:
setList
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.elementsClass
- the class for the elements of the list.- Returns:
- this object.
-
setList
public <E> T setList(int i, java.util.List<E> v, com.google.common.reflect.TypeToken<E> elementsType)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided list, which elements are of the provided Java type.This method uses the
CodecRegistry
to find a codec to handle the conversion of lists of the given Java type to the underlying CQL type.- Specified by:
setList
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.elementsType
- the type for the elements of the list.- Returns:
- this object.
-
setMap
public <K,V> T setMap(int i, java.util.Map<K,V> v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided map.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (the type of the elements in the Java map is not considered). If two or more codecs target that CQL type, the one that was first registered will be used. For this reason, it is generally preferable to use the more deterministic methodsSettableByIndexData.setMap(int, Map, Class, Class)
orSettableByIndexData.setMap(int, Map, TypeToken, TypeToken)
.- Specified by:
setMap
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.- Returns:
- this object.
-
setMap
public <K,V> T setMap(int i, java.util.Map<K,V> v, java.lang.Class<K> keysClass, java.lang.Class<V> valuesClass)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided map, which keys and values are of the provided Java classes.This method uses the
CodecRegistry
to find a codec to handle the conversion of lists of the given Java types to the underlying CQL type.If the type of the keys or values is generic, use
SettableByIndexData.setMap(int, Map, TypeToken, TypeToken)
.- Specified by:
setMap
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.keysClass
- the class for the keys of the map.valuesClass
- the class for the values of the map.- Returns:
- this object.
-
setMap
public <K,V> T setMap(int i, java.util.Map<K,V> v, com.google.common.reflect.TypeToken<K> keysType, com.google.common.reflect.TypeToken<V> valuesType)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided map, which keys and values are of the provided Java types.This method uses the
CodecRegistry
to find a codec to handle the conversion of lists of the given Java types to the underlying CQL type.- Specified by:
setMap
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.keysType
- the type for the keys of the map.valuesType
- the type for the values of the map.- Returns:
- this object.
-
setSet
public <E> T setSet(int i, java.util.Set<E> v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided set.This method uses the
CodecRegistry
to find a codec to handle the conversion to the underlying CQL type (the type of the elements in the Java set is not considered). If two or more codecs target that CQL type, the one that was first registered will be used. For this reason, it is generally preferable to use the more deterministic methodsSettableByIndexData.setSet(int, Set, Class)
orSettableByIndexData.setSet(int, Set, TypeToken)
.- Specified by:
setSet
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.- Returns:
- this object.
-
setSet
public <E> T setSet(int i, java.util.Set<E> v, java.lang.Class<E> elementsClass)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided set, which elements are of the provided Java class.This method uses the
CodecRegistry
to find a codec to handle the conversion of sets of the given Java type to the underlying CQL type.If the type of the elements is generic, use
SettableByIndexData.setSet(int, Set, TypeToken)
.- Specified by:
setSet
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.elementsClass
- the class for the elements of the set.- Returns:
- this object.
-
setSet
public <E> T setSet(int i, java.util.Set<E> v, com.google.common.reflect.TypeToken<E> elementsType)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided set, which elements are of the provided Java type.This method uses the
CodecRegistry
to find a codec to handle the conversion of sets of the given Java type to the underlying CQL type.- Specified by:
setSet
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set. Note thatnull
values inside collections are not supported by CQL.elementsType
- the type for the elements of the set.- Returns:
- this object.
-
setUDTValue
public T setUDTValue(int i, UDTValue v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided UDT value.This method uses the
CodecRegistry
to find a codec to handle the conversion ofUDTValue
to the underlying CQL type.- Specified by:
setUDTValue
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
setTupleValue
public T setTupleValue(int i, TupleValue v)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided tuple value.This method uses the
CodecRegistry
to find a codec to handle the conversion ofTupleValue
to the underlying CQL type.- Specified by:
setTupleValue
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set.- Returns:
- this object.
-
set
public <V> T set(int i, V v, java.lang.Class<V> targetClass)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided value of the provided Java class.This method uses the
CodecRegistry
to find a codec to handle the conversion of the provided Java class to the underlying CQL type.If the Java type is generic, use
SettableByIndexData.set(int, Object, TypeToken)
instead.- Specified by:
set
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set; may benull
.targetClass
- The Java class to convert to; must not benull
;- Returns:
- this object.
-
set
public <V> T set(int i, V v, com.google.common.reflect.TypeToken<V> targetType)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided value of the provided Java type.This method uses the
CodecRegistry
to find a codec to handle the conversion of the provided Java type to the underlying CQL type.- Specified by:
set
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set; may benull
.targetType
- The Java type to convert to; must not benull
;- Returns:
- this object.
-
set
public <V> T set(int i, V v, TypeCodec<V> codec)
Description copied from interface:SettableByIndexData
Sets thei
th value to the provided value, converted using the givenTypeCodec
.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 inInvalidTypeException
s being thrown.- Specified by:
set
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.v
- the value to set; may benull
.codec
- TheTypeCodec
to use to serialize the value; may not benull
.- Returns:
- this object.
-
setToNull
public T setToNull(int i)
Description copied from interface:SettableByIndexData
Sets thei
th value tonull
.This is mainly intended for CQL types which map to native Java types.
- Specified by:
setToNull
in interfaceSettableByIndexData<T extends SettableByIndexData<T>>
- Parameters:
i
- the index of the value to set.- Returns:
- this object.
-
codecFor
protected <T> TypeCodec<T> codecFor(int i)
-
codecFor
protected <T> TypeCodec<T> codecFor(int i, java.lang.Class<T> javaClass)
-
codecFor
protected <T> TypeCodec<T> codecFor(int i, com.google.common.reflect.TypeToken<T> javaType)
-
codecFor
protected <T> TypeCodec<T> codecFor(int i, T value)
-
isNull
public boolean isNull(int i)
Returns whether thei
th value is NULL.- Specified by:
isNull
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) of the value to check.- Returns:
- whether the
i
th value is NULL.
-
getBool
public boolean getBool(int i)
Returns thei
th value as a boolean.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javaboolean
(for CQL typeboolean
, this will be the built-in codec).- Specified by:
getBool
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the boolean value of the
i
th element. If the value is NULL,false
is returned. If you need to distinguish NULL and false values, check first withGettableByIndexData.isNull(int)
or useget(i, Boolean.class)
.
-
getByte
public byte getByte(int i)
Returns thei
th value as a byte.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javabyte
(for CQL typetinyint
, this will be the built-in codec).- Specified by:
getByte
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a byte. If the value is NULL,0
is returned. If you need to distinguish NULL and 0, check first withGettableByIndexData.isNull(int)
or useget(i, Byte.class)
.
-
getShort
public short getShort(int i)
Returns thei
th value as a short.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javashort
(for CQL typesmallint
, this will be the built-in codec).- Specified by:
getShort
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a short. If the value is NULL,0
is returned. If you need to distinguish NULL and 0, check first withGettableByIndexData.isNull(int)
or useget(i, Short.class)
.
-
getInt
public int getInt(int i)
Returns thei
th value as an integer.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javaint
(for CQL typeint
, this will be the built-in codec).- Specified by:
getInt
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as an integer. If the value is NULL,0
is returned. If you need to distinguish NULL and 0, check first withGettableByIndexData.isNull(int)
or useget(i, Integer.class)
.
-
getLong
public long getLong(int i)
Returns thei
th value as a long.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javabyte
(for CQL typesbigint
andcounter
, this will be the built-in codec).- Specified by:
getLong
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a long. If the value is NULL,0L
is returned. If you need to distinguish NULL and 0L, check first withGettableByIndexData.isNull(int)
or useget(i, Long.class)
.
-
getTimestamp
public java.util.Date getTimestamp(int i)
Returns thei
th value as a date.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aDate
(for CQL typetimestamp
, this will be the built-in codec).- Specified by:
getTimestamp
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a data. If the value is NULL,null
is returned.
-
getDate
public LocalDate getDate(int i)
Returns thei
th value as a date (without time).This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aLocalDate
(for CQL typedate
, this will be the built-in codec).- Specified by:
getDate
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as an date. If the value is NULL,null
is returned.
-
getTime
public long getTime(int i)
Returns thei
th value as a long in nanoseconds since midnight.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javalong
(for CQL typetime
, this will be the built-in codec).- Specified by:
getTime
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a long. If the value is NULL,0L
is returned.
-
getFloat
public float getFloat(int i)
Returns thei
th value as a float.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javafloat
(for CQL typefloat
, this will be the built-in codec).- Specified by:
getFloat
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a float. If the value is NULL,0.0f
is returned. If you need to distinguish NULL and 0.0f, check first withGettableByIndexData.isNull(int)
or useget(i, Float.class)
.
-
getDouble
public double getDouble(int i)
Returns thei
th value as a double.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Javadouble
(for CQL typedouble
, this will be the built-in codec).- Specified by:
getDouble
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a double. If the value is NULL,0.0
is returned. If you need to distinguish NULL and 0.0, check first withGettableByIndexData.isNull(int)
or useget(i, Double.class)
.
-
getBytesUnsafe
public java.nio.ByteBuffer getBytesUnsafe(int i)
Returns thei
th value as aByteBuffer
.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.
- Specified by:
getBytesUnsafe
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a ByteBuffer. If the value is NULL,null
is returned.
-
getBytes
public java.nio.ByteBuffer getBytes(int i)
Returns thei
th value as a byte array.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a JavaByteBuffer
(for CQL typeblob
, this will be the built-in codec).- Specified by:
getBytes
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a byte array. If the value is NULL,null
is returned.
-
getString
public java.lang.String getString(int i)
Returns thei
th value as a string.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to a Java string (for CQL typestext
,varchar
andascii
, this will be the built-in codec).- Specified by:
getString
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a string. If the value is NULL,null
is returned.
-
getVarint
public java.math.BigInteger getVarint(int i)
Returns thei
th value as a variable length integer.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aBigInteger
(for CQL typevarint
, this will be the built-in codec).- Specified by:
getVarint
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a variable length integer. If the value is NULL,null
is returned.
-
getDecimal
public java.math.BigDecimal getDecimal(int i)
Returns thei
th value as a variable length decimal.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aBigDecimal
(for CQL typedecimal
, this will be the built-in codec).- Specified by:
getDecimal
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a variable length decimal. If the value is NULL,null
is returned.
-
getUUID
public java.util.UUID getUUID(int i)
Returns thei
th value as a UUID.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aUUID
(for CQL typesuuid
andtimeuuid
, this will be the built-in codec).- Specified by:
getUUID
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a UUID. If the value is NULL,null
is returned.
-
getInet
public java.net.InetAddress getInet(int i)
Returns thei
th value as an InetAddress.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to anInetAddress
(for CQL typeinet
, this will be the built-in codec).- Specified by:
getInet
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as an InetAddress. If the value is NULL,null
is returned.
-
getList
public <T> java.util.List<T> getList(int i, java.lang.Class<T> elementsClass)
Returns thei
th value 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
GettableByIndexData.getList(int, TypeToken)
.Implementation note: the actual
List
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will be mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getList
in interfaceGettableByIndexData
- 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
i
th element as a list ofT
objects.
-
getList
public <T> java.util.List<T> getList(int i, com.google.common.reflect.TypeToken<T> elementsType)
Returns thei
th value 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(1, new TypeToken<List<String>>() {});
Implementation note: the actual
List
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getList
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.elementsType
- the type of the elements of the list to retrieve.- Returns:
- the value of the
i
th element as a list ofT
objects.
-
getSet
public <T> java.util.Set<T> getSet(int i, java.lang.Class<T> elementsClass)
Returns thei
th value 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
GettableByIndexData.getSet(int, TypeToken)
.Implementation note: the actual
Set
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getSet
in interfaceGettableByIndexData
- 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
i
th element as a set ofT
objects.
-
getSet
public <T> java.util.Set<T> getSet(int i, com.google.common.reflect.TypeToken<T> elementsType)
Returns thei
th value 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(1, new TypeToken<List<String>>() {});
Implementation note: the actual
Set
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getSet
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.elementsType
- the type for the elements of the set to retrieve.- Returns:
- the value of the
i
th element as a set ofT
objects.
-
getMap
public <K,V> java.util.Map<K,V> getMap(int i, java.lang.Class<K> keysClass, java.lang.Class<V> valuesClass)
Returns thei
th value 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
GettableByIndexData.getMap(int, TypeToken, TypeToken)
.Implementation note: the actual
Map
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getMap
in interfaceGettableByIndexData
- 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
i
th element as a map ofK
toV
objects.
-
getMap
public <K,V> java.util.Map<K,V> getMap(int i, com.google.common.reflect.TypeToken<K> keysType, com.google.common.reflect.TypeToken<V> valuesType)
Returns thei
th value 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(1, TypeToken.of(Integer.class), new TypeToken<List<String>>() {});
Implementation note: the actual
Map
implementation will depend on thecodec
being used; therefore, callers should make no assumptions concerning its mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQLNULL
values is also codec-dependent. By default, the driver will return mutable instances, and a CQLNULL
will mapped to an empty collection (note that Cassandra makes no distinction betweenNULL
and an empty collection).- Specified by:
getMap
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.keysType
- the type for the keys of the map to retrieve.valuesType
- the type for the values of the map to retrieve.- Returns:
- the value of the
i
th element as a map ofK
toV
objects.
-
getUDTValue
public UDTValue getUDTValue(int i)
Return thei
th value as a UDT value.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aUDTValue
(if the CQL type is a UDT, the registry will generate a codec automatically).- Specified by:
getUDTValue
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a UDT value. If the value is NULL, thennull
will be returned.
-
getTupleValue
public TupleValue getTupleValue(int i)
Return thei
th value as a tuple value.This method uses the
CodecRegistry
to find a codec to convert the underlying CQL type to aTupleValue
(if the CQL type is a tuple, the registry will generate a codec automatically).- Specified by:
getTupleValue
in interfaceGettableByIndexData
- Parameters:
i
- the index (0 <= i < size()
) to retrieve.- Returns:
- the value of the
i
th element as a tuple value. If the value is NULL, thennull
will be returned.
-
getObject
public java.lang.Object getObject(int i)
Returns thei
th value 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 (
GettableByIndexData.getBool(int)
,GettableByIndexData.getInt(int)
, etc.), orGettableByIndexData.get(int, Class)
andGettableByIndexData.get(int, TypeToken)
for custom types.- Specified by:
getObject
in interfaceGettableByIndexData
- Parameters:
i
- the index to retrieve.- Returns:
- the value of the
i
th value as the Java type matching its CQL type. - See Also:
CodecRegistry.codecFor(DataType)
-
get
public <T> T get(int i, java.lang.Class<T> targetClass)
Description copied from interface:GettableByIndexData
Returns thei
th value 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
GettableByIndexData.get(int, 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 CQLNULL
values is also codec-dependent; by default, a CQLNULL
value translates tonull
for simple CQL types, UDTs and tuples, and to empty collections for all CQL collection types.- Specified by:
get
in interfaceGettableByIndexData
- Parameters:
i
- the index to retrieve.targetClass
- The Java type the value should be converted to.- Returns:
- the value of the
i
th value converted to the given Java type.
-
get
public <T> T get(int i, com.google.common.reflect.TypeToken<T> targetType)
Description copied from interface:GettableByIndexData
Returns thei
th value 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 CQLNULL
values is also codec-dependent; by default, a CQLNULL
value translates tonull
for simple CQL types, UDTs and tuples, and to empty collections for all CQL collection types.- Specified by:
get
in interfaceGettableByIndexData
- Parameters:
i
- the index to retrieve.targetType
- The Java type the value should be converted to.- Returns:
- the value of the
i
th value converted to the given Java type.
-
get
public <T> T get(int i, TypeCodec<T> codec)
Description copied from interface:GettableByIndexData
Returns thei
th value converted using the givenTypeCodec
.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 inInvalidTypeException
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 CQLNULL
values is also codec-dependent; by default, a CQLNULL
value translates tonull
for simple CQL types, UDTs and tuples, and to empty collections for all CQL collection types.- Specified by:
get
in interfaceGettableByIndexData
- Parameters:
i
- the index to retrieve.codec
- TheTypeCodec
to use to deserialize the value; may not benull
.- Returns:
- the value of the
i
th value converted using the givenTypeCodec
.
-
-