Package org.apache.cassandra.db.marshal

Class UserType

java.lang.Object

org.apache.cassandra.db.marshal.AbstractType<ByteBuffer>

org.apache.cassandra.db.marshal.TupleType

org.apache.cassandra.db.marshal.UserType

All Implemented Interfaces:

Comparator<ByteBuffer>, AssignmentTestable, SchemaElement

public class UserType
extends TupleType
implements SchemaElement

A user defined type. A user type is really just a tuple type on steroids.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cassandra.db.marshal.AbstractType

AbstractType.ComparisonType, AbstractType.DefaultArgumentDeserializer

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.AssignmentTestable

AssignmentTestable.TestResult

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.SchemaElement

SchemaElement.SchemaElementType

Field Summary

Fields

Modifier and Type	Field	Description
final String	keyspace
final ByteBuffer	name

Fields inherited from class org.apache.cassandra.db.marshal.TupleType

types

Fields inherited from class org.apache.cassandra.db.marshal.AbstractType

comparatorSet, comparisonType, isByteOrderComparable, reverseComparator

Fields inherited from interface org.apache.cassandra.cql3.SchemaElement

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
UserType(String keyspace, ByteBuffer name, List<FieldIdentifier> fieldNames, List<AbstractType<?>> fieldTypes, boolean isMultiCell)

Method Summary

Modifier and Type	Method	Description
CQL3Type	asCQL3Type()
CellPath	cellPathForField(FieldIdentifier fieldName)
Optional<Difference>	compare(UserType other)
String	elementKeyspace()	Returns the CQL name of the keyspace to which this schema element belong.
String	elementName()	Returns the CQL name of this schema element.
SchemaElement.SchemaElementType	elementType()	Return the schema element type
boolean	equals(Object o)
FieldIdentifier	fieldName(int i)
String	fieldNameAsString(int i)
List<FieldIdentifier>	fieldNames()
int	fieldPosition(FieldIdentifier fieldName)
AbstractType<?>	fieldType(int i)
List<AbstractType<?>>	fieldTypes()
UserType	freeze()
AbstractType<?>	freezeNestedMulticellTypes()	Returns an AbstractType instance that is equivalent to this one, but with all nested UDTs and collections explicitly frozen.
Term	fromJSONObject(Object parsed)	Given a parsed JSON string, return a byte representation of the object.
String	getCqlTypeName()
static UserType	getInstance(TypeParser parser)
String	getNameAsString()
TypeSerializer<ByteBuffer>	getSerializer()
int	hashCode()
boolean	isFreezable()
boolean	isMultiCell()
boolean	isTuple()
boolean	isUDT()
boolean	isValueCompatibleWith(AbstractType<?> previous)	Returns true if values of the other AbstractType can be read and "reasonably" interpreted by the this AbstractType.
ShortType	nameComparator()
boolean	referencesDuration()
<V> boolean	referencesUserType(V name, ValueAccessor<V> accessor)
ByteBuffer	serializeForNativeProtocol(Iterator<Cell<?>> cells, ProtocolVersion protocolVersion)
String	toCqlString(boolean withInternals, boolean ifNotExists)	Returns a CQL representation of this element
String	toJSONString(ByteBuffer buffer, ProtocolVersion protocolVersion)	Converts the specified value into its JSON representation.
String	toString()	This must be overriden by subclasses if necessary so that for any AbstractType, this == TypeParser.parse(toString()).
String	toString(boolean ignoreFreezing)
UserType	unfreeze()
<V> void	validateCell(Cell<V> cell)
UserType	withUpdatedUserType(UserType udt)	Returns an instance of this type with all references to the provided user type recursively replaced with its new definition.

Methods inherited from class org.apache.cassandra.db.marshal.TupleType

allowsEmpty, allTypes, asComparableBytes, buildValue, buildValue, compareCustom, expandUserTypes, fromComparableBytes, fromString, getMaskedValue, getString, isCompatibleWith, isValueCompatibleWithInternal, size, split, split, subTypes, type

Methods inherited from class org.apache.cassandra.db.marshal.AbstractType

asComparableBytes, asCQLTypeStringList, checkComparable, compare, compare, compareCollectionMembers, compareForCQL, compose, compose, decompose, decomposeUntyped, fromComparableBytes, getArgumentDeserializer, getCompatibleTypeIfKnown, getComponents, getString, getString, isCollection, isCounter, isEmptyValueMeaningless, isFrozenCollection, isNull, isNull, isReversed, isSerializationCompatibleWith, isValueLengthFixed, isVector, parseDefaultParameters, read, readArray, readBuffer, readBuffer, referencesUserType, skipValue, testAssignment, testAssignment, toCQLString, toJSONString, udfType, unwrap, validate, validate, validateCellValue, validateCollectionMember, valueLengthIfFixed, writeValue, writeValue, writtenLength, writtenLength

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.apache.cassandra.cql3.SchemaElement

elementKeyspaceQuotedIfNeeded, elementNameQuotedIfNeeded

Field Details

keyspace

public final String keyspace

name

public final ByteBuffer name

Constructor Details

UserType

public UserType(String keyspace,
 ByteBuffer name,
 List<FieldIdentifier> fieldNames,
 List<AbstractType<?>> fieldTypes,
 boolean isMultiCell)

Method Details

getInstance

public static UserType getInstance(TypeParser parser)

isUDT

public boolean isUDT()

Overrides:

isUDT in class AbstractType<ByteBuffer>

isTuple

public boolean isTuple()

Overrides:

isTuple in class TupleType

isMultiCell

public boolean isMultiCell()

Overrides:

