com.basho.riak.client.api.commands.kv

Class StoreValue.Builder

java.lang.Object

com.basho.riak.client.api.commands.kv.StoreValue.Builder

Enclosing class:

StoreValue

public static class StoreValue.Builder
extends Object

Used to construct a StoreValue command.

Constructor Summary

Constructors

Constructor and Description
Builder(Object value) Construct a Builder for a StoreValue command.
Builder(Object value, com.fasterxml.jackson.core.type.TypeReference<?> typeReference) Construct a Builder for a StoreValue command.

Method Summary

Modifier and Type	Method and Description
StoreValue	build() Construct the StoreValue command.
StoreValue.Builder	withLocation(Location location) Set the location to store the object.
StoreValue.Builder	withNamespace(Namespace namespace) Set the namespace to store the object.
<T> StoreValue.Builder	withOption(StoreValue.Option<T> option, T value) Add an optional setting for this command.
StoreValue.Builder	withTimeout(int timeout) Set the Riak-side timeout value.
StoreValue.Builder	withVectorClock(VClock vclock) Set the vector clock.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Object value)

Construct a Builder for a StoreValue command.

Prior to storing the object, it's raw type (class) will be used to retrieve a converter from the ConverterFactory. For anything other than a RiakObject this is the JSONConverter by default.

Parameters:

value - The object to be stored in Riak.

Builder

public Builder(Object value,
               com.fasterxml.jackson.core.type.TypeReference<?> typeReference)

Construct a Builder for a StoreValue command.

Prior to storing the object, the supplied TypeReference will be used to retrieve a converter from the ConverterFactory. For anything other than a RiakObject this is the JSONConverter by default.

Parameters:

value - The object to be stored in Riak.

typeReference - the TypeReference for the object.

Method Detail

withLocation

public StoreValue.Builder withLocation(Location location)

Set the location to store the object.

When storing a RiakObject or a POJO that does not have annotations for the bucket and key, a Location must be provided.

Parameters:

location - the location to store the object in Riak.

Returns:

a reference to this object.

withNamespace

public StoreValue.Builder withNamespace(Namespace namespace)

Set the namespace to store the object.

When storing a POJO that does not have an annotation for the bucket type and bucket, a Namespace must be supplied.

Parameters:

namespace - The namespaec to store the object.

Returns:

a reference to this object.

withTimeout

public StoreValue.Builder withTimeout(int timeout)

Set the Riak-side timeout value.

By default, riak has a 60s timeout for operations. Setting this value will override that default for this operation.

Parameters:

timeout - the timeout in milliseconds to be sent to riak.

Returns:

a reference to this object.

withOption

public <T> StoreValue.Builder withOption(StoreValue.Option<T> option,
                                         T value)

Add an optional setting for this command. This will be passed along with the request to Riak to tell it how to behave when servicing the request.

Parameters:

option - the option

value - the value for the option

Returns:

a reference to this object.

withVectorClock

public StoreValue.Builder withVectorClock(VClock vclock)

Set the vector clock.

When storing core Java types (HashMap, ArrayList,String, etc) or non-annotated POJOs this method allows you to specify the vector clock retrieved from a prior fetch operation.

Parameters:

vclock - The vector clock to send to Riak.

Returns:

a reference to this object.

build

public StoreValue build()

Construct the StoreValue command.

Returns:

the new StoreValue command.