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

Class UpdateValue.Builder

java.lang.Object

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

Enclosing class:

UpdateValue

public static class UpdateValue.Builder
extends Object

Used to construct an UpdateValue command.

Constructor Summary

Constructors

Constructor and Description
UpdateValue.Builder(Location location) Construct a Builder for an UpdateValue command.

Method Summary

Methods

Modifier and Type	Method and Description
UpdateValue	build() Construct the UpdateValue command.
<U> UpdateValue.Builder	withFetchOption(FetchValue.Option<U> option, U value) Add an option for the fetch phase of the update.
<U> UpdateValue.Builder	withStoreOption(StoreValue.Option<U> option, U value) Add an option for the store phase of the update.
UpdateValue.Builder	withTimeout(int timeout) Set the Riak-side timeout value.
UpdateValue.Builder	withUpdate(UpdateValue.Update<?> update) Supply the Update.
<T> UpdateValue.Builder	withUpdate(UpdateValue.Update<T> update, com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Supply the Update with a TypeReference.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateValue.Builder

public UpdateValue.Builder(Location location)

Construct a Builder for an UpdateValue command.

Parameters:

location - the location of the object in Riak to update.

Method Detail

withFetchOption

public <U> UpdateValue.Builder withFetchOption(FetchValue.Option<U> option,
                                      U value)

Add an option for the fetch phase of the update.

Type Parameters:

U - the type of the option's value

Parameters:

option - the option

value - the option's value

Returns:

this

withStoreOption

public <U> UpdateValue.Builder withStoreOption(StoreValue.Option<U> option,
                                      U value)

Add an option for the store phase of the update.

Type Parameters:

U - the type of the option's value

Parameters:

option - the option

value - the option's value

Returns:

this

withUpdate

public UpdateValue.Builder withUpdate(UpdateValue.Update<?> update)

Supply the Update.

During the update operation, the fetched value needs to be converted before being passed to the ConflictResolver and the Update method.

Supplying only an Update<T> means the raw type of T will be used to retrieve the Converter and ConflictResolver to be used.

Parameters:

update - The Update instance

Returns:

a reference to this object.

See Also:

Converter, ConverterFactory, ConflictResolver, ConflictResolverFactory

withUpdate

public <T> UpdateValue.Builder withUpdate(UpdateValue.Update<T> update,
                                 com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Supply the Update with a TypeReference.

During the update operation, the fetched value needs to be converted before being passed to the ConflictResolver and the Update method. If your domain object is a parameterized type you will need to supply a TypeReference so the appropriate ConflictResolver and Converter can be found.

Parameters:

update - The Update instance

typeReference - the TypeReference for the class used for conversion.

Returns:

a reference to this object.

See Also:

Converter, ConverterFactory, ConflictResolver, ConflictResolverFactory

withTimeout

public UpdateValue.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 both the fetch and store operation.

Parameters:

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

Returns:

a reference to this object.

build

public UpdateValue build()

Construct the UpdateValue command.

Returns:

a new UpdateValue command.