com.basho.riak.client.api.convert

Enum ConverterFactory

java.lang.Object

java.lang.Enum<ConverterFactory>

com.basho.riak.client.api.convert.ConverterFactory

All Implemented Interfaces:

Serializable, Comparable<ConverterFactory>

public enum ConverterFactory
extends Enum<ConverterFactory>

Holds instances of converters to be used for serialization / deserialization of objects stored and fetched from Riak.

When storing and retrieving your own domain objects to/from Riak, they need to be serialized / deserialized. By default the JSONConverter is provided. This uses the Jackson JSON library to translate your object to/from JSON. In many cases you will never need to create or register your own converter with the ConverterFactory.

In the case you do need custom conversion, you would extend Converter and then register it with the ConverterFactory for your classes.

Since:

2.0

Author:

Brian Roach

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
<T> Converter<T>	getConverter(Type type) Returns a Converter instance for the supplied class.
<T> Converter<T>	getConverter(com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Returns a Converter instance for the supplied class.
static ConverterFactory	getInstance() Get the instance of the ConverterFactory.
<T> void	registerConverterForClass(Class<T> clazz, Converter<T> converter) Register a converter for the supplied class.
<T> void	registerConverterForClass(com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Converter<T> converter) Register a converter for the supplied class.
<T> void	unregisterConverterForClass(Class<T> clazz) Unregister a converter.
<T> void	unregisterConverterForClass(com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Unregister a converter.
static ConverterFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConverterFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ConverterFactory INSTANCE

Method Detail

values

public static ConverterFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConverterFactory c : ConverterFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConverterFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getInstance

public static ConverterFactory getInstance()

Get the instance of the ConverterFactory.

Returns:

the ConverterFactory

getConverter

public <T> Converter<T> getConverter(Type type)

Returns a Converter instance for the supplied class.

If no converter is registered, the default JSONConverter is returned.

Type Parameters:

T - The type for the converter

Parameters:

type - The type used to look up the converter

Returns:

an instance of the converter for this class

getConverter

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

Returns a Converter instance for the supplied class.

If no converter is registered, the default JSONConverter is returned.

Type Parameters:

T - The type for the converter

Parameters:

typeReference - the TypeReference for the class being converted.

Returns:

an instance of the converter for this class

registerConverterForClass

public <T> void registerConverterForClass(Class<T> clazz,
                                 Converter<T> converter)

Register a converter for the supplied class.

This instance be re-used for every conversion.

Type Parameters:

T - The type being converted

Parameters:

clazz - the class for this converter.

converter - an instance of Converter

registerConverterForClass

public <T> void registerConverterForClass(com.fasterxml.jackson.core.type.TypeReference<T> typeReference,
                                 Converter<T> converter)

Register a converter for the supplied class.

This instance be re-used for every conversion.

Type Parameters:

T - The type being converted

Parameters:

typeReference - the TypeReference for the class being converted.

converter - an instance of Converter

unregisterConverterForClass

public <T> void unregisterConverterForClass(Class<T> clazz)

Unregister a converter.

Type Parameters:

T - The type

Parameters:

clazz - the class being converted

unregisterConverterForClass

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

Unregister a converter.

Type Parameters:

T - The type

Parameters:

typeReference - the TypeReference for the class being converted.