Package org.apache.cassandra.db.marshal

Class CollectionType<T>

java.lang.Object

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

org.apache.cassandra.db.marshal.CollectionType<T>

All Implemented Interfaces:

Comparator<ByteBuffer>, AssignmentTestable

Direct Known Subclasses:

ListType, MapType, SetType

public abstract class CollectionType<T>
extends AbstractType<T>

The abstract validator that is the base for maps, sets and lists (both frozen and non-frozen). Please note that this comparator shouldn't be used "manually" (as a custom type for instance).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CollectionType.Kind

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

Field Summary

Fields

Modifier and Type	Field	Description
static CellPath.Serializer	cellPathSerializer
final CollectionType.Kind	kind

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

comparatorSet, comparisonType, isByteOrderComparable, reverseComparator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CollectionType(AbstractType.ComparisonType comparisonType, CollectionType.Kind kind)

Method Summary

Modifier and Type	Method	Description
CQL3Type	asCQL3Type()
protected int	collectionSize(List<ByteBuffer> values)
boolean	equals(Object o)
abstract void	forEach(ByteBuffer input, Consumer<ByteBuffer> action)
ByteBuffer	fromString(String source)	get a byte representation of the given string.
abstract CollectionSerializer<T>	getSerializer()
<V> String	getString(V value, ValueAccessor<V> accessor)	get a string representation of the bytes used for various identifier (NOT just for log messages)
int	hashCode()
boolean	isCollection()
boolean	isCompatibleWith(AbstractType<?> previous)	Returns true if this comparator is compatible with the provided previous comparator, that is if previous can safely be replaced by this.
protected abstract boolean	isCompatibleWithFrozen(CollectionType<?> previous)	A version of isCompatibleWith() to deal with non-multicell (frozen) collections
boolean	isFreezable()
boolean	isMap()	Checks if this collection is Map.
boolean	isSerializationCompatibleWith(AbstractType<?> previous)	Similar to AbstractType.isValueCompatibleWith(AbstractType), but takes into account Cell encoding.
protected abstract boolean	isValueCompatibleWithFrozen(CollectionType<?> previous)	A version of isValueCompatibleWith() to deal with non-multicell (frozen) collections
boolean	isValueCompatibleWithInternal(AbstractType<?> previous)	Needed to handle ReversedType in value-compatibility checks.
ColumnSpecification	makeCollectionReceiver(ColumnSpecification collection, boolean isKey)
abstract AbstractType<?>	nameComparator()
protected abstract List<ByteBuffer>	serializedValues(Iterator<Cell<?>> cells)
ByteBuffer	serializeForNativeProtocol(Iterator<Cell<?>> cells)
static String	setOrListToJsonString(ByteBuffer buffer, AbstractType<?> elementsType, ProtocolVersion protocolVersion)
int	size(ByteBuffer buffer)
String	toString()	This must be overriden by subclasses if necessary so that for any AbstractType, this == TypeParser.parse(toString()).
<V> void	validate(V value, ValueAccessor<V> accessor)
<V> void	validateCellValue(V cellValue, ValueAccessor<V> accessor)	Validate cell value.
abstract AbstractType<?>	valueComparator()

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

allowsEmpty, asComparableBytes, asComparableBytes, asCQLTypeStringList, checkComparable, compare, compare, compareCollectionMembers, compareCustom, compareForCQL, compose, compose, decompose, decomposeUntyped, expandUserTypes, freeze, freezeNestedMulticellTypes, fromComparableBytes, fromComparableBytes, fromJSONObject, getArgumentDeserializer, getCompatibleTypeIfKnown, getComponents, getMaskedValue, getString, getString, isCounter, isEmptyValueMeaningless, isFrozenCollection, isMultiCell, isNull, isNull, isReversed, isTuple, isUDT, isValueCompatibleWith, isValueLengthFixed, isVector, parseDefaultParameters, read, readArray, readBuffer, readBuffer, referencesDuration, referencesUserType, referencesUserType, skipValue, subTypes, testAssignment, testAssignment, toCQLString, toJSONString, toJSONString, toString, udfType, unfreeze, unwrap, validate, validateCollectionMember, valueLengthIfFixed, withUpdatedUserType, 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

Field Details

cellPathSerializer

public static CellPath.Serializer cellPathSerializer

kind

public final CollectionType.Kind kind

Constructor Details

CollectionType

protected CollectionType(AbstractType.ComparisonType comparisonType,
 CollectionType.Kind kind)

