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

Interface CustomType

All Superinterfaces:

DataType, Detachable

public interface CustomType
extends DataType

Method Summary

Modifier and Type	Method and Description
default String	asCql(boolean includeFrozen, boolean pretty) Builds an appropriate representation for use in a CQL query.
String	getClassName() The fully qualified name of the subtype of org.apache.cassandra.db.marshal.AbstractType that represents this type server-side.
default int	getProtocolCode() The code of the data type in the native protocol specification.

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

attach, isDetached

Method Detail

getClassName

@NonNull
String getClassName()

The fully qualified name of the subtype of org.apache.cassandra.db.marshal.AbstractType that represents this type server-side.

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).

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