com.basho.riak.client.api.convert

Class JSONConverter<T>

java.lang.Object

com.basho.riak.client.api.convert.Converter<T>

com.basho.riak.client.api.convert.JSONConverter<T>

Type Parameters:

T - type to convert to/from

public class JSONConverter<T>
extends Converter<T>

The default Converter used when storing and fetching domain objects from Riak.

This uses the Jackson JSON library to serialize / deserialize objects to JSON. The reulsting JSON is then stored in Riak.

Author:

Brian Roach

Nested Class Summary

Nested classes/interfaces inherited from class com.basho.riak.client.api.convert.Converter

Converter.ContentAndType, Converter.OrmExtracted

Field Summary

Fields inherited from class com.basho.riak.client.api.convert.Converter

type

Constructor Summary

Constructors

Constructor and Description
JSONConverter(Type type) Create a JSONConverter for creating instances of type from JSON and instances of RiakObject with a JSON payload from instances of clazz
JSONConverter(com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Method Summary

Methods

Modifier and Type	Method and Description
Converter.ContentAndType	fromDomain(T domainObject) Provide the value portion of a RiakObject from the domain object.
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Returns the ObjectMapper being used.
static void	registerJacksonModule(com.fasterxml.jackson.databind.Module jacksonModule) Convenient method to register a Jackson module into the singleton Object mapper used by domain objects.
T	toDomain(BinaryValue value, String contentType) Convert the value portion of a RiakObject to a domain object.

Methods inherited from class com.basho.riak.client.api.convert.Converter

fromDomain, newDomainInstance, toDomain

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONConverter

public JSONConverter(Type type)

Create a JSONConverter for creating instances of type from JSON and instances of RiakObject with a JSON payload from instances of clazz

Parameters:

type -

JSONConverter

public JSONConverter(com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Method Detail

getObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns the ObjectMapper being used. This is a convenience method to allow changing its behavior.

Returns:

The Jackson ObjectMapper

registerJacksonModule

public static void registerJacksonModule(com.fasterxml.jackson.databind.Module jacksonModule)

Convenient method to register a Jackson module into the singleton Object mapper used by domain objects.

Parameters:

jacksonModule - Module to register.

toDomain

public T toDomain(BinaryValue value,
         String contentType)

Description copied from class: Converter

Convert the value portion of a RiakObject to a domain object.

Implementations override this method to convert the value contained in a RiakObject to an instance of a domain object.

Specified by:

toDomain in class Converter<T>

Parameters:

value - the value portion of a RiakObject to convert to a domain object

contentType - The content type of the RiakObject

Returns:

a new instance of the domain object

fromDomain

public Converter.ContentAndType fromDomain(T domainObject)

Description copied from class: Converter

Provide the value portion of a RiakObject from the domain object.

Implementations override this method to provide the value portion of the RiakObject to be stored from the supplied domain object.

Specified by:

fromDomain in class Converter<T>

Parameters:

domainObject - the domain object.

Returns:

A BinaryValue to be stored in Riak