DataTypeEnum (Cassandra JDBC Wrapper 4.13.0 API)

java.lang.Object
- java.lang.Enum<DataTypeEnum>
- - com.ing.data.cassandra.jdbc.types.DataTypeEnum

All Implemented Interfaces:

VersionedMetadata, Serializable, Comparable<DataTypeEnum>
```
public enum DataTypeEnum
extends Enum<DataTypeEnum>
implements VersionedMetadata
```
Enumeration of CQL data types and the corresponding Java types.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ASCII` `ascii` CQL type (type in CQL native protocol) mapped to `String` Java type.
`BIGINT` `bigint` CQL type (type in CQL native protocol) mapped to `Long` Java type.
`BLOB` `blob` CQL type (type in CQL native protocol) mapped to `ByteBuffer` Java type.
`BOOLEAN` `boolean` CQL type (type in CQL native protocol) mapped to `Boolean` Java type.
`COUNTER` `counter` CQL type (type in CQL native protocol) mapped to `Long` Java type.
`CUSTOM` `custom` CQL type (type in CQL native protocol) mapped to `ByteBuffer` Java type.
`DATE` `date` CQL type (type in CQL native protocol) mapped to `Date` Java type.
`DECIMAL` `decimal` CQL type (type in CQL native protocol) mapped to `BigDecimal` Java type.
`DOUBLE` `double` CQL type (type in CQL native protocol) mapped to `Double` Java type.
`DURATION` `duration` CQL type (type in CQL native protocol) mapped to `CqlDuration` Java type.
`FLOAT` `float` CQL type (type in CQL native protocol) mapped to `Float` Java type.
`INET` `inet` CQL type (type in CQL native protocol) mapped to `InetAddress` Java type.
`INT` `int` CQL type (type in CQL native protocol) mapped to `Integer` Java type.
`LIST` `list` CQL type (type in CQL native protocol) mapped to `List` Java type.
`MAP` `map` CQL type (type in CQL native protocol) mapped to `Map` Java type.
`SET` `set` CQL type (type in CQL native protocol) mapped to `Set` Java type.
`SMALLINT` `smallint` CQL type (type in CQL native protocol) mapped to `Short` Java type.
`TEXT` `text` CQL type (type in CQL native protocol) mapped to `String` Java type.
`TIME` `time` CQL type (type in CQL native protocol) mapped to `Time` Java type.
`TIMESTAMP` `timestamp` CQL type (type in CQL native protocol) mapped to `Timestamp` Java type.
`TIMEUUID` `timeuuid` CQL type (type in CQL native protocol) mapped to `UUID` Java type.
`TINYINT` `tinyint` CQL type (type in CQL native protocol) mapped to `Byte` Java type.
`TUPLE` `tuple` CQL type (type in CQL native protocol) mapped to `TupleValue` Java type.
`UDT` `udt` CQL type (type in CQL native protocol) mapped to `UdtValue` Java type.
`UUID` `uuid` CQL type (type in CQL native protocol) mapped to `UUID` Java type.
`VARCHAR` `varchar` CQL type (type in CQL native protocol) mapped to `String` Java type.
`VARINT` `varint` CQL type (type in CQL native protocol) mapped to `BigInteger` Java type.
`VECTOR` `vector` CQL type (type in CQL native protocol) mapped to `CqlVector` Java type.

Field Summary

Fields
Modifier and Type Field and Description

String cqlType
Gets the CQL type corresponding to the enum value.

Class<?> javaType
Gets the Java type corresponding to the enum value.

Fields
Modifier and Type	Field and Description
`String`	`cqlType` Gets the CQL type corresponding to the enum value.
`Class<?>`	`javaType` Gets the Java type corresponding to the enum value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Class<?>`	`asJavaClass()` Returns the Java Class corresponding to this CQL type name.
`String`	`asLowercaseCql()` Returns the CQL type name to lower case.
`static String`	`cqlName(com.datastax.oss.driver.api.core.type.DataType dataType)` Gets the CQL name from a given `DataType` instance.
`static DataTypeEnum`	`fromCqlTypeName(String cqlTypeName)` Gets an enumeration item from a CQL type name.
`static DataTypeEnum`	`fromDataType(com.datastax.oss.driver.api.core.type.DataType dataType)` Gets an enumeration item from a CQL data type.
`String`	`getName()` Gets the metadata name (for example a CQL keyword, or a built-in function name).
`boolean`	`isCollection()` Returns whether this data type name represents the name of a collection type (i.e.
`org.semver4j.Semver`	`isInvalidFrom()` Gets the first Cassandra version in which the metadata does not exist anymore.
`org.semver4j.Semver`	`isValidFrom()` Gets the minimal Cassandra version from which the metadata exists.
`String`	`toString()`
`static DataTypeEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DataTypeEnum[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail
- ASCII
```
public static final DataTypeEnum ASCII
```
  ascii CQL type (type in CQL native protocol) mapped to String Java type.
- BIGINT
```
public static final DataTypeEnum BIGINT
```
  bigint CQL type (type in CQL native protocol) mapped to Long Java type.
- BLOB
```
public static final DataTypeEnum BLOB
```
  blob CQL type (type in CQL native protocol) mapped to ByteBuffer Java type.
- BOOLEAN
```
public static final DataTypeEnum BOOLEAN
```
  boolean CQL type (type in CQL native protocol) mapped to Boolean Java type.
- COUNTER
```
public static final DataTypeEnum COUNTER
```
  counter CQL type (type in CQL native protocol) mapped to Long Java type.
- CUSTOM
```
public static final DataTypeEnum CUSTOM
```
  custom CQL type (type in CQL native protocol) mapped to ByteBuffer Java type.
- DATE
```
public static final DataTypeEnum DATE
```
  date CQL type (type in CQL native protocol) mapped to Date Java type.
- DECIMAL
```
public static final DataTypeEnum DECIMAL
```
  decimal CQL type (type in CQL native protocol) mapped to BigDecimal Java type.
- DOUBLE
```
public static final DataTypeEnum DOUBLE
```
  double CQL type (type in CQL native protocol) mapped to Double Java type.
- DURATION
```
public static final DataTypeEnum DURATION
```
  duration CQL type (type in CQL native protocol) mapped to CqlDuration Java type.
- FLOAT
```
public static final DataTypeEnum FLOAT
```
  float CQL type (type in CQL native protocol) mapped to Float Java type.
- INET
```
public static final DataTypeEnum INET
```
  inet CQL type (type in CQL native protocol) mapped to InetAddress Java type.
- INT
```
public static final DataTypeEnum INT
```
  int CQL type (type in CQL native protocol) mapped to Integer Java type.
- LIST
```
public static final DataTypeEnum LIST
```
  list CQL type (type in CQL native protocol) mapped to List Java type.
- MAP
```
public static final DataTypeEnum MAP
```
  map CQL type (type in CQL native protocol) mapped to Map Java type.
- SET
```
public static final DataTypeEnum SET
```
  set CQL type (type in CQL native protocol) mapped to Set Java type.
- SMALLINT
```
public static final DataTypeEnum SMALLINT
```
  smallint CQL type (type in CQL native protocol) mapped to Short Java type.
- TEXT
```
public static final DataTypeEnum TEXT
```
  text CQL type (type in CQL native protocol) mapped to String Java type.
- TIME
```
public static final DataTypeEnum TIME
```
  time CQL type (type in CQL native protocol) mapped to Time Java type.
- TIMESTAMP
```
public static final DataTypeEnum TIMESTAMP
```
  timestamp CQL type (type in CQL native protocol) mapped to Timestamp Java type.
- TIMEUUID
```
public static final DataTypeEnum TIMEUUID
```
  timeuuid CQL type (type in CQL native protocol) mapped to UUID Java type.
- TINYINT
```
public static final DataTypeEnum TINYINT
```
  tinyint CQL type (type in CQL native protocol) mapped to Byte Java type.
- TUPLE
```
public static final DataTypeEnum TUPLE
```
  tuple CQL type (type in CQL native protocol) mapped to TupleValue Java type.
- UDT
```
public static final DataTypeEnum UDT
```
  udt CQL type (type in CQL native protocol) mapped to UdtValue Java type.
- UUID
```
public static final DataTypeEnum UUID
```
  uuid CQL type (type in CQL native protocol) mapped to UUID Java type.
- VARCHAR
```
public static final DataTypeEnum VARCHAR
```
  varchar CQL type (type in CQL native protocol) mapped to String Java type.
- VARINT
```
public static final DataTypeEnum VARINT
```
  varint CQL type (type in CQL native protocol) mapped to BigInteger Java type.
- VECTOR
```
public static final DataTypeEnum VECTOR
```
  vector CQL type (type in CQL native protocol) mapped to CqlVector Java type.

Field Detail
- javaType
```
public final Class<?> javaType
```
  Gets the Java type corresponding to the enum value.
- cqlType
```
public final String cqlType
```
  Gets the CQL type corresponding to the enum value.

Method Detail

values
```
public static DataTypeEnum[] values()
```
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DataTypeEnum c : DataTypeEnum.values())
    System.out.println(c);
```
Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf
```
public static DataTypeEnum valueOf(String name)
```
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromCqlTypeName
```
public static DataTypeEnum fromCqlTypeName(String cqlTypeName)
```
Gets an enumeration item from a CQL type name.

Parameters:

cqlTypeName - The CQL type name.

Returns:

The enumeration item corresponding to the given CQL type name.

fromDataType
```
public static DataTypeEnum fromDataType(com.datastax.oss.driver.api.core.type.DataType dataType)
```
Gets an enumeration item from a CQL data type.

Parameters:

dataType - The CQL data type.

Returns:

The enumeration item corresponding to the given CQL data type.

isCollection
```
public boolean isCollection()
```
Returns whether this data type name represents the name of a collection type (i.e. that is a list, set, vector or map).

Returns:

true if this data type name represents the name of a collection type, false otherwise.

asJavaClass

public Class<?> asJavaClass()

Returns the Java Class corresponding to this CQL type name.
The correspondence between CQL types and Java ones is as follows:

DataType to Java class correspondence
CQL DataType	Java class
ASCII	`String`
BIGINT	`Long`
BLOB	`ByteBuffer`
BOOLEAN	`Boolean`
COUNTER	`Long`
CUSTOM	`ByteBuffer`
DATE	`Date`
DECIMAL	`BigDecimal`
DOUBLE	`Double`
DURATION	`CqlDuration`(*)
FLOAT	`Float`
INET	`InetAddress`
INT	`Integer`
LIST	`List`
MAP	`Map`
SET	`Set`
SMALLINT	`Short`
TEXT	`String`
TIME	`Time`
TIMESTAMP	`Timestamp`
TIMEUUID	`UUID`
TINYINT	`Byte`
TUPLE	`TupleValue`
UDT	`UdtValue`
UUID	`UUID`
VARCHAR	`String`
VARINT	`BigInteger`
VECTOR	`CqlVector`

(*) See temporal types documentation about the management of CQL durations in Java.

Returns:: the Java class corresponding to this CQL type name.

asLowercaseCql
```
public String asLowercaseCql()
```
Returns the CQL type name to lower case.

Returns:

The CQL type name to lower case.

toString
```
public String toString()
```
Overrides:

toString in class Enum<DataTypeEnum>

getName
```
public String getName()
```
Description copied from interface: VersionedMetadata

Gets the metadata name (for example a CQL keyword, or a built-in function name).

Specified by:

getName in interface VersionedMetadata

Returns:

The metadata name.

isValidFrom
```
public org.semver4j.Semver isValidFrom()
```
Description copied from interface: VersionedMetadata

Gets the minimal Cassandra version from which the metadata exists. If null, we consider the metadata always existed.

Specified by:

isValidFrom in interface VersionedMetadata

Returns:

The minimal version of Cassandra from which the metadata exists or null.

isInvalidFrom
```
public org.semver4j.Semver isInvalidFrom()
```
Description copied from interface: VersionedMetadata

Gets the first Cassandra version in which the metadata does not exist anymore. If null, it means the metadata still exists in the latest version of Cassandra.

Specified by:

isInvalidFrom in interface VersionedMetadata

Returns:

The first version of Cassandra in which the metadata does not exist anymore or null.

cqlName
```
public static String cqlName(@Nonnull
                             com.datastax.oss.driver.api.core.type.DataType dataType)
```
Gets the CQL name from a given DataType instance. For vectors, dataType.asCql returns looks like 'org.apache.cassandra.db.marshal.VectorType(n)' where n is the dimension of the vector. In this specific case, return a common name not including the dimension.

Parameters:

dataType - The data type.

Returns:

The CQL name of the type.

Enum DataTypeEnum

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ASCII

BIGINT

BLOB

BOOLEAN

COUNTER

CUSTOM

DATE

DECIMAL

DOUBLE

DURATION

FLOAT

INET

INT

LIST

MAP

SET

SMALLINT

TEXT

TIME

TIMESTAMP

TIMEUUID

TINYINT

TUPLE

UDT

UUID

VARCHAR

VARINT

VECTOR

Field Detail

javaType

cqlType

Method Detail

values

valueOf

fromCqlTypeName

fromDataType

isCollection

asJavaClass

asLowercaseCql

toString

getName

isValidFrom

isInvalidFrom

cqlName