ColumnType (Spring Data for Apache Cassandra Core 3.1.3 API)

All Known Subinterfaces:

CassandraColumnType
```
public interface ColumnType
```
Interface to access column type information. The CassandraColumnType subtype exposes Cassandra-specific DataType information.

Since:

3.0

Author:

Mark Paluch

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ColumnType`	`create(Class<?> type)` Creates a `ColumnType` for a `Class`.
`static CassandraColumnType`	`create(Class<?> type, com.datastax.oss.driver.api.core.type.DataType dataType)` Creates a `ColumnType` for a `Class` and `DataType`.
`static ColumnType`	`create(TypeInformation<?> type)` Creates a `ColumnType` for a `TypeInformation`.
`ColumnType`	`getComponentType()` Returns the component type for `Collection`s or the key type for `Map`s.
`ColumnType`	`getMapValueType()` Returns the map value type in case the underlying type is a `Map`.
`default ColumnType`	`getRequiredComponentType()` Returns the component type for `Collection`s, the key type for `Map`s or the single generic type if available.
`default ColumnType`	`getRequiredMapValueType()` Returns the map value type in case the underlying type is a `Map`. or throw `IllegalStateException` if the map value type cannot be resolved.
`Class<?>`	`getType()` Returns the Java type of the column.
`boolean`	`isCollectionLike()` Returns whether the type can be considered a collection, which means it's a container of elements, e.g. a `Collection` and `Array` or anything implementing `Iterable`.
`boolean`	`isList()` Returns whether the property is a `List`.
`boolean`	`isMap()` Returns whether the property is a `Map`.
`boolean`	`isSet()` Returns whether the property is a `Set`.
`static CassandraColumnType`	`listOf(CassandraColumnType componentType)` Creates a List `ColumnType` given its `component type`.
`static CassandraColumnType`	`listOf(CassandraColumnType componentType, boolean frozen)` Creates a List `ColumnType` given its `component type`.
`static ColumnType`	`listOf(ColumnType componentType)` Creates a List `ColumnType` given its `component type`.
`static CassandraColumnType`	`mapOf(CassandraColumnType keyType, CassandraColumnType valueType)` Creates a Map `CassandraColumnType` given its `key and value types`.
`static ColumnType`	`mapOf(ColumnType keyType, ColumnType valueType)` Creates a Map `ColumnType` given its `key and value types`.
`static CassandraColumnType`	`setOf(CassandraColumnType componentType)` Creates a Set `ColumnType` given its `component type`.
`static CassandraColumnType`	`setOf(CassandraColumnType componentType, boolean frozen)` Creates a Set `ColumnType` given its `component type`.
`static ColumnType`	`setOf(ColumnType componentType)` Creates a Set `ColumnType` given its `component type`.
`static CassandraColumnType`	`tupleOf(com.datastax.oss.driver.api.core.type.TupleType dataType)` Creates a Tuple `CassandraColumnType` given its `Cassandra type`.
`static CassandraColumnType`	`udtOf(com.datastax.oss.driver.api.core.type.UserDefinedType dataType)` Creates a UDT `CassandraColumnType` given its `Cassandra type`.

- Method Detail
  - create
```
static ColumnType create(Class<?> type)
```
    Creates a ColumnType for a Class.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
  - create
```
static ColumnType create(TypeInformation<?> type)
```
    Creates a ColumnType for a TypeInformation.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
  - create
```
static CassandraColumnType create(Class<?> type,
                                  com.datastax.oss.driver.api.core.type.DataType dataType)
```
    Creates a ColumnType for a Class and DataType.
    
    Parameters:
    
    type - must not be null.
    
    dataType - must not be null.
    
    Returns:
  - listOf
```
static ColumnType listOf(ColumnType componentType)
```
    Creates a List ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    Returns:
  - listOf
```
static CassandraColumnType listOf(CassandraColumnType componentType)
```
    Creates a List ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    Returns:
  - listOf
```
static CassandraColumnType listOf(CassandraColumnType componentType,
                                  boolean frozen)
