TypeCodecs (Java driver for Scylla and Apache Cassandra(R)

java.lang.Object
- com.datastax.oss.driver.api.core.type.codec.TypeCodecs

Direct Known Subclasses:

DseTypeCodecs
```
public class TypeCodecs
extends Object
```
Constants and factory methods to obtain instances of the driver's default type codecs.
See also ExtraTypeCodecs for additional codecs that you can register with your session to handle different type mappings.

Field Summary

Fields
Modifier and Type	Field and Description
`static TypeCodec<String>`	`ASCII` The default codec that maps CQL type `ascii` to Java's `String`.
`static PrimitiveLongCodec`	`BIGINT` The default codec that maps CQL type `bigint` to Java's `long`.
`static TypeCodec<ByteBuffer>`	`BLOB` The default codec that maps CQL type `blob` to Java's `ByteBuffer`.
`static PrimitiveBooleanCodec`	`BOOLEAN` The default codec that maps CQL type `boolean` to Java's `boolean`.
`static PrimitiveLongCodec`	`COUNTER` The default codec that maps CQL type `counter` to Java's `long`.
`static TypeCodec<LocalDate>`	`DATE` The default codec that maps CQL type `date` to Java's `LocalDate`.
`static TypeCodec<BigDecimal>`	`DECIMAL` The default codec that maps CQL type `decimal` to Java's `BigDecimal`.
`static PrimitiveDoubleCodec`	`DOUBLE` The default codec that maps CQL type `double` to Java's `double`.
`static TypeCodec<CqlDuration>`	`DURATION` The default codec that maps CQL type `duration` to the driver's `CqlDuration`.
`static PrimitiveFloatCodec`	`FLOAT` The default codec that maps CQL type `float` to Java's `float`.
`static TypeCodec<InetAddress>`	`INET` The default codec that maps CQL type `inet` to Java's `InetAddress`.
`static PrimitiveIntCodec`	`INT` The default codec that maps CQL type `int` to Java's `int`.
`static PrimitiveShortCodec`	`SMALLINT` The default codec that maps CQL type `smallint` to Java's `short`.
`static TypeCodec<String>`	`TEXT` The default codec that maps CQL type `text` to Java's `String`.
`static TypeCodec<LocalTime>`	`TIME` The default codec that maps CQL type `time` to Java's `LocalTime`.
`static TypeCodec<Instant>`	`TIMESTAMP` The default codec that maps CQL type `timestamp` to Java's `Instant`, using the system's default time zone to parse and format CQL literals.
`static TypeCodec<UUID>`	`TIMEUUID` The default codec that maps CQL type `timeuuid` to Java's `UUID`.
`static PrimitiveByteCodec`	`TINYINT` The default codec that maps CQL type `tinyint` to Java's `byte`.
`static TypeCodec<UUID>`	`UUID` The default codec that maps CQL type `uuid` to Java's `UUID`.
`static TypeCodec<BigInteger>`	`VARINT` The default codec that maps CQL type `varint` to Java's `BigInteger`.
`static TypeCodec<ZonedDateTime>`	`ZONED_TIMESTAMP_SYSTEM` An alias for `ExtraTypeCodecs.ZONED_TIMESTAMP_SYSTEM`.
`static TypeCodec<ZonedDateTime>`	`ZONED_TIMESTAMP_UTC` An alias for `ExtraTypeCodecs.ZONED_TIMESTAMP_UTC`.

Constructor Summary

Constructors
Constructor and Description

TypeCodecs()

Constructors
Constructor and Description
`TypeCodecs()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TypeCodec<ByteBuffer>`	`custom(DataType cqlType)` Builds a new codec that maps a CQL custom type to Java's `ByteBuffer`.
`static <T> TypeCodec<List<T>>`	`listOf(TypeCodec<T> elementCodec)` Builds a new codec that maps a CQL list to a Java list, using the given codec to map each element.
`static <K,V> TypeCodec<Map<K,V>>`	`mapOf(TypeCodec<K> keyCodec, TypeCodec<V> valueCodec)` Builds a new codec that maps a CQL map to a Java map, using the given codecs to map each key and value.
`static <T> TypeCodec<Set<T>>`	`setOf(TypeCodec<T> elementCodec)` Builds a new codec that maps a CQL set to a Java set, using the given codec to map each element.
`static TypeCodec<TupleValue>`	`tupleOf(TupleType cqlType)` Builds a new codec that maps a CQL tuple to the driver's `TupleValue`, for the given type definition.
`static TypeCodec<UdtValue>`	`udtOf(UserDefinedType cqlType)` Builds a new codec that maps a CQL user defined type to the driver's `UdtValue`, for the given type definition.
`static TypeCodec<ZonedDateTime>`	`zonedTimestampAt(ZoneId timeZone)` An alias for `ExtraTypeCodecs.zonedTimestampAt(ZoneId)`.

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

- Field Detail
  - BOOLEAN
```
public static final PrimitiveBooleanCodec BOOLEAN
```
    The default codec that maps CQL type boolean to Java's boolean.
  - TINYINT
```
public static final PrimitiveByteCodec TINYINT
```
    The default codec that maps CQL type tinyint to Java's byte.
  - DOUBLE
```
public static final PrimitiveDoubleCodec DOUBLE
```
    The default codec that maps CQL type double to Java's double.
  - COUNTER
```
public static final PrimitiveLongCodec COUNTER
```
    The default codec that maps CQL type counter to Java's long.
  - FLOAT
```
public static final PrimitiveFloatCodec FLOAT
```
    The default codec that maps CQL type float to Java's float.
  - INT
```
public static final PrimitiveIntCodec INT
```
    The default codec that maps CQL type int to Java's int.
  - BIGINT
```
public static final PrimitiveLongCodec BIGINT
```
    The default codec that maps CQL type bigint to Java's long.
  - SMALLINT
```
public static final PrimitiveShortCodec SMALLINT
```
    The default codec that maps CQL type smallint to Java's short.
  - TIMESTAMP
```
public static final TypeCodec<Instant> TIMESTAMP
```
    The default codec that maps CQL type timestamp to Java's Instant, using the system's default time zone to parse and format CQL literals.
    This codec uses the system's default time zone as its source of time zone information when formatting values as CQL literals, or parsing CQL literals that do not have any time zone indication. Note that this only applies to the TypeCodec.format(Object) and TypeCodec.parse(String) methods; regular encoding and decoding, like setting a value on a bound statement or reading a column from a row, are not affected by the time zone.
    If you need a different time zone, consider other codecs in ExtraTypeCodecs, or call ExtraTypeCodecs.timestampAt(ZoneId) instead.
    
    See Also:
    
    ExtraTypeCodecs.TIMESTAMP_UTC, ExtraTypeCodecs.timestampAt(ZoneId)
  - DATE
```
public static final TypeCodec<LocalDate> DATE
```
    The default codec that maps CQL type date to Java's LocalDate.
  - TIME
```
public static final TypeCodec<LocalTime> TIME
```
    The default codec that maps CQL type time to Java's LocalTime.
  - BLOB
```
public static final TypeCodec<ByteBuffer> BLOB
```
    The default codec that maps CQL type blob to Java's ByteBuffer.
    If you are looking for a codec mapping CQL type blob to the Java type byte[], you should use ExtraTypeCodecs.BLOB_TO_ARRAY instead.
    If you are looking for a codec mapping CQL type list<tinyint> to the Java type byte[], you should use ExtraTypeCodecs.BYTE_LIST_TO_ARRAY instead.
    
    See Also:
    
    ExtraTypeCodecs.BLOB_TO_ARRAY, ExtraTypeCodecs.BYTE_LIST_TO_ARRAY
  - TEXT
```
public static final TypeCodec<String> TEXT
```
    The default codec that maps CQL type text to Java's String.
  - ASCII
```
public static final TypeCodec<String> ASCII
```
    The default codec that maps CQL type ascii to Java's String.
  - VARINT
```
public static final TypeCodec<BigInteger> VARINT
```
    The default codec that maps CQL type varint to Java's BigInteger.
  - DECIMAL
```
public static final TypeCodec<BigDecimal> DECIMAL
```
    The default codec that maps CQL type decimal to Java's BigDecimal.
  - UUID
```
public static final TypeCodec<UUID> UUID
```
    The default codec that maps CQL type uuid to Java's UUID.
  - TIMEUUID
```
public static final TypeCodec<UUID> TIMEUUID
```
    The default codec that maps CQL type timeuuid to Java's UUID.
  - INET
```
public static final TypeCodec<InetAddress> INET
```
    The default codec that maps CQL type inet to Java's InetAddress.
  - DURATION
```
public static final TypeCodec<CqlDuration> DURATION
```
    The default codec that maps CQL type duration to the driver's CqlDuration.
  - ZONED_TIMESTAMP_SYSTEM
```
public static final TypeCodec<ZonedDateTime> ZONED_TIMESTAMP_SYSTEM
```
    An alias for ExtraTypeCodecs.ZONED_TIMESTAMP_SYSTEM.
    This exists for historical reasons: the constant was originally defined in this class, but technically it belongs to ExtraTypeCodecs because this is not a built-in mapping.
  - ZONED_TIMESTAMP_UTC
```
public static final TypeCodec<ZonedDateTime> ZONED_TIMESTAMP_UTC
```
    An alias for ExtraTypeCodecs.ZONED_TIMESTAMP_UTC.
    This exists for historical reasons: the constant was originally defined in this class, but technically it belongs to ExtraTypeCodecs because this is not a built-in mapping.
- Constructor Detail
  - TypeCodecs
```
public TypeCodecs()
```
- Method Detail
  - custom
```
@NonNull
public static TypeCodec<ByteBuffer> custom(@NonNull
                                                    DataType cqlType)
```
    Builds a new codec that maps a CQL custom type to Java's ByteBuffer.
    
    Parameters:
    
    cqlType - the fully-qualified name of the custom type.
  - listOf
```
@NonNull
public static <T> TypeCodec<List<T>> listOf(@NonNull
                                                     TypeCodec<T> elementCodec)
```
    Builds a new codec that maps a CQL list to a Java list, using the given codec to map each element.
  - setOf
```
@NonNull
public static <T> TypeCodec<Set<T>> setOf(@NonNull
                                                   TypeCodec<T> elementCodec)
```
    Builds a new codec that maps a CQL set to a Java set, using the given codec to map each element.
  - mapOf
```
@NonNull
public static <K,V> TypeCodec<Map<K,V>> mapOf(@NonNull
                                                       TypeCodec<K> keyCodec,
                                                       @NonNull
                                                       TypeCodec<V> valueCodec)
```
    Builds a new codec that maps a CQL map to a Java map, using the given codecs to map each key and value.
  - tupleOf
```
@NonNull
public static TypeCodec<TupleValue> tupleOf(@NonNull
                                                     TupleType cqlType)
```
    Builds a new codec that maps a CQL tuple to the driver's TupleValue, for the given type definition.
    Note that the components of a TupleValue are stored in their encoded form. They are encoded/decoded on the fly when you set or get them, using the codec registry.
  - udtOf
```
@NonNull
public static TypeCodec<UdtValue> udtOf(@NonNull
                                                 UserDefinedType cqlType)
```
    Builds a new codec that maps a CQL user defined type to the driver's UdtValue, for the given type definition.
    Note that the fields of a UdtValue are stored in their encoded form. They are encoded/decoded on the fly when you set or get them, using the codec registry.
  - zonedTimestampAt
```
@NonNull
public static TypeCodec<ZonedDateTime> zonedTimestampAt(@NonNull
                                                                 ZoneId timeZone)
```
    An alias for ExtraTypeCodecs.zonedTimestampAt(ZoneId).
    This exists for historical reasons: the method was originally defined in this class, but technically it belongs to ExtraTypeCodecs because this is not a built-in mapping.

Class TypeCodecs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOLEAN

TINYINT

DOUBLE

COUNTER

FLOAT

INT

BIGINT

SMALLINT

TIMESTAMP

DATE

TIME

BLOB

TEXT

ASCII

VARINT

DECIMAL

UUID

TIMEUUID

INET

DURATION

ZONED_TIMESTAMP_SYSTEM

ZONED_TIMESTAMP_UTC

Constructor Detail

TypeCodecs

Method Detail

custom

listOf

setOf

mapOf

tupleOf

udtOf

zonedTimestampAt