public interface GettableById extends GettableByIndex, AccessibleById
| Modifier and Type | Method and Description |
|---|---|
default <ValueT> ValueT |
get(CqlIdentifier id,
Class<ValueT> targetClass)
Returns the value for the first occurrence of
id, converting it to the given Java type. |
default <ValueT> ValueT |
get(CqlIdentifier id,
GenericType<ValueT> targetType)
Returns the value for the first occurrence of
id, converting it to the given Java type. |
default <ValueT> ValueT |
get(CqlIdentifier id,
TypeCodec<ValueT> codec)
Returns the value for the first occurrence of
id, using the given codec for the
conversion. |
default BigDecimal |
getBigDecimal(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java big decimal. |
default BigInteger |
getBigInteger(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java big integer. |
default boolean |
getBool(CqlIdentifier id)
Deprecated.
this method only exists to ease the transition from driver 3, it is an alias for
getBoolean(CqlIdentifier). |
default boolean |
getBoolean(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive boolean. |
default byte |
getByte(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive byte. |
default ByteBuffer |
getByteBuffer(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java byte buffer. |
default ByteBuffer |
getBytesUnsafe(CqlIdentifier id)
Returns the raw binary representation of the value for the first occurrence of
id. |
default CqlDuration |
getCqlDuration(CqlIdentifier id)
Returns the value for the first occurrence of
id as a duration. |
default double |
getDouble(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive double. |
default float |
getFloat(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive float. |
default InetAddress |
getInetAddress(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java IP address. |
default Instant |
getInstant(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java instant. |
default int |
getInt(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive integer. |
default <ElementT> List<ElementT> |
getList(CqlIdentifier id,
Class<ElementT> elementsClass)
Returns the value for the first occurrence of
id as a Java list. |
default LocalDate |
getLocalDate(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java local date. |
default LocalTime |
getLocalTime(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java local time. |
default long |
getLong(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive long. |
default <KeyT,ValueT> |
getMap(CqlIdentifier id,
Class<KeyT> keyClass,
Class<ValueT> valueClass)
Returns the value for the first occurrence of
id as a Java map. |
default Object |
getObject(CqlIdentifier id)
Returns the value for the first occurrence of
id, converting it to the most appropriate
Java type. |
default <ElementT> Set<ElementT> |
getSet(CqlIdentifier id,
Class<ElementT> elementsClass)
Returns the value for the first occurrence of
id as a Java set. |
default short |
getShort(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java primitive short. |
default String |
getString(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java string. |
default Token |
getToken(CqlIdentifier id)
Returns the value for the first occurrence of
id as a token. |
default TupleValue |
getTupleValue(CqlIdentifier id)
Returns the value for the first occurrence of
id as a tuple value. |
default UdtValue |
getUdtValue(CqlIdentifier id)
Returns the value for the first occurrence of
id as a user defined type value. |
default UUID |
getUuid(CqlIdentifier id)
Returns the value for the first occurrence of
id as a Java UUID. |
default boolean |
isNull(CqlIdentifier id)
Indicates whether the value for the first occurrence of
id is a CQL NULL. |
get, get, get, getBigDecimal, getBigInteger, getBool, getBoolean, getByte, getByteBuffer, getBytesUnsafe, getCqlDuration, getDouble, getFloat, getInetAddress, getInstant, getInt, getList, getLocalDate, getLocalTime, getLong, getMap, getObject, getSet, getShort, getString, getToken, getTupleValue, getUdtValue, getUuid, isNullallIndicesOf, firstIndexOf, getTypegetType, sizecodecRegistry, protocolVersion@Nullable default ByteBuffer getBytesUnsafe(@NonNull CqlIdentifier id)
id.
This is primarily for internal use; you'll likely want to use one of the typed getters instead, to get a higher-level Java representation.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
null if the CQL value is NULL. For performance
reasons, this is the actual instance used internally. If you read data from the buffer,
make sure to duplicate it beforehand, or only use relative
methods. If you change the buffer's index or its contents in any way, any other getter
invocation for this value will have unpredictable results.IllegalArgumentException - if the id is invalid.default boolean isNull(@NonNull
CqlIdentifier id)
id is a CQL NULL.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable
default <ValueT> ValueT get(@NonNull
CqlIdentifier id,
@NonNull
TypeCodec<ValueT> codec)
id, using the given codec for the
conversion.
This method completely bypasses the Data.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 is appropriate for the conversion. Failing to do so will result in errors at runtime.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable
default <ValueT> ValueT get(@NonNull
CqlIdentifier id,
@NonNull
GenericType<ValueT> targetType)
id, converting it to the given Java type.
The Data.codecRegistry() will be used to look up a codec to handle the conversion.
This variant is for generic Java types. If the target type is not generic, use GettableByIndex.get(int, Class) instead, which may perform slightly better.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.CodecNotFoundException - if no codec can perform the conversion.@Nullable
default <ValueT> ValueT get(@NonNull
CqlIdentifier id,
@NonNull
Class<ValueT> targetClass)
id, converting it to the given Java type.
The Data.codecRegistry() will be used to look up a codec to handle the conversion.
If the target type is generic, use GettableByIndex.get(int, GenericType) instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.CodecNotFoundException - if no codec can perform the conversion.@Nullable default Object getObject(@NonNull CqlIdentifier id)
id, converting it to the most appropriate
Java type.
The Data.codecRegistry() will be used to look up a codec to handle the conversion.
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 variants, such as the ones for built-in types (GettableByIndex.getBoolean(int), GettableByIndex.getInt(int), etc.), or GettableByIndex.get(int, Class) and GettableByIndex.get(int, GenericType) for custom types.
The definition of "most appropriate" is unspecified, and left to the appreciation of the
Data.codecRegistry() implementation. By default, the driver uses the mapping described in
the other getXxx() methods (for example String for text, varchar
and ascii, etc).
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.CodecNotFoundException - if no codec can perform the conversion.default boolean getBoolean(@NonNull
CqlIdentifier id)
id as a Java primitive boolean.
By default, this works with CQL type boolean.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return false. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Boolean.class)
instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Deprecated default boolean getBool(@NonNull CqlIdentifier id)
getBoolean(CqlIdentifier).default byte getByte(@NonNull
CqlIdentifier id)
id as a Java primitive byte.
By default, this works with CQL type tinyint.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Byte.class) instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.default double getDouble(@NonNull
CqlIdentifier id)
id as a Java primitive double.
By default, this works with CQL type double.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0.0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Double.class)
instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.default float getFloat(@NonNull
CqlIdentifier id)
id as a Java primitive float.
By default, this works with CQL type float.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0.0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Float.class)
instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.default int getInt(@NonNull
CqlIdentifier id)
id as a Java primitive integer.
By default, this works with CQL type int.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Integer.class)
instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.default long getLong(@NonNull
CqlIdentifier id)
id as a Java primitive long.
By default, this works with CQL types bigint and counter.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Long.class) instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.default short getShort(@NonNull
CqlIdentifier id)
id as a Java primitive short.
By default, this works with CQL type smallint.
Note that, due to its signature, this method cannot return null. If the CQL value is
NULL, it will return 0. If this doesn't work for you, either call isNull(CqlIdentifier) before calling this method, or use get(id, Short.class)
instead.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default Instant getInstant(@NonNull CqlIdentifier id)
id as a Java instant.
By default, this works with CQL type timestamp.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default LocalDate getLocalDate(@NonNull CqlIdentifier id)
id as a Java local date.
By default, this works with CQL type date.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default LocalTime getLocalTime(@NonNull CqlIdentifier id)
id as a Java local time.
By default, this works with CQL type time.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default ByteBuffer getByteBuffer(@NonNull CqlIdentifier id)
id as a Java byte buffer.
By default, this works with CQL type blob.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default String getString(@NonNull CqlIdentifier id)
id as a Java string.
By default, this works with CQL types text, varchar and ascii.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default BigInteger getBigInteger(@NonNull CqlIdentifier id)
id as a Java big integer.
By default, this works with CQL type varint.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default BigDecimal getBigDecimal(@NonNull CqlIdentifier id)
id as a Java big decimal.
By default, this works with CQL type decimal.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default UUID getUuid(@NonNull CqlIdentifier id)
id as a Java UUID.
By default, this works with CQL types uuid and timeuuid.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default InetAddress getInetAddress(@NonNull CqlIdentifier id)
id as a Java IP address.
By default, this works with CQL type inet.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default CqlDuration getCqlDuration(@NonNull CqlIdentifier id)
id as a duration.
By default, this works with CQL type duration.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default Token getToken(@NonNull CqlIdentifier id)
id as a token.
Note that, for simplicity, this method relies on the CQL type of the column to pick the
correct token implementation. Therefore it must only be called on columns of the type that
matches the partitioner in use for this cluster: bigint for Murmur3Partitioner,
blob for ByteOrderedPartitioner, and varint for RandomPartitioner. Calling it for the wrong type will produce corrupt tokens that are unusable
with this driver instance.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the column type can not be converted to a known token type
or if the name is invalid.@Nullable default <ElementT> List<ElementT> getList(@NonNull CqlIdentifier id, @NonNull Class<ElementT> elementsClass)
id as a Java list.
By default, this works with CQL type list.
This method is provided for convenience when the element type is a non-generic type. For
more complex list types, use GettableByIndex.get(int, GenericType).
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
Apache Cassandra does not make any distinction between an empty collection and null.
Whether this method will return an empty collection or null will depend on the codec
used; by default, the driver's built-in codecs all return empty collections.
IllegalArgumentException - if the id is invalid.@Nullable default <ElementT> Set<ElementT> getSet(@NonNull CqlIdentifier id, @NonNull Class<ElementT> elementsClass)
id as a Java set.
By default, this works with CQL type set.
This method is provided for convenience when the element type is a non-generic type. For
more complex set types, use GettableByIndex.get(int, GenericType).
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
Apache Cassandra does not make any distinction between an empty collection and null.
Whether this method will return an empty collection or null will depend on the codec
used; by default, the driver's built-in codecs all return empty collections.
IllegalArgumentException - if the id is invalid.@Nullable default <KeyT,ValueT> Map<KeyT,ValueT> getMap(@NonNull CqlIdentifier id, @NonNull Class<KeyT> keyClass, @NonNull Class<ValueT> valueClass)
id as a Java map.
By default, this works with CQL type map.
This method is provided for convenience when the element type is a non-generic type. For
more complex map types, use GettableByIndex.get(int, GenericType).
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
Apache Cassandra does not make any distinction between an empty collection and null.
Whether this method will return an empty collection or null will depend on the codec
used; by default, the driver's built-in codecs all return empty collections.
IllegalArgumentException - if the id is invalid.@Nullable default UdtValue getUdtValue(@NonNull CqlIdentifier id)
id as a user defined type value.
By default, this works with CQL user-defined types.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.@Nullable default TupleValue getTupleValue(@NonNull CqlIdentifier id)
id as a tuple value.
By default, this works with CQL tuples.
If an identifier appears multiple times, this can only be used to access the first value. For the other ones, use positional getters.
If you want to avoid the overhead of building a CqlIdentifier, use the variant of
this method that takes a string argument.
IllegalArgumentException - if the id is invalid.Copyright © 2017–2024. All rights reserved.