DataType (DataStax Java Driver for Apache Cassandra

java.lang.Object
- com.datastax.driver.core.DataType

Direct Known Subclasses:

TupleType, UserType
```
public abstract class DataType
extends Object
```
Data types supported by cassandra.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataType.Name
The CQL type name.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataType.Name` The CQL type name.

Field Summary

Fields
Modifier and Type Field and Description

protected DataType.Name name

Fields
Modifier and Type	Field and Description
`protected DataType.Name`	`name`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DataType(DataType.Name name)

Constructors
Modifier	Constructor and Description
`protected`	`DataType(DataType.Name name)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Set<DataType>`	`allPrimitiveTypes()` Returns a set of all the primitive types, where primitive types are defined as the types that don't have type arguments (that is excluding lists, sets, and maps).
`static DataType`	`ascii()` Returns the ASCII type.
`Class<?>`	`asJavaClass()` Returns the Java Class corresponding to this type.
`static DataType`	`bigint()` Returns the BIGINT type.
`static DataType`	`blob()` Returns the BLOB type.
`static DataType`	`cboolean()` Returns the BOOLEAN type.
`static DataType`	`cdouble()` Returns the DOUBLE type.
`static DataType`	`cfloat()` Returns the FLOAT type.
`static DataType`	`cint()` Returns the INT type.
`static DataType`	`counter()` Returns the COUNTER type.
`static DataType`	`custom(String typeClassName)` Returns a Custom type.
`static DataType`	`decimal()` Returns the DECIMAL type.
`Object`	`deserialize(ByteBuffer bytes)` Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws `UnsupportedOperationException`. Use `deserialize(ByteBuffer, ProtocolVersion)` instead.
`Object`	`deserialize(ByteBuffer bytes, int protocolVersion)` Deprecated. This method is provided for backward compatibility. Use `deserialize(ByteBuffer,ProtocolVersion)` instead.
`Object`	`deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion)` Deserialize a value of this type from the provided bytes using the given protocol version.
`String`	`format(Object value)` Format a Java object as an equivalent CQL value.
`static DataType`	`frozenList(DataType elementType)` Returns the type of frozen lists of `elementType` elements.
`static DataType`	`frozenMap(DataType keyType, DataType valueType)` Returns the type of frozen maps of `keyType` to `valueType` elements.
`static DataType`	`frozenSet(DataType elementType)` Returns the type of frozen sets of `elementType` elements.
`String`	`getCustomTypeClassName()` Returns the server-side class name for a custom type.
`DataType.Name`	`getName()` Returns the name of that type.
`List<DataType>`	`getTypeArguments()` Returns the type arguments of this type.
`static DataType`	`inet()` Returns the INET type.
`boolean`	`isCollection()` Returns whether this type is a collection one, i.e.
`abstract boolean`	`isFrozen()` Returns whether this data type is frozen.
`static DataType`	`list(DataType elementType)` Returns the type of "not frozen" lists of `elementType` elements.
`static DataType`	`list(DataType elementType, boolean frozen)` Returns the type of lists of `elementType` elements.
`static DataType`	`map(DataType keyType, DataType valueType)` Returns the type of "not frozen" maps of `keyType` to `valueType` elements.
`static DataType`	`map(DataType keyType, DataType valueType, boolean frozen)` Returns the type of maps of `keyType` to `valueType` elements.
`Object`	`parse(String value)` Parses a string CQL value for the type this object represent, returning its value as a Java object.
`ByteBuffer`	`serialize(Object value)` Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws `UnsupportedOperationException`. Use `serialize(Object, ProtocolVersion)` instead.
`ByteBuffer`	`serialize(Object value, int protocolVersion)` Deprecated. This method is provided for backward compatibility. Use `serialize(Object, ProtocolVersion)` instead.
`ByteBuffer`	`serialize(Object value, ProtocolVersion protocolVersion)` Serialize a value of this type to bytes, with the given protocol version.
`static ByteBuffer`	`serializeValue(Object value)` Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws `UnsupportedOperationException`. Use `serializeValue(Object, ProtocolVersion)` instead.
`static ByteBuffer`	`serializeValue(Object value, int protocolVersion)` Deprecated. This method is provided for backward compatibility. Use `serializeValue(Object, ProtocolVersion)` instead.
`static ByteBuffer`	`serializeValue(Object value, ProtocolVersion protocolVersion)` Serialize an object based on its java class.
`static DataType`	`set(DataType elementType)` Returns the type of "not frozen" sets of `elementType` elements.
`static DataType`	`set(DataType elementType, boolean frozen)` Returns the type of sets of `elementType` elements.
`static DataType`	`text()` Returns the TEXT type.
`static DataType`	`timestamp()` Returns the TIMESTAMP type.
`static DataType`	`timeuuid()` Returns the TIMEUUID type.
`static DataType`	`uuid()` Returns the UUID type.
`static DataType`	`varchar()` Returns the VARCHAR type.
`static DataType`	`varint()` Returns the VARINT type.

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

- Field Detail
  - name
```
protected final DataType.Name name
```
- Constructor Detail
  - DataType
```
protected DataType(DataType.Name name)
```
- Method Detail
  - ascii
```
public static DataType ascii()
```
    Returns the ASCII type.
    
    Returns:
    The ASCII type.
  - bigint
```
public static DataType bigint()
```
    Returns the BIGINT type.
    
    Returns:
    The BIGINT type.
  - blob
```
public static DataType blob()
```
    Returns the BLOB type.
    
    Returns:
    The BLOB type.
  - cboolean
```
public static DataType cboolean()
```
    Returns the BOOLEAN type.
    
    Returns:
    The BOOLEAN type.
  - counter
```
public static DataType counter()
```
    Returns the COUNTER type.
    
    Returns:
    The COUNTER type.
  - decimal
```
public static DataType decimal()
```
    Returns the DECIMAL type.
    
    Returns:
    The DECIMAL type.
  - cdouble
```
public static DataType cdouble()
```
    Returns the DOUBLE type.
    
    Returns:
    The DOUBLE type.
  - cfloat
```
public static DataType cfloat()
```
    Returns the FLOAT type.
    
    Returns:
    The FLOAT type.
  - inet
```
public static DataType inet()
```
    Returns the INET type.
    
    Returns:
    The INET type.
  - cint
```
public static DataType cint()
```
    Returns the INT type.
    
    Returns:
    The INT type.
  - text
```
public static DataType text()
```
    Returns the TEXT type.
    
    Returns:
    The TEXT type.
  - timestamp
```
public static DataType timestamp()
```
    Returns the TIMESTAMP type.
    
    Returns:
    The TIMESTAMP type.
  - uuid
```
public static DataType uuid()
```
    Returns the UUID type.
    
    Returns:
    The UUID type.
  - varchar
```
public static DataType varchar()
```
    Returns the VARCHAR type.
    
    Returns:
    The VARCHAR type.
  - varint
```
public static DataType varint()
```
    Returns the VARINT type.
    
    Returns:
    The VARINT type.
  - timeuuid
```
public static DataType timeuuid()
```
    Returns the TIMEUUID type.
    
    Returns:
    The TIMEUUID type.
  - list
```
public static DataType list(DataType elementType,
            boolean frozen)
