com.datastax.driver.extras.codecs.json

Class JacksonJsonCodec<T>

java.lang.Object

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

com.datastax.driver.extras.codecs.json.JacksonJsonCodec<T>

public class JacksonJsonCodec<T>
extends TypeCodec<T>

A JSON codec that uses the Jackson library to perform serialization and deserialization of JSON objects.

This codec maps a single Java object to a single JSON structure at a time; mapping of arrays or collections to root-level JSON arrays is not supported, but such a codec can be easily crafted after this one.

Note that this codec requires the presence of Jackson library at runtime. If you use Maven, this can be done by declaring the following dependency in your project:

 <dependency>
   <groupId>com.fasterxml.jackson.core</groupId>
   <artifactId>jackson-databind</artifactId>
   <version>2.6.3</version>
 </dependency>
 

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
JacksonJsonCodec(Class<T> javaClass) Creates a new instance for the provided javaClass, using a default, newly-allocated ObjectMapper.
JacksonJsonCodec(Class<T> javaClass, ObjectMapper objectMapper) Creates a new instance for the provided javaClass, and using the provided ObjectMapper.
JacksonJsonCodec(TypeToken<T> javaType) Creates a new instance for the provided javaType, using a default, newly-allocated ObjectMapper.
JacksonJsonCodec(TypeToken<T> javaType, ObjectMapper objectMapper) Creates a new instance for the provided javaType, and using the provided ObjectMapper.

Method Summary

Modifier and Type	Method and Description
T	deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion)
String	format(T value)
T	parse(String value)
ByteBuffer	serialize(T value, ProtocolVersion protocolVersion)
protected JavaType	toJacksonJavaType() This method acts as a bridge between Guava's TypeToken API, which is used by the driver, and Jackson's JavaType API.

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

JacksonJsonCodec

public JacksonJsonCodec(Class<T> javaClass)

Creates a new instance for the provided javaClass, using a default, newly-allocated ObjectMapper.

Parameters:

javaClass - the Java class this codec maps to.

JacksonJsonCodec

public JacksonJsonCodec(TypeToken<T> javaType)

Creates a new instance for the provided javaType, using a default, newly-allocated ObjectMapper.

Parameters:

javaType - the Java type this codec maps to.

JacksonJsonCodec

public JacksonJsonCodec(Class<T> javaClass,
                        ObjectMapper objectMapper)

Creates a new instance for the provided javaClass, and using the provided ObjectMapper.

Parameters:

javaClass - the Java class this codec maps to.

JacksonJsonCodec

public JacksonJsonCodec(TypeToken<T> javaType,
                        ObjectMapper objectMapper)

Creates a new instance for the provided javaType, and using the provided ObjectMapper.

Parameters:

javaType - the Java type this codec maps to.

Method Detail

serialize

public ByteBuffer serialize(T value,
                            ProtocolVersion protocolVersion)
                     throws InvalidTypeException

Specified by:

serialize in class TypeCodec<T>

Throws:

InvalidTypeException

deserialize

public T deserialize(ByteBuffer bytes,
                     ProtocolVersion protocolVersion)
              throws InvalidTypeException

Specified by:

deserialize in class TypeCodec<T>

Throws:

InvalidTypeException

format

public String format(T value)
              throws InvalidTypeException

Specified by:

format in class TypeCodec<T>

Throws:

InvalidTypeException

parse

public T parse(String value)
        throws InvalidTypeException

Specified by:

parse in class TypeCodec<T>

Throws:

InvalidTypeException

toJacksonJavaType

protected JavaType toJacksonJavaType()

This method acts as a bridge between Guava's TypeToken API, which is used by the driver, and Jackson's JavaType API.

Returns:

A JavaType instance corresponding to the codec's Java type.