com.datastax.driver.extras.codecs.date

Class SimpleTimestampCodec

java.lang.Object

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

com.datastax.driver.core.TypeCodec.PrimitiveLongCodec

com.datastax.driver.extras.codecs.date.SimpleTimestampCodec

public class SimpleTimestampCodec
extends TypeCodec.PrimitiveLongCodec

A TypeCodec that maps CQL timestamps to Java primitive longs, representing the number of milliseconds since the Epoch.

This codec can serve as a replacement for the driver's built-in timestamp codec, when application code prefers to deal with raw milliseconds than with Date instances.

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

Modifier and Type	Field and Description
static SimpleTimestampCodec	instance

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

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
SimpleTimestampCodec()

Method Summary

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

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

deserialize, 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, 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

Field Detail

instance

public static final SimpleTimestampCodec instance

Constructor Detail

SimpleTimestampCodec

public SimpleTimestampCodec()

Method Detail

serializeNoBoxing

public ByteBuffer serializeNoBoxing(long value,
                                    ProtocolVersion protocolVersion)

Specified by:

serializeNoBoxing in class TypeCodec.PrimitiveLongCodec

deserializeNoBoxing

public long deserializeNoBoxing(ByteBuffer bytes,
                                ProtocolVersion protocolVersion)

Specified by:

deserializeNoBoxing in class TypeCodec.PrimitiveLongCodec

parse

public Long 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 well as the string "NULL"; in most cases, implementations should interpret these inputs has equivalent to a null reference.

Implementing this method is not strictly mandatory: internally, the driver only uses it to parse the INITCOND when building the metadata of an aggregate function (and in most cases it will use a built-in codec, unless the INITCOND has a custom type).

Specified by:

parse in class TypeCodec<Long>

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(Long 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.

Implementing this method is not strictly mandatory. It is used:

1. in the query builder, when values are inlined in the query string (see BuiltStatement for a detailed explanation of when this happens);
2. in the QueryLogger, if parameter logging is enabled;
3. to format the INITCOND in AggregateMetadata.asCQLQuery(boolean);
4. in the toString() implementation of some objects (UDTValue, TupleValue, and the internal representation of a ROWS response), which may appear in driver logs.

If you choose not to implement this method, you should not throw an exception but instead return a constant string (for example "XxxCodec.format not implemented").

Specified by:

format in class TypeCodec<Long>

Parameters:

value - An instance of T; may be null.

Returns:

CQL string