isMultiCell in class AbstractType<ByteBuffer>

isFreezable

public boolean isFreezable()

Overrides:

isFreezable in class AbstractType<ByteBuffer>

fieldType

public AbstractType<?> fieldType(int i)

fieldTypes

public List<AbstractType<?>> fieldTypes()

fieldName

public FieldIdentifier fieldName(int i)

fieldNameAsString

public String fieldNameAsString(int i)

fieldNames

public List<FieldIdentifier> fieldNames()

getNameAsString

public String getNameAsString()

fieldPosition

public int fieldPosition(FieldIdentifier fieldName)

cellPathForField

public CellPath cellPathForField(FieldIdentifier fieldName)

nameComparator

public ShortType nameComparator()

serializeForNativeProtocol

public ByteBuffer serializeForNativeProtocol(Iterator<Cell<?>> cells,
 ProtocolVersion protocolVersion)

validateCell

public <V> void validateCell(Cell<V> cell)
                      throws MarshalException

Throws:

MarshalException

fromJSONObject

public Term fromJSONObject(Object parsed)
                    throws MarshalException

Description copied from class: AbstractType

Given a parsed JSON string, return a byte representation of the object.

Overrides:

fromJSONObject in class TupleType

Parameters:

parsed - the result of parsing a json string

Throws:

MarshalException

toJSONString

public String toJSONString(ByteBuffer buffer,
 ProtocolVersion protocolVersion)

Description copied from class: AbstractType

Converts the specified value into its JSON representation.

The buffer position will stay the same.

Overrides:

toJSONString in class TupleType

Parameters:

buffer - the value to convert

protocolVersion - the protocol version to use for the conversion

Returns:

a JSON string representing the specified value

freeze

public UserType freeze()

Overrides:

freeze in class AbstractType<ByteBuffer>

unfreeze

public UserType unfreeze()

Overrides:

unfreeze in class AbstractType<ByteBuffer>

freezeNestedMulticellTypes

public AbstractType<?> freezeNestedMulticellTypes()

Description copied from class: AbstractType

Returns an AbstractType instance that is equivalent to this one, but with all nested UDTs and collections explicitly frozen. This is only necessary for 2.x -> 3.x schema migrations, and can be removed in Cassandra 4.0. See CASSANDRA-11609 and CASSANDRA-11613.

Overrides:

freezeNestedMulticellTypes in class AbstractType<ByteBuffer>

hashCode

public int hashCode()

Overrides:

hashCode in class TupleType

isValueCompatibleWith

public boolean isValueCompatibleWith(AbstractType<?> previous)

Description copied from class: AbstractType

Returns true if values of the other AbstractType can be read and "reasonably" interpreted by the this AbstractType. Note that this is a weaker version of isCompatibleWith, as it does not require that both type compare values the same way. The restriction on the other type being "reasonably" interpreted is to prevent, for example, IntegerType from being compatible with all other types. Even though any byte string is a valid IntegerType value, it doesn't necessarily make sense to interpret a UUID or a UTF8 string as an integer. Note that a type should be compatible with at least itself.

Overrides:

isValueCompatibleWith in class AbstractType<ByteBuffer>

equals

public boolean equals(Object o)

Specified by:

equals in interface Comparator<ByteBuffer>

Overrides:

equals in class TupleType

compare

public Optional<Difference> compare(UserType other)

asCQL3Type

public CQL3Type asCQL3Type()

Overrides:

asCQL3Type in class TupleType

referencesUserType

public <V> boolean referencesUserType(V name,
 ValueAccessor<V> accessor)

Overrides:

referencesUserType in class TupleType

withUpdatedUserType

public UserType withUpdatedUserType(UserType udt)

Description copied from class: AbstractType

Returns an instance of this type with all references to the provided user type recursively replaced with its new definition.

Overrides:

withUpdatedUserType in class TupleType

referencesDuration

public boolean referencesDuration()

Overrides:

referencesDuration in class TupleType

toString

public String toString()

Description copied from class: AbstractType

This must be overriden by subclasses if necessary so that for any AbstractType, this == TypeParser.parse(toString()). Note that for backwards compatibility this includes the full classname. For CQL purposes the short name is fine.

Overrides:

toString in class TupleType

toString

public String toString(boolean ignoreFreezing)

Overrides:

toString in class AbstractType<ByteBuffer>

Parameters:

ignoreFreezing - if true, the type string will not be wrapped with FrozenType(...), even if this type is frozen.

getCqlTypeName

public String getCqlTypeName()

getSerializer

public TypeSerializer<ByteBuffer> getSerializer()

Overrides:

getSerializer in class TupleType

elementType

public SchemaElement.SchemaElementType elementType()

Description copied from interface: SchemaElement

Return the schema element type

Specified by:

elementType in interface SchemaElement

Returns:

the schema element type

elementKeyspace

public String elementKeyspace()

Description copied from interface: SchemaElement

Returns the CQL name of the keyspace to which this schema element belong.

Specified by:

elementKeyspace in interface SchemaElement

Returns:

the keyspace name.

elementName

public String elementName()

Description copied from interface: SchemaElement

Returns the CQL name of this schema element.

Specified by:

elementName in interface SchemaElement

Returns:

the name of this schema element.

toCqlString

public String toCqlString(boolean withInternals,
 boolean ifNotExists)

Description copied from interface: SchemaElement

Returns a CQL representation of this element

Specified by:

toCqlString in interface SchemaElement

Parameters:

withInternals - if the internals part of the CQL should be exposed.

ifNotExists - if "IF NOT EXISTS" should be included.

Returns:

a CQL representation of this element