Method Details

nameComparator

public abstract AbstractType<?> nameComparator()

valueComparator

public abstract AbstractType<?> valueComparator()

serializedValues

protected abstract List<ByteBuffer> serializedValues(Iterator<Cell<?>> cells)

getSerializer

public abstract CollectionSerializer<T> getSerializer()

Specified by:

getSerializer in class AbstractType<T>

makeCollectionReceiver

public ColumnSpecification makeCollectionReceiver(ColumnSpecification collection,
 boolean isKey)

getString

public <V> String getString(V value,
 ValueAccessor<V> accessor)

Description copied from class: AbstractType

get a string representation of the bytes used for various identifier (NOT just for log messages)

Overrides:

getString in class AbstractType<T>

fromString

public ByteBuffer fromString(String source)

Description copied from class: AbstractType

get a byte representation of the given string.

Specified by:

fromString in class AbstractType<T>

isCollection

public boolean isCollection()

Overrides:

isCollection in class AbstractType<T>

validate

public <V> void validate(V value,
 ValueAccessor<V> accessor)
                  throws MarshalException

Overrides:

validate in class AbstractType<T>

Throws:

MarshalException

validateCellValue

public <V> void validateCellValue(V cellValue,
 ValueAccessor<V> accessor)
                           throws MarshalException

Description copied from class: AbstractType

Validate cell value. Unlike AbstractType.validate(java.nio.ByteBuffer), cell value is passed to validate its content. Usually, this is the same as validate except collection.

Overrides:

validateCellValue in class AbstractType<T>

Parameters:

cellValue - ByteBuffer representing cell value

Throws:

MarshalException

isMap

public boolean isMap()

Checks if this collection is Map.

Returns:

true if this collection is a Map, false otherwise.

isFreezable

public boolean isFreezable()

Overrides:

isFreezable in class AbstractType<T>

collectionSize

protected int collectionSize(List<ByteBuffer> values)

serializeForNativeProtocol

public ByteBuffer serializeForNativeProtocol(Iterator<Cell<?>> cells)

isCompatibleWith

public boolean isCompatibleWith(AbstractType<?> previous)

Description copied from class: AbstractType

Returns true if this comparator is compatible with the provided previous comparator, that is if previous can safely be replaced by this. A comparator cn should be compatible with a previous one cp if forall columns c1 and c2, if cn.validate(c1) and cn.validate(c2) and cn.compare(c1, c2) == v, then cp.validate(c1) and cp.validate(c2) and cp.compare(c1, c2) == v. Note that a type should be compatible with at least itself and when in doubt, keep the default behavior of not being compatible with any other comparator!

Overrides:

isCompatibleWith in class AbstractType<T>

isValueCompatibleWithInternal

public boolean isValueCompatibleWithInternal(AbstractType<?> previous)

Description copied from class: AbstractType

Needed to handle ReversedType in value-compatibility checks. Subclasses should implement this instead of isValueCompatibleWith().

Overrides:

isValueCompatibleWithInternal in class AbstractType<T>

isSerializationCompatibleWith

public boolean isSerializationCompatibleWith(AbstractType<?> previous)

Description copied from class: AbstractType

Similar to AbstractType.isValueCompatibleWith(AbstractType), but takes into account Cell encoding. In particular, this method doesn't consider two types serialization compatible if one of them has fixed length (overrides AbstractType.valueLengthIfFixed(), and the other one doesn't.

Overrides:

isSerializationCompatibleWith in class AbstractType<T>

isCompatibleWithFrozen

protected abstract boolean isCompatibleWithFrozen(CollectionType<?> previous)

A version of isCompatibleWith() to deal with non-multicell (frozen) collections

isValueCompatibleWithFrozen

protected abstract boolean isValueCompatibleWithFrozen(CollectionType<?> previous)

A version of isValueCompatibleWith() to deal with non-multicell (frozen) collections

asCQL3Type

public CQL3Type asCQL3Type()

Overrides:

asCQL3Type in class AbstractType<T>

equals

public boolean equals(Object o)

Specified by:

equals in interface Comparator<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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 AbstractType<T>

setOrListToJsonString

public static String setOrListToJsonString(ByteBuffer buffer,
 AbstractType<?> elementsType,
 ProtocolVersion protocolVersion)

size

public int size(ByteBuffer buffer)

forEach

public abstract void forEach(ByteBuffer input,
 Consumer<ByteBuffer> action)