com.datastax.driver.core

Class TypeCodec.StringCodec

java.lang.Object

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

com.datastax.driver.core.TypeCodec.StringCodec

Direct Known Subclasses:

TypeCodec.AsciiCodec, TypeCodec.VarcharCodec

Enclosing class:

TypeCodec<T>

public abstract static class TypeCodec.StringCodec
extends TypeCodec<String>

Base class for codecs handling CQL string types such as DataType.varchar(), DataType.text() or DataType.ascii().

Nested Class Summary

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

TypeCodec.AbstractUUIDCodec, TypeCodec.AsciiCodec, TypeCodec.BigintCodec, TypeCodec.BlobCodec, TypeCodec.BooleanCodec, TypeCodec.CollectionCodec<E,C extends Collection<E>>, TypeCodec.CounterCodec, TypeCodec.CustomCodec, TypeCodec.DateCodec, TypeCodec.DecimalCodec, TypeCodec.DoubleCodec, TypeCodec.EnumIntCodec<E extends Enum<E>>, TypeCodec.EnumStringCodec<E extends Enum<E>>, TypeCodec.FloatCodec, TypeCodec.InetCodec, TypeCodec.IntCodec, TypeCodec.ListCodec<T>, TypeCodec.LongCodec, TypeCodec.MapCodec<K,V>, TypeCodec.MappingCodec<T,U>, TypeCodec.PrimitiveBooleanCodec, TypeCodec.PrimitiveByteCodec, TypeCodec.PrimitiveDoubleCodec, TypeCodec.PrimitiveFloatCodec, TypeCodec.PrimitiveIntCodec, TypeCodec.PrimitiveLongCodec, TypeCodec.PrimitiveShortCodec, TypeCodec.SetCodec<T>, TypeCodec.SmallIntCodec, TypeCodec.StringCodec, TypeCodec.StringParsingCodec<T>, TypeCodec.TimeCodec, TypeCodec.TimestampCodec, TypeCodec.TimeUUIDCodec, TypeCodec.TinyIntCodec, TypeCodec.TupleCodec, TypeCodec.UDTCodec, TypeCodec.UUIDCodec, TypeCodec.VarcharCodec, TypeCodec.VarintCodec

Field Summary

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

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
StringCodec(DataType cqlType, Charset charset)

Method Summary

Modifier and Type	Method and Description
String	deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion) Deserialize the given ByteBuffer instance according to the CQL type handled by this codec.
String	format(String value) Format the given value as a valid CQL literal according to the CQL type handled by this codec.
String	parse(String value) Parse the given CQL literal into an instance of the Java type handled by this codec.
ByteBuffer	serialize(String value, ProtocolVersion protocolVersion) Serialize the given value according to the CQL type handled by this codec.

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

accepts, accepts, accepts, equals, getCqlType, getJavaType, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StringCodec

public StringCodec(DataType cqlType,
                   Charset charset)

Method Detail

parse

public String parse(String value)

Description copied from class: TypeCodec

Parse the given CQL literal into an instance of the Java type handled by this codec. Implementors should take care of unquoting and unescaping the given CQL string where applicable. Null values and empty Strings should be accepted, as weel as the string "NULL"; in most cases, implementations should interpret these inputs has equivalent to a null reference.

Specified by:

parse in class TypeCodec<String>

Parameters:

value - The CQL string to parse, may be null or empty.

Returns:

An instance of T; may be null on a null input.

format

public String format(String value)

Description copied from class: TypeCodec

Format the given value as a valid CQL literal according to the CQL type handled by this codec. Implementors should take care of quoting and escaping the resulting CQL literal where applicable. Null values should be accepted; in most cases, implementations should return the CQL keyword "NULL" for null inputs.

Specified by:

format in class TypeCodec<String>

Parameters:

value - An instance of T; may be null.

Returns:

CQL string

serialize

public ByteBuffer serialize(String value,
                            ProtocolVersion protocolVersion)

Description copied from class: TypeCodec

Serialize the given value according to the CQL type handled by this codec.

Implementation notes:

1. Null values should be gracefully handled and no exception should be raised; these should be considered as the equivalent of a NULL CQL value;
2. Codecs for CQL collection types should not permit null elements;
3. Codecs for CQL collection types should treat a null input as the equivalent of an empty collection.

Specified by:

serialize in class TypeCodec<String>

Parameters:

value - An instance of T; may be null.

protocolVersion - the protocol version to use when serializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).

Returns:

A ByteBuffer instance containing the serialized form of T

deserialize

public String deserialize(ByteBuffer bytes,
                          ProtocolVersion protocolVersion)

Deserialize the given ByteBuffer instance according to the CQL type handled by this codec.

Implementation notes:

1. Null or empty buffers should be gracefully handled and no exception should be raised; these should be considered as the equivalent of a NULL CQL value and, in most cases, should map to null or a default value for the corresponding Java type, if applicable;
2. Codecs for CQL collection types should return unmodifiable collections;
3. Codecs for CQL collection types should avoid returning null; they should return empty collections instead.

Implementation note: this method treats nulls and empty buffers differently: the formers are mapped to nulls while the latters are mappend to empty strings.

Specified by:

deserialize in class TypeCodec<String>

Parameters:

bytes - A ByteBuffer instance containing the serialized form of T; may be null or empty.

protocolVersion - the protocol version to use when serializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).

Returns:

An instance of T