com.basho.riak.client.api.convert

Class StringConverter

java.lang.Object

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

com.basho.riak.client.api.convert.StringConverter

public class StringConverter
extends Converter<String>

Converter that passes Strings through unmodified. Worth noting is that when using String directly with StoreValue there's no way to determine the character set. This converter uses the default character set for conversion.

Since:

2.0

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
StringConverter()

Method Summary

Methods

Modifier and Type	Method and Description
Converter.ContentAndType	fromDomain(String domainObject) Provide the value portion of a RiakObject from the domain object.
Converter.OrmExtracted	fromDomain(String domainObject, Namespace namespace, BinaryValue key) Convert from a domain object to a RiakObject.
String	toDomain(BinaryValue value, String contentType) Convert the value portion of a RiakObject to a domain object.
String	toDomain(RiakObject obj, Location location) Converts from a RiakObject to a domain object.

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

newDomainInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

StringConverter

public StringConverter()

Method Detail

toDomain

public String toDomain(RiakObject obj,
              Location location)

Description copied from class: Converter

Converts from a RiakObject to a domain object.

Overrides:

toDomain in class Converter<String>

Parameters:

obj - the RiakObject to be converted

location - The location of this RiakObject in Riak

Returns:

an instance of the domain type T

fromDomain

public Converter.OrmExtracted fromDomain(String domainObject,
                                Namespace namespace,
                                BinaryValue key)

Description copied from class: Converter

Convert from a domain object to a RiakObject.

The domain object itself may be completely annotated with everything required to produce a RiakObject except for the value portion. This will prefer annotated items over the Location passed in.

Overrides:

fromDomain in class Converter<String>

Parameters:

domainObject - a domain object to be stored in Riak.

namespace - the namespace in Riak

key - the key for the object

Returns:

data to be stored in Riak.

toDomain

public String toDomain(BinaryValue value,
              String contentType)
                throws ConversionException

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<String>

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

Throws:

ConversionException

fromDomain

public Converter.ContentAndType fromDomain(String domainObject)
                                    throws ConversionException

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<String>

Parameters:

domainObject - the domain object.

Returns:

A BinaryValue to be stored in Riak

Throws:

ConversionException