com.datastax.oss.driver.api.core.type

Interface UserDefinedType

All Superinterfaces:

DataType, Describable, Detachable

public interface UserDefinedType
extends DataType, Describable

Method Summary

Modifier and Type	Method and Description
default List<Integer>	allIndicesOf(CqlIdentifier id)
default List<Integer>	allIndicesOf(String name)
default String	asCql(boolean includeFrozen, boolean pretty) Builds an appropriate representation for use in a CQL query.
default boolean	contains(CqlIdentifier id)
default boolean	contains(String name)
UserDefinedType	copy(boolean newFrozen)
default String	describe(boolean pretty) Returns a single CQL statement that creates the element.
default String	describeWithChildren(boolean pretty) Returns a CQL script that creates the element and all of its children.
int	firstIndexOf(CqlIdentifier id)
int	firstIndexOf(String name)
AttachmentPoint	getAttachmentPoint()
List<CqlIdentifier>	getFieldNames()
List<DataType>	getFieldTypes()
CqlIdentifier	getKeyspace()
CqlIdentifier	getName()
default int	getProtocolCode() The code of the data type in the native protocol specification.
boolean	isFrozen()
UdtValue	newValue()
UdtValue	newValue(Object... fields) Creates a new instance with the specified values for the fields.

Methods inherited from interface com.datastax.oss.driver.api.core.detach.Detachable

attach, isDetached

Method Detail

getKeyspace

@Nullable
CqlIdentifier getKeyspace()

getName

@NonNull
CqlIdentifier getName()

isFrozen

boolean isFrozen()

getFieldNames

@NonNull
List<CqlIdentifier> getFieldNames()

allIndicesOf

@NonNull
default List<Integer> allIndicesOf(@NonNull
                                            CqlIdentifier id)

API note:

the default implementation only exists for backward compatibility. It wraps the result of firstIndexOf(CqlIdentifier) in a singleton list, which is not entirely correct, as it will only return the first occurrence. Therefore it also logs a warning.

Implementors should always override this method (all built-in driver implementations do).

firstIndexOf

int firstIndexOf(@NonNull
                 CqlIdentifier id)

allIndicesOf

@NonNull
default List<Integer> allIndicesOf(@NonNull
                                            String name)

API note:

the default implementation only exists for backward compatibility. It wraps the result of firstIndexOf(String) in a singleton list, which is not entirely correct, as it will only return the first occurrence. Therefore it also logs a warning.

Implementors should always override this method (all built-in driver implementations do).

firstIndexOf

int firstIndexOf(@NonNull
                 String name)

contains

default boolean contains(@NonNull
                         CqlIdentifier id)

contains

default boolean contains(@NonNull
                         String name)

getFieldTypes

@NonNull
List<DataType> getFieldTypes()

copy

@NonNull
UserDefinedType copy(boolean newFrozen)

newValue

@NonNull
UdtValue newValue()

newValue

@NonNull
UdtValue newValue(@NonNull
                           Object... fields)

Creates a new instance with the specified values for the fields.

To encode the values, this method uses the CodecRegistry that this type is attached to; it looks for the best codec to handle the target CQL type and actual runtime type of each value (see CodecRegistry.codecFor(DataType, Object)).

Parameters:

fields - the value of the fields. They must be in the same order as the fields in the type's definition. You can specify less values than there are fields (the remaining ones will be set to NULL), but not more (a runtime exception will be thrown). Individual values can be null, but the array itself can't.

Throws:

IllegalArgumentException - if there are too many values.

getAttachmentPoint

@NonNull
AttachmentPoint getAttachmentPoint()

asCql

@NonNull
default String asCql(boolean includeFrozen,
                              boolean pretty)

Description copied from interface: DataType

Builds an appropriate representation for use in a CQL query.

Specified by:

asCql in interface DataType

Parameters:

includeFrozen - whether to include the frozen<...> keyword if applicable. This will need to be set depending on where the result is used: for example, CREATE TABLE statements use the frozen keyword, whereas it should never appear in CREATE FUNCTION.

pretty - whether to pretty-print UDT names (as described in CqlIdentifier.asCql(boolean).

describe

@NonNull
default String describe(boolean pretty)

Description copied from interface: Describable

Returns a single CQL statement that creates the element.

Specified by:

describe in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return the statement on a single line with minimal formatting.

describeWithChildren

@NonNull
default String describeWithChildren(boolean pretty)

Description copied from interface: Describable

Returns a CQL script that creates the element and all of its children. For example: a schema with its tables, materialized views, types, etc. A table with its indices.

Specified by:

describeWithChildren in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return each statement on a single line with minimal formatting.

getProtocolCode

default int getProtocolCode()

Description copied from interface: DataType

The code of the data type in the native protocol specification.

Specified by:

getProtocolCode in interface DataType