```
    Returns the type of lists of elementType elements.
    
    Parameters:
    elementType - the type of the list elements.
    frozen - whether the list is frozen.
    
    Returns:
    the type of lists of elementType elements.
  - list
```
public static DataType list(DataType elementType)
```
    Returns the type of "not frozen" lists of elementType elements.
    This is a shorthand for list(elementType, false);.
    
    Parameters:
    elementType - the type of the list elements.
    
    Returns:
    the type of "not frozen" lists of elementType elements.
  - frozenList
```
public static DataType frozenList(DataType elementType)
```
    Returns the type of frozen lists of elementType elements.
    This is a shorthand for list(elementType, true);.
    
    Parameters:
    elementType - the type of the list elements.
    
    Returns:
    the type of frozen lists of elementType elements.
  - set
```
public static DataType set(DataType elementType,
           boolean frozen)
```
    Returns the type of sets of elementType elements.
    
    Parameters:
    elementType - the type of the set elements.
    frozen - whether the set is frozen.
    
    Returns:
    the type of sets of elementType elements.
  - set
```
public static DataType set(DataType elementType)
```
    Returns the type of "not frozen" sets of elementType elements.
    This is a shorthand for set(elementType, false);.
    
    Parameters:
    elementType - the type of the set elements.
    
    Returns:
    the type of "not frozen" sets of elementType elements.
  - frozenSet
```
public static DataType frozenSet(DataType elementType)
```
    Returns the type of frozen sets of elementType elements.
    This is a shorthand for set(elementType, true);.
    
    Parameters:
    elementType - the type of the set elements.
    
    Returns:
    the type of frozen sets of elementType elements.
  - map
```
public static DataType map(DataType keyType,
           DataType valueType,
           boolean frozen)
