org.helenus.driver.impl

Class DataTypeImpl.Definition

java.lang.Object

org.helenus.driver.impl.DataTypeImpl.Definition

All Implemented Interfaces:

CQLDataType

Enclosing class:

DataTypeImpl

public static class DataTypeImpl.Definition
extends Object
implements CQLDataType

The Definition class provides a data type definition for a CQL data type.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2017 The Helenus Driver Project Authors

Field Summary

Fields

Modifier and Type	Field and Description
com.datastax.driver.core.DataType	dtype Holds the corresponding Datastax data type.
boolean	isFrozen Holds a flag indicating if this definition is frozen or not.

Constructor Summary

Constructors

Constructor and Description
Definition(DataType type) Instantiates a new Definition object.
Definition(StatementManagerImpl mgr, DataType type, List<CQLDataType> arguments, boolean isFrozen) Instantiates a new Definition object.
Definition(StatementManagerImpl mgr, List<CQLDataType> types, boolean isFrozen) Instantiates a new Definition object.

Method Summary

Modifier and Type	Method and Description
List<CQLDataType>	getArgumentTypes()
com.datastax.driver.core.TypeCodec<?>	getCodec(Class<?> clazz, com.datastax.driver.core.CodecRegistry codecRegistry) Gets a codec for this collection data type to decode to the specified class.
com.datastax.driver.core.TypeCodec<?>	getCodec(Field field, boolean mandatory, com.datastax.driver.core.CodecRegistry codecRegistry) Gets a codec for this data type to decode to the specified field.
com.datastax.driver.core.DataType	getDataType()
CQLDataType	getElementType()
CQLDataType	getFirstArgumentType()
CQLDataType	getMainType()
boolean	isAlterableTo(CQLDataType to)
boolean	isCollection()
boolean	isFrozen()
boolean	isTuple()
boolean	isUserDefined()
String	name()
String	toCQL()
String	toString()
java.util.stream.Stream<UDTClassInfoImpl<?>>	udts() Gets all user-defined types this definition is dependent on.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

dtype

public final com.datastax.driver.core.DataType dtype

Holds the corresponding Datastax data type.

isFrozen

public final boolean isFrozen

Holds a flag indicating if this definition is frozen or not.

Note: Only applies to collections.

Constructor Detail

Definition

public Definition(DataType type)

Instantiates a new Definition object.

Parameters:

type - the non-null primitive data type for this definition

Throws:

IllegalArgumentException - if the data type is not a primitive one

Definition

public Definition(StatementManagerImpl mgr,
                  DataType type,
                  List<CQLDataType> arguments,
                  boolean isFrozen)

Instantiates a new Definition object.

Parameters:

mgr - the non-null statement manager

type - the non-null data type for this definition

arguments - the non-null list of arguments' data types if the type represents a collection (may be empty)

isFrozen - true if the data type is frozen; false otherwise

Throws:

IllegalArgumentException - if the argument list is empty and the data type is not a primitive one

Definition

public Definition(StatementManagerImpl mgr,
                  List<CQLDataType> types,
                  boolean isFrozen)

Instantiates a new Definition object.

Parameters:

mgr - the non-null statement manager

types - the non-null list of data types for this definition (the first one correspond to the data type and the remaining are the argument data types)

isFrozen - true if the data type is frozen; false otherwise

Throws:

IllegalArgumentException - if remaining argument list is empty and the data type is not a primitive one

Method Detail

name

public String name()

Specified by:

name in interface CQLDataType

See Also:

CQLDataType.name()

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface CQLDataType

See Also:

CQLDataType.isFrozen()

isCollection

public boolean isCollection()

Specified by:

isCollection in interface CQLDataType

See Also:

CQLDataType.isCollection()

isTuple

public boolean isTuple()

Specified by:

isTuple in interface CQLDataType

See Also:

CQLDataType.isTuple()

isUserDefined

public boolean isUserDefined()

Specified by:

isUserDefined in interface CQLDataType

See Also:

CQLDataType.isUserDefined()

getDataType

public com.datastax.driver.core.DataType getDataType()

Specified by:

getDataType in interface CQLDataType

See Also:

CQLDataType.getDataType()

getMainType

public CQLDataType getMainType()

Specified by:

getMainType in interface CQLDataType

See Also:

CQLDataType.getMainType()

getElementType

public CQLDataType getElementType()

Specified by:

getElementType in interface CQLDataType

See Also:

CQLDataType.getElementType()

getArgumentTypes

public List<CQLDataType> getArgumentTypes()

Specified by:

getArgumentTypes in interface CQLDataType

See Also:

CQLDataType.getArgumentTypes()

getFirstArgumentType

public CQLDataType getFirstArgumentType()

Specified by:

getFirstArgumentType in interface CQLDataType

See Also:

CQLDataType.getFirstArgumentType()

isAlterableTo

public boolean isAlterableTo(CQLDataType to)

Specified by:

isAlterableTo in interface CQLDataType

See Also:

CQLDataType.isAlterableTo(org.helenus.driver.persistence.CQLDataType)

getCodec

public com.datastax.driver.core.TypeCodec<?> getCodec(Field field,
                                                      boolean mandatory,
                                                      com.datastax.driver.core.CodecRegistry codecRegistry)

Gets a codec for this data type to decode to the specified field.

Parameters:

field - the field decode to its declared type

mandatory - if the field is mandatory or represents a primary key

codecRegistry - the codec registry to use when finding a codec

Returns:

a suitable codec for this data type and given field

Throws:

NullPointerException - if field or codecRegistry is null

IllegalArgumentException - if the combination of field and data types is not supported

getCodec

public com.datastax.driver.core.TypeCodec<?> getCodec(Class<?> clazz,
                                                      com.datastax.driver.core.CodecRegistry codecRegistry)

Gets a codec for this collection data type to decode to the specified class.

Parameters:

clazz - the collection class to decode to its declared super type

codecRegistry - the codec registry to use when finding a codec

Returns:

a suitable codec for this collection data type and given class

Throws:

NullPointerException - if clazz or codecRegistry is null

IllegalArgumentException - if the combination of class and data types is not supported

IllegalStateException - if this definition is not representing a collection

toCQL

public String toCQL()

Specified by:

toCQL in interface CQLDataType

See Also:

CQLDataType.toCQL()

udts

public java.util.stream.Stream<UDTClassInfoImpl<?>> udts()

Gets all user-defined types this definition is dependent on.

Returns:

a stream of all class infos for the user-defined types this definition depends on

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()