com.basho.riak.client.builders

Class DomainBucketBuilder<T>

java.lang.Object

com.basho.riak.client.builders.DomainBucketBuilder<T>

Type Parameters:

T - the type of the DomainBucket to be built

public class DomainBucketBuilder<T>
extends Object

For creating a DomainBucket

Defaults are as follows:

• ConflictResolver : DefaultResolver
• Converter : JSONConverter
• Retrier : DefaultRetrier.attempts(int) configured for 3 attempts
• MutationProducer : anonymous instance that produces a ClobberMutation for MutationProducer.produce(Object)

Author:

russell

Constructor Summary

Constructors

Constructor and Description
DomainBucketBuilder(Bucket bucket, Class<T> clazz) Create a DomainBucket that stores instance of clazz in bucket

Method Summary

Methods

Modifier and Type	Method and Description
DomainBucketBuilder<T>	basicQuorum(boolean basicQuorum)
DomainBucket<T>	build() Generate the DomainBucket
DomainBucketBuilder<T>	dw(int dw) The durable write quorum for store operations on the built DomainBucket
DomainBucketBuilder<T>	dw(Quora dw) The durable write quorum for store operations on the built DomainBucket
DomainBucketBuilder<T>	ifNoneMatch(boolean ifNoneMatch)
DomainBucketBuilder<T>	ifNotModified(boolean ifNotModified)
DomainBucketBuilder<T>	mutationProducer(MutationProducer<T> mutationProducer) A MutationProducer to provide the Mutation to use in store operations.
DomainBucketBuilder<T>	notFoundOK(boolean notFoundOK)
DomainBucketBuilder<T>	pr(int pr)
DomainBucketBuilder<T>	pr(Quora pr)
DomainBucketBuilder<T>	pw(int pw)
DomainBucketBuilder<T>	pw(Quora pw)
DomainBucketBuilder<T>	r(int r) The read quorum for fetch/store operations on the built DomainBucket
DomainBucketBuilder<T>	r(Quora r) The read quorum for fetch/store operations on the built DomainBucket
DomainBucketBuilder<T>	retrier(Retrier retrier) The Retrier to use on operations on the built DomainBucket
DomainBucketBuilder<T>	returnBody(boolean returnBody) Should store operations on the built DomainBucket return a body?
DomainBucketBuilder<T>	returnDeletedVClock(boolean returnDeletedVClock)
DomainBucketBuilder<T>	rw(int rw) The read write quorum for delete operations on the built DomainBucket
DomainBucketBuilder<T>	rw(Quora rw) The read write quorum for delete operations on the built DomainBucket
DomainBucketBuilder<T>	timeout(int timeout) Set an operation timeout in milliseconds to be sent to Riak As of 1.4 Riak allows a timeout to be sent for get, put, and delete operations.
DomainBucketBuilder<T>	w(int w) The write quorum for store operations on the built DomainBucket
DomainBucketBuilder<T>	w(Quora w) The write quorum for store operations on the built DomainBucket
DomainBucketBuilder<T>	withConverter(Converter<T> converter) The Converter to use on fetch and store operations on the built DomainBucket
DomainBucketBuilder<T>	withoutFetch(boolean withoutFetch) Sets whether a store operation should fetch existing value(s) from Riak (and the vector clock) and perform conflict resolution if required.
DomainBucketBuilder<T>	withResolver(ConflictResolver<T> resolver) the ConflictResolver the DomainBucket will use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainBucketBuilder

public DomainBucketBuilder(Bucket bucket,
                   Class<T> clazz)

Create a DomainBucket that stores instance of clazz in bucket

Parameters:

bucket -

clazz -

Method Detail

build

public DomainBucket<T> build()

Generate the DomainBucket

Returns:

a DomainBucket configured from this builder

withResolver

public DomainBucketBuilder<T> withResolver(ConflictResolver<T> resolver)

the ConflictResolver the DomainBucket will use.

Parameters:

resolver - a ConflictResolver

Returns:

this

returnBody

public DomainBucketBuilder<T> returnBody(boolean returnBody)

