com.datastax.driver.extras.codecs.enums

Class EnumOrdinalCodec<E extends Enum<E>>

java.lang.Object

com.datastax.driver.core.TypeCodec<E>

com.datastax.driver.extras.codecs.enums.EnumOrdinalCodec<E>

Type Parameters:

E - The Enum class this codec serializes from and deserializes to.

public class EnumOrdinalCodec<E extends Enum<E>>
extends com.datastax.driver.core.TypeCodec<E>

A codec that serializes Enum instances as CQL ints representing their ordinal values as returned by Enum.ordinal().

Note that this codec relies on the enum constants declaration order; it is therefore vital that this order remains immutable.

Nested Class Summary

Nested classes/interfaces inherited from class com.datastax.driver.core.TypeCodec

com.datastax.driver.core.TypeCodec.AbstractCollectionCodec<E,C extends Collection<E>>, com.datastax.driver.core.TypeCodec.AbstractMapCodec<K,V>, com.datastax.driver.core.TypeCodec.AbstractTupleCodec<T>, com.datastax.driver.core.TypeCodec.AbstractUDTCodec<T>, com.datastax.driver.core.TypeCodec.PrimitiveBooleanCodec, com.datastax.driver.core.TypeCodec.PrimitiveByteCodec, com.datastax.driver.core.TypeCodec.PrimitiveDoubleCodec, com.datastax.driver.core.TypeCodec.PrimitiveFloatCodec, com.datastax.driver.core.TypeCodec.PrimitiveIntCodec, com.datastax.driver.core.TypeCodec.PrimitiveLongCodec, com.datastax.driver.core.TypeCodec.PrimitiveShortCodec

Field Summary

Fields inherited from class com.datastax.driver.core.TypeCodec

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
EnumOrdinalCodec(Class<E> enumClass)
EnumOrdinalCodec(com.datastax.driver.core.TypeCodec<Integer> innerCodec, Class<E> enumClass)

Method Summary

Modifier and Type	Method and Description
E	deserialize(ByteBuffer bytes, com.datastax.driver.core.ProtocolVersion protocolVersion)
String	format(E value)
E	parse(String value)
ByteBuffer	serialize(E value, com.datastax.driver.core.ProtocolVersion protocolVersion)

Methods inherited from class com.datastax.driver.core.TypeCodec

accepts, accepts, accepts, accepts, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, getCqlType, getJavaType, inet, list, map, set, smallInt, time, timestamp, timeUUID, tinyInt, toString, tuple, userType, uuid, varchar, varint

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumOrdinalCodec

public EnumOrdinalCodec(Class<E> enumClass)

EnumOrdinalCodec

public EnumOrdinalCodec(com.datastax.driver.core.TypeCodec<Integer> innerCodec,
                        Class<E> enumClass)

Method Detail

serialize

public ByteBuffer serialize(E value,
                            com.datastax.driver.core.ProtocolVersion protocolVersion)
                     throws com.datastax.driver.core.exceptions.InvalidTypeException

Specified by:

serialize in class com.datastax.driver.core.TypeCodec<E extends Enum<E>>

Throws:

com.datastax.driver.core.exceptions.InvalidTypeException

deserialize

public E deserialize(ByteBuffer bytes,
                     com.datastax.driver.core.ProtocolVersion protocolVersion)
              throws com.datastax.driver.core.exceptions.InvalidTypeException

Specified by:

deserialize in class com.datastax.driver.core.TypeCodec<E extends Enum<E>>

Throws:

com.datastax.driver.core.exceptions.InvalidTypeException

parse

public E parse(String value)
        throws com.datastax.driver.core.exceptions.InvalidTypeException

Specified by:

parse in class com.datastax.driver.core.TypeCodec<E extends Enum<E>>

Throws:

com.datastax.driver.core.exceptions.InvalidTypeException

format

public String format(E value)
              throws com.datastax.driver.core.exceptions.InvalidTypeException

Specified by:

format in class com.datastax.driver.core.TypeCodec<E extends Enum<E>>

Throws:

com.datastax.driver.core.exceptions.InvalidTypeException