```
    Creates a List ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    frozen -
    
    Returns:
  - setOf
```
static ColumnType setOf(ColumnType componentType)
```
    Creates a Set ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    Returns:
  - setOf
```
static CassandraColumnType setOf(CassandraColumnType componentType)
```
    Creates a Set ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    Returns:
  - setOf
```
static CassandraColumnType setOf(CassandraColumnType componentType,
                                 boolean frozen)
```
    Creates a Set ColumnType given its component type.
    
    Parameters:
    
    componentType - must not be null.
    
    frozen -
    
    Returns:
  - mapOf
```
static ColumnType mapOf(ColumnType keyType,
                        ColumnType valueType)
```
    Creates a Map ColumnType given its key and value types.
    
    Parameters:
    
    keyType - must not be null.
    
    valueType - must not be null.
    
    Returns:
  - mapOf
```
static CassandraColumnType mapOf(CassandraColumnType keyType,
                                 CassandraColumnType valueType)
```
    Creates a Map CassandraColumnType given its key and value types.
    
    Parameters:
    
    keyType - must not be null.
    
    valueType - must not be null.
    
    Returns:
  - udtOf
```
static CassandraColumnType udtOf(com.datastax.oss.driver.api.core.type.UserDefinedType dataType)
```
    Creates a UDT CassandraColumnType given its Cassandra type.
    
    Parameters:
    
    dataType - must not be null.
    
    Returns:
  - tupleOf
```
static CassandraColumnType tupleOf(com.datastax.oss.driver.api.core.type.TupleType dataType)
```
    Creates a Tuple CassandraColumnType given its Cassandra type.
    
    Parameters:
    
    dataType - must not be null.
    
    Returns:
  - getType
```
Class<?> getType()
```
    Returns the Java type of the column.
    
    Returns:
  - isCollectionLike
```
boolean isCollectionLike()
```
    Returns whether the type can be considered a collection, which means it's a container of elements, e.g. a Collection and Array or anything implementing Iterable. If this returns true you can expect getComponentType() to return a non-null value.
    
    Returns:
  - isList
```
boolean isList()
```
    Returns whether the property is a List. If this returns true you can expect getComponentType() to return something not null.
    
    Returns:
  - isSet
```
boolean isSet()
```
    Returns whether the property is a Set. If this returns true you can expect getComponentType() to return something not null.
    
    Returns:
  - isMap
```
boolean isMap()
```
    Returns whether the property is a Map. If this returns true you can expect getComponentType() as well as getMapValueType() to return something not null.
    
    Returns:
  - getComponentType
```
@Nullable
ColumnType getComponentType()
```
    Returns the component type for Collections or the key type for Maps.
    
    Returns:
  - getRequiredComponentType
```
default ColumnType getRequiredComponentType()
```
    Returns the component type for Collections, the key type for Maps or the single generic type if available. Throws IllegalStateException if the component value type cannot be resolved.
    
    Returns:
    
    Throws:
    
    IllegalStateException - if the component type cannot be resolved, e.g. if a raw type is used or the type is not generic in the first place.
  - getMapValueType
```
@Nullable
ColumnType getMapValueType()
```
    Returns the map value type in case the underlying type is a Map.
    
    Returns:
  - getRequiredMapValueType
```
default ColumnType getRequiredMapValueType()
```
    Returns the map value type in case the underlying type is a Map. or throw IllegalStateException if the map value type cannot be resolved.
    
    Returns:
    
    Throws:
    
    IllegalStateException - if the map value type cannot be resolved, usually due to the current Map type being a raw one.

Interface ColumnType

Method Summary

Method Detail

create

create

create

listOf

listOf

listOf

setOf

setOf

setOf

mapOf

mapOf

udtOf

tupleOf

getType

isCollectionLike

isList

isSet

isMap

getComponentType

getRequiredComponentType

getMapValueType

getRequiredMapValueType