com.datastax.driver.extras.codecs.enums

Class EnumNameCodec<E extends Enum<E>>

java.lang.Object

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

com.datastax.driver.extras.codecs.ParsingCodec<E>

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

Type Parameters:

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

public class EnumNameCodec<E extends Enum<E>>
extends ParsingCodec<E>

A codec that serializes Enum instances as CQL varchars representing their programmatic names as returned by Enum.name().

Note that this codec relies on the enum constant names; it is therefore vital that enum names never change.

Nested Class Summary

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

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

Field Summary

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

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
EnumNameCodec(Class<E> enumClass)
EnumNameCodec(TypeCodec<String> innerCodec, Class<E> enumClass)

Method Summary

Modifier and Type	Method and Description
protected E	fromString(String value) Parse the given string into an object; no special CQL unquoting should be applied here.
protected String	toString(E value) Return the String representation of the given object; no special CQL quoting should be applied here.

Methods inherited from class com.datastax.driver.extras.codecs.ParsingCodec

deserialize, format, parse, serialize

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

accepts, accepts, accepts, accepts, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, duration, 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

EnumNameCodec

public EnumNameCodec(Class<E> enumClass)

EnumNameCodec

public EnumNameCodec(TypeCodec<String> innerCodec,
                     Class<E> enumClass)

Method Detail

toString

protected String toString(E value)

Description copied from class: ParsingCodec

Return the String representation of the given object; no special CQL quoting should be applied here. Null values should be accepted; in most cases, implementors should return null for null inputs.

Specified by:

toString in class ParsingCodec<E extends Enum<E>>

Parameters:

value - the value to convert into a string

Returns:

the String representation of the given object

fromString

protected E fromString(String value)

Description copied from class: ParsingCodec

Parse the given string into an object; no special CQL unquoting should be applied here. Null values should be accepted; in most cases, implementors should return null for null inputs.

Specified by:

fromString in class ParsingCodec<E extends Enum<E>>

Parameters:

value - the string to parse

Returns:

the parsed object.