org.apache.cassandra.serializers

Class ListSerializer<T>

java.lang.Object

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

org.apache.cassandra.serializers.CollectionSerializer<java.util.List<T>>

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

public class ListSerializer<T>
extends CollectionSerializer<java.util.List<T>>

Field Summary

Fields

Modifier and Type	Field and Description
TypeSerializer<T>	elements

Method Summary

Modifier and Type	Method and Description
<V> java.util.List<T>	deserializeForNativeProtocol(V input, ValueAccessor<V> accessor, ProtocolVersion version)
java.nio.ByteBuffer	getElement(java.nio.ByteBuffer input, int index)
<V> V	getElement(V input, ValueAccessor<V> accessor, int index) Returns the element at the given index in a list.
int	getElementCount(java.util.List<T> value)
static <T> ListSerializer<T>	getInstance(TypeSerializer<T> elements)
java.nio.ByteBuffer	getSerializedValue(java.nio.ByteBuffer collection, java.nio.ByteBuffer key, AbstractType<?> comparator) Extract an element from a serialized collection.
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.
java.lang.Class<java.util.List<T>>	getType()
protected java.util.List<java.nio.ByteBuffer>	serializeValues(java.util.List<T> values)
java.lang.String	toString(java.util.List<T> value)
<V> void	validateForNativeProtocol(V input, ValueAccessor<V> accessor, ProtocolVersion version)

Methods inherited from class org.apache.cassandra.serializers.CollectionSerializer

copyAsNewCollection, deserialize, deserializeForNativeProtocol, pack, pack, readCollectionSize, readCollectionSize, readValue, serialize, sizeOfCollectionSize, sizeOfValue, skipValue, skipValue, validate, writeCollectionSize, writeValue

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

deserialize, toCQLLiteral, validate

Methods inherited from class java.lang.Object

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

Field Detail

elements

public final TypeSerializer<T> elements

Method Detail

getInstance

public static <T> ListSerializer<T> getInstance(TypeSerializer<T> elements)

serializeValues

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

Specified by:

serializeValues in class CollectionSerializer<java.util.List<T>>

getElementCount

public int getElementCount(java.util.List<T> value)

Specified by:

getElementCount in class CollectionSerializer<java.util.List<T>>

validateForNativeProtocol

public <V> void validateForNativeProtocol(V input,
                                          ValueAccessor<V> accessor,
                                          ProtocolVersion version)

Specified by:

validateForNativeProtocol in class CollectionSerializer<java.util.List<T>>

deserializeForNativeProtocol

public <V> java.util.List<T> deserializeForNativeProtocol(V input,
                                                          ValueAccessor<V> accessor,
                                                          ProtocolVersion version)

Specified by:

deserializeForNativeProtocol in class CollectionSerializer<java.util.List<T>>

getElement

public <V> V getElement(V input,
                        ValueAccessor<V> accessor,
                        int index)

Returns the element at the given index in a list.

Parameters:

input - a serialized list

index - the index to get

Returns:

the serialized element at the given index, or null if the index exceeds the list size

getElement

public java.nio.ByteBuffer getElement(java.nio.ByteBuffer input,
                                      int index)

toString

public java.lang.String toString(java.util.List<T> value)

Specified by:

toString in class TypeSerializer<java.util.List<T>>

getType

public java.lang.Class<java.util.List<T>> getType()

Specified by:

getType in class TypeSerializer<java.util.List<T>>

getSerializedValue

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

Description copied from class: CollectionSerializer

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.

Specified by:

getSerializedValue in class CollectionSerializer<java.util.List<T>>

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 java.nio.ByteBuffer getSliceFromSerialized(java.nio.ByteBuffer collection,
                                                  java.nio.ByteBuffer from,
                                                  java.nio.ByteBuffer to,
                                                  AbstractType<?> comparator,
                                                  boolean frozen)

Description copied from class: CollectionSerializer

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.

Specified by:

getSliceFromSerialized in class CollectionSerializer<java.util.List<T>>

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.