```
    Returns the type of maps of keyType to valueType elements.
    
    Parameters:
    keyType - the type of the map keys.
    valueType - the type of the map values.
    frozen - whether the map is frozen.
    
    Returns:
    the type of maps of keyType to valueType elements.
  - map
```
public static DataType map(DataType keyType,
           DataType valueType)
```
    Returns the type of "not frozen" maps of keyType to valueType elements.
    This is a shorthand for map(keyType, valueType, false);.
    
    Parameters:
    keyType - the type of the map keys.
    valueType - the type of the map values.
    
    Returns:
    the type of "not frozen" maps of keyType to valueType elements.
  - frozenMap
```
public static DataType frozenMap(DataType keyType,
                 DataType valueType)
```
    Returns the type of frozen maps of keyType to valueType elements.
    This is a shorthand for map(keyType, valueType, true);.
    
    Parameters:
    keyType - the type of the map keys.
    valueType - the type of the map values.
    
    Returns:
    the type of frozen maps of keyType to valueType elements.
  - custom
```
public static DataType custom(String typeClassName)
```
    Returns a Custom type.
    A custom type is defined by the name of the class used on the Cassandra side to implement it. Note that the support for custom type by the driver is limited: values of a custom type won't be interpreted by the driver in any way. They will thus have to be set (by BoundStatement.setBytesUnsafe(int, java.nio.ByteBuffer) and retrieved (by Row.getBytesUnsafe(int)) as raw ByteBuffer.
    The use of custom types is rarely useful and is thus not encouraged.
    
    Parameters:
    typeClassName - the server-side fully qualified class name for the type.
    
    Returns:
    the custom type for typeClassName.
  - getName
```
public DataType.Name getName()
```
    Returns the name of that type.
    
    Returns:
    the name of that type.
  - isFrozen
```
public abstract boolean isFrozen()
```
    Returns whether this data type is frozen.
    This applies to User Defined Types, tuples and nested collections. Frozen types are serialized as a single value in Cassandra's storage engine, whereas non-frozen types are stored in a form that allows updates to individual subfields.
    
    Returns:
    whether this data type is frozen.
  - getTypeArguments
```
public List<DataType> getTypeArguments()
```
    Returns the type arguments of this type.
    Note that only the collection types (LIST, MAP, SET) have type arguments. For the other types, this will return an empty list.
    For the collection types:
    - For lists and sets, this method returns one argument, the type of the elements.
    - For maps, this method returns two arguments, the first one is the type of the map keys, the second one is the type of the map values.
    Returns:
    an immutable list containing the type arguments of this type.
  - getCustomTypeClassName
```
public String getCustomTypeClassName()
```
    Returns the server-side class name for a custom type.
    
    Returns:
    the server-side fully qualified class name for a custom type or null for any other type.
  - parse
```
public Object parse(String value)
```
    Parses a string CQL value for the type this object represent, returning its value as a Java object.
    
    Parameters:
    value - the value to parse.
    
    Returns:
    a java object representing value. If value == null, then null is returned.
    
    Throws:
    
    InvalidTypeException - if value is not a valid CQL string representation for this type. Please note that values for custom types can never be parsed and will always return this exception.
  - format
```
public String format(Object value)
```
    Format a Java object as an equivalent CQL value.
    
    Parameters:
    value - the value to format.
    
    Returns:
    a string corresponding to the CQL representation of value.
    
    Throws:
    
    InvalidTypeException - if value does not correspond to a CQL value (known by the driver). Please note that for custom types this method will always return this exception.
  - isCollection
```
public boolean isCollection()
```
    Returns whether this type is a collection one, i.e. a list, set or map type.
    
    Returns:
    whether this type is a collection one.
  - asJavaClass
```
public Class<?> asJavaClass()
```
    Returns the Java Class corresponding to this type. This is a shortcut for getName().asJavaClass().
    
    Returns:
    the java Class corresponding to this type.
    See Also:
    DataType.Name.asJavaClass()
  - allPrimitiveTypes
```
public static Set<DataType> allPrimitiveTypes()
```
    Returns a set of all the primitive types, where primitive types are defined as the types that don't have type arguments (that is excluding lists, sets, and maps).
    
    Returns:
    returns a set of all the primitive types.
  - serialize
```
public ByteBuffer serialize(Object value,
                   ProtocolVersion protocolVersion)
