org.apache.cassandra.serializers

Class CollectionSerializer<T>

java.lang.Object

org.apache.cassandra.serializers.CollectionSerializer<T>

All Implemented Interfaces:

TypeSerializer<T>

Direct Known Subclasses:

ListSerializer, MapSerializer, SetSerializer

public abstract class CollectionSerializer<T>
extends java.lang.Object
implements TypeSerializer<T>

Constructor Summary

Constructors

Constructor and Description
CollectionSerializer()

Method Summary

Modifier and Type	Method and Description
protected java.nio.ByteBuffer	copyAsNewCollection(java.nio.ByteBuffer input, int count, int startPos, int endPos, ProtocolVersion version) Creates a new serialized map composed from the data from input between startPos (inclusive) and endPos (exclusive), assuming that data holds count elements.
T	deserialize(java.nio.ByteBuffer bytes)
abstract T	deserializeForNativeProtocol(java.nio.ByteBuffer buffer, ProtocolVersion version)
protected abstract int	getElementCount(T value)
abstract java.nio.ByteBuffer	getSerializedValue(java.nio.ByteBuffer collection, java.nio.ByteBuffer key, AbstractType<?> comparator) Extract an element from a serialized collection.
abstract java.nio.ByteBuffer	getSliceFromSerialized(java.nio.ByteBuffer collection, java.nio.ByteBuffer from, java.nio.ByteBuffer to, AbstractType<?> comparator, boolean frozen) Returns the slice of a collection directly from its serialized value.
static java.nio.ByteBuffer	pack(java.util.Collection<java.nio.ByteBuffer> buffers, int elements, ProtocolVersion version)
static int	readCollectionSize(java.nio.ByteBuffer input, ProtocolVersion version)
static java.nio.ByteBuffer	readValue(java.nio.ByteBuffer input, ProtocolVersion version)
java.nio.ByteBuffer	serialize(T value)
protected abstract java.util.List<java.nio.ByteBuffer>	serializeValues(T value)
protected static int	sizeOfCollectionSize(int elements, ProtocolVersion version)
static int	sizeOfValue(java.nio.ByteBuffer value, ProtocolVersion version)
protected static void	skipValue(java.nio.ByteBuffer input, ProtocolVersion version)
void	validate(java.nio.ByteBuffer bytes)
abstract void	validateForNativeProtocol(java.nio.ByteBuffer buffer, ProtocolVersion version)
protected static void	writeCollectionSize(java.nio.ByteBuffer output, int elements, ProtocolVersion version)
static void	writeValue(java.nio.ByteBuffer output, java.nio.ByteBuffer value, ProtocolVersion version)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cassandra.serializers.TypeSerializer

getType, toCQLLiteral, toString

Constructor Detail

CollectionSerializer

public CollectionSerializer()

Method Detail

serializeValues

protected abstract java.util.List<java.nio.ByteBuffer> serializeValues(T value)

getElementCount

protected abstract int getElementCount(T value)

deserializeForNativeProtocol

public abstract T deserializeForNativeProtocol(java.nio.ByteBuffer buffer,
                                               ProtocolVersion version)

validateForNativeProtocol

public abstract void validateForNativeProtocol(java.nio.ByteBuffer buffer,
                                               ProtocolVersion version)

serialize

public java.nio.ByteBuffer serialize(T value)

Specified by:

serialize in interface TypeSerializer<T>

deserialize

public T deserialize(java.nio.ByteBuffer bytes)

Specified by:

deserialize in interface TypeSerializer<T>

validate

public void validate(java.nio.ByteBuffer bytes)
              throws MarshalException

Specified by:

validate in interface TypeSerializer<T>

Throws:

MarshalException

pack

public static java.nio.ByteBuffer pack(java.util.Collection<java.nio.ByteBuffer> buffers,
                                       int elements,
                                       ProtocolVersion version)

writeCollectionSize

protected static void writeCollectionSize(java.nio.ByteBuffer output,
                                          int elements,
                                          ProtocolVersion version)

readCollectionSize

public static int readCollectionSize(java.nio.ByteBuffer input,
                                     ProtocolVersion version)

sizeOfCollectionSize

protected static int sizeOfCollectionSize(int elements,
                                          ProtocolVersion version)

writeValue

public static void writeValue(java.nio.ByteBuffer output,
                              java.nio.ByteBuffer value,
                              ProtocolVersion version)

readValue

public static java.nio.ByteBuffer readValue(java.nio.ByteBuffer input,
                                            ProtocolVersion version)

skipValue

protected static void skipValue(java.nio.ByteBuffer input,
                                ProtocolVersion version)

sizeOfValue

public static int sizeOfValue(java.nio.ByteBuffer value,
                              ProtocolVersion version)

getSerializedValue

public abstract java.nio.ByteBuffer getSerializedValue(java.nio.ByteBuffer collection,
                                                       java.nio.ByteBuffer key,
                                                       AbstractType<?> comparator)

Extract an element from a serialized collection.

Note that this is only supported to sets and maps. For sets, this mostly ends up being a check for the presence of the provide key: it will return the key if it's present and null otherwise.

Parameters:

collection - the serialized collection. This cannot be null.

key - the key to extract (This cannot be null nor ByteBufferUtil.UNSET_BYTE_BUFFER).

comparator - the type to use to compare the key value to those in the collection.

Returns:

the value associated with key if one exists, null otherwise

getSliceFromSerialized

public abstract java.nio.ByteBuffer getSliceFromSerialized(java.nio.ByteBuffer collection,
                                                           java.nio.ByteBuffer from,
                                                           java.nio.ByteBuffer to,
                                                           AbstractType<?> comparator,
                                                           boolean frozen)

Returns the slice of a collection directly from its serialized value.

If the slice contains no elements an empty collection will be returned for frozen collections, and a null one for non-frozen collections.

Parameters:

collection - the serialized collection. This cannot be null.

from - the left bound of the slice to extract. This cannot be null but if this is ByteBufferUtil.UNSET_BYTE_BUFFER, then the returned slice starts at the beginning of collection.

comparator - the type to use to compare the from and to values to those in the collection.

frozen - true if the collection is a frozen one, false otherwise

Returns:

a serialized collection corresponding to slice [from, to] of collection.

copyAsNewCollection

protected java.nio.ByteBuffer copyAsNewCollection(java.nio.ByteBuffer input,
                                                  int count,
                                                  int startPos,
                                                  int endPos,
                                                  ProtocolVersion version)

Creates a new serialized map composed from the data from input between startPos (inclusive) and endPos (exclusive), assuming that data holds count elements.