Should store operations on the built DomainBucket return a body?

Parameters:

returnBody -

Returns:

this

retrier

public DomainBucketBuilder<T> retrier(Retrier retrier)

The Retrier to use on operations on the built DomainBucket

Parameters:

retrier - a Retrier

Returns:

this

w

public DomainBucketBuilder<T> w(int w)

The write quorum for store operations on the built DomainBucket

Parameters:

w -

Returns:

this

w

public DomainBucketBuilder<T> w(Quora w)

The write quorum for store operations on the built DomainBucket

Parameters:

w - - Quora to use.

Returns:

this

r

public DomainBucketBuilder<T> r(int r)

The read quorum for fetch/store operations on the built DomainBucket

Parameters:

r -

Returns:

this

r

public DomainBucketBuilder<T> r(Quora r)

The read quorum for fetch/store operations on the built DomainBucket

Parameters:

r - - Quora to use

Returns:

this

rw

public DomainBucketBuilder<T> rw(int rw)

The read write quorum for delete operations on the built DomainBucket

Parameters:

rw -

Returns:

this

rw

public DomainBucketBuilder<T> rw(Quora rw)

The read write quorum for delete operations on the built DomainBucket

Parameters:

rw - - Quora to use

Returns:

this

dw

public DomainBucketBuilder<T> dw(int dw)

The durable write quorum for store operations on the built DomainBucket

Parameters:

dw -

Returns:

this

dw

public DomainBucketBuilder<T> dw(Quora dw)

The durable write quorum for store operations on the built DomainBucket

Parameters:

dw - - Quora to use

Returns:

this

notFoundOK

public DomainBucketBuilder<T> notFoundOK(boolean notFoundOK)

Parameters:

notFoundOK -

Returns:

this

basicQuorum

public DomainBucketBuilder<T> basicQuorum(boolean basicQuorum)

Parameters:

basicQuorum -

Returns:

this

returnDeletedVClock

public DomainBucketBuilder<T> returnDeletedVClock(boolean returnDeletedVClock)

Parameters:

returnDeletedVClock -

Returns:

this

ifNotModified

public DomainBucketBuilder<T> ifNotModified(boolean ifNotModified)

Parameters:

ifNotModified -

Returns:

this

ifNoneMatch

public DomainBucketBuilder<T> ifNoneMatch(boolean ifNoneMatch)

Parameters:

ifNoneMatch -

Returns:

this

pr

public DomainBucketBuilder<T> pr(int pr)

Parameters:

pr -

Returns:

this

pr

public DomainBucketBuilder<T> pr(Quora pr)

Parameters:

pr - - Quora to use

Returns:

this

pw

public DomainBucketBuilder<T> pw(int pw)

Parameters:

pw -

Returns:

this

pw

public DomainBucketBuilder<T> pw(Quora pw)

Parameters:

pw - - Quora to use

Returns:

this

timeout

public DomainBucketBuilder<T> timeout(int timeout)

Set an operation timeout in milliseconds to be sent to Riak As of 1.4 Riak allows a timeout to be sent for get, put, and delete operations. The client will receive a timeout error if the operation is not completed within the specified time This is applied to all operations performed by this DomainBucket.

Parameters:

timeout - - the timeout in milliseconds

Returns:

this

mutationProducer

public DomainBucketBuilder<T> mutationProducer(MutationProducer<T> mutationProducer)

A MutationProducer to provide the Mutation to use in store operations.

Parameters:

mutationProducer -

Returns:

this

withConverter

public DomainBucketBuilder<T> withConverter(Converter<T> converter)

The Converter to use on fetch and store operations on the built DomainBucket

Parameters:

converter -

Returns:

this

withoutFetch

public DomainBucketBuilder<T> withoutFetch(boolean withoutFetch)

Sets whether a store operation should fetch existing value(s) from Riak (and the vector clock) and perform conflict resolution if required. Note this should only be used if you understand the ramifications.

Parameters:

withoutFetch -

Returns:

this

See Also:

StoreObject.withoutFetch()