```
    Serialize a value of this type to bytes, with the given protocol version.
    The actual format of the resulting bytes will correspond to the Cassandra encoding for this type (for the requested protocol version).
    
    Parameters:
    value - the value to serialize.
    protocolVersion - the protocol version to use when serializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).
    
    Returns:
    the value serialized, or null if value is null.
    
    Throws:
    
    InvalidTypeException - if value is not a valid object for this DataType.
  - serialize
```
@Deprecated
public ByteBuffer serialize(Object value,
                              int protocolVersion)
```
    Deprecated. This method is provided for backward compatibility. Use serialize(Object, ProtocolVersion) instead.
    
    Serialize a value of this type to bytes, with the given numeric protocol version.
    
    Throws:
    
    IllegalArgumentException - if protocolVersion does not correspond to any known version.
  - serialize
```
@Deprecated
public ByteBuffer serialize(Object value)
```
    Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws UnsupportedOperationException. Use serialize(Object, ProtocolVersion) instead.
  - deserialize
```
public Object deserialize(ByteBuffer bytes,
                 ProtocolVersion protocolVersion)
```
    Deserialize a value of this type from the provided bytes using the given protocol version.
    
    Parameters:
    bytes - bytes holding the value to deserialize.
    protocolVersion - the protocol version to use when deserializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).
    
    Returns:
    the deserialized value (of class this.asJavaClass()). Will return null if either bytes is null or if bytes.remaining() == 0 and this type has no value corresponding to an empty byte buffer (the latter somewhat strange behavior is due to the fact that for historical/technical reason, Cassandra types always accept empty byte buffer as valid value of those type, and so we avoid throwing an exception in that case. It is however highly discouraged to store empty byte buffers for types for which it doesn't make sense, so this detail can generally be ignored).
    
    Throws:
    
    InvalidTypeException - if bytes is not a valid encoding of an object of this DataType.
  - deserialize
```
public Object deserialize(ByteBuffer bytes,
                 int protocolVersion)
```
    Deprecated. This method is provided for backward compatibility. Use deserialize(ByteBuffer,ProtocolVersion) instead.
    
    Deserialize a value of this type from the provided bytes using the given numeric protocol version.
    
    Throws:
    
    IllegalArgumentException - if protocolVersion does not correspond to any known version.
  - deserialize
```
@Deprecated
public Object deserialize(ByteBuffer bytes)
```
    Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws UnsupportedOperationException. Use deserialize(ByteBuffer, ProtocolVersion) instead.
  - serializeValue
```
public static ByteBuffer serializeValue(Object value,
                        ProtocolVersion protocolVersion)
```
    Serialize an object based on its java class.
    This is equivalent to serialize(java.lang.Object, com.datastax.driver.core.ProtocolVersion) but with the difference that the actual DataType of the resulting value is inferred from the java class of value. The correspondence between CQL DataType and java class used is the one induced by the method DataType.Name.asJavaClass(). Note that if you know the DataType of value, you should use the serialize(java.lang.Object, com.datastax.driver.core.ProtocolVersion) method instead as it is going to be faster.
    
    Parameters:
    value - the value to serialize.
    protocolVersion - the protocol version to use when deserializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).
    
    Returns:
    the value serialized, or null if value is null.
    
    Throws:
    
    IllegalArgumentException - if value is not of a type corresponding to a CQL3 type, i.e. is not a Class that could be returned by asJavaClass().
  - serializeValue
```
@Deprecated
public static ByteBuffer serializeValue(Object value,
                                   int protocolVersion)
```
    Deprecated. This method is provided for backward compatibility. Use serializeValue(Object, ProtocolVersion) instead.
    
    Serialize an object based on its java class, with the given numeric protocol version.
    
    Throws:
    
    IllegalArgumentException - if protocolVersion does not correspond to any known version.
  - serializeValue
```
@Deprecated
public static ByteBuffer serializeValue(Object value)
```
    Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws UnsupportedOperationException. Use serializeValue(Object, ProtocolVersion) instead.

Class DataType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

Constructor Detail

DataType

Method Detail

ascii

bigint

blob

cboolean

counter

decimal

cdouble

cfloat

inet

cint

text

timestamp

uuid

varchar

varint

timeuuid

list

list

frozenList

set

set

frozenSet

map

map

frozenMap

custom

getName

isFrozen

getTypeArguments

getCustomTypeClassName

parse

format

isCollection

asJavaClass

allPrimitiveTypes

serialize

serialize

serialize

deserialize

deserialize

deserialize

serializeValue

serializeValue

serializeValue