com.basho.riak.client.api.cap

Class Quorum

java.lang.Object

com.basho.riak.client.api.cap.Quorum

public final class Quorum
extends Object

Encapsulates a r/w/dw/rw/pr/pw quorum.

Symbolic Consistency Names

Riak 0.12 introduced “symbolic” consistency options for R and W that can be easier to use and understand. They are:

• all - All replicas must reply. This is the same as setting R or W equal to N.
• one - This is the same as sending 1 as the R or W value.
• quorum - A majority of the replicas must respond, that is, “half plus one”. For the default N value of 3, this calculates to 2.
• default - Uses whatever the per-bucket consistency property is for R or W, which may be any of the above values, or an integer.

Static factory methods are provided as a convenience for using these.

Since:

2.0

Author:

Brian Roach

See Also:

CAP Controls

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL
static String	DEFAULT
static String	ONE
static String	QUORUM

Constructor Summary

Constructors

Constructor and Description
Quorum(int i) Construct an instance using an integer value.

Method Summary

Methods

Modifier and Type	Method and Description
static Quorum	allQuorum() Static factory method for a quorum of "all"
static Quorum	defaultQuorum() Static factory method for a quorum of "default"
boolean	equals(Object obj)
int	getIntValue() The int value of the quorum.
int	hashCode()
boolean	isSymbolic() Determine if the quorum has a symbolic value.
static Quorum	oneQuorum() Static factory method for a quorum of "one"
static Quorum	quorumQuorum() Static factory method for a quorum of "quorum"
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ONE

public static final String ONE

See Also:

Constant Field Values

QUORUM

public static final String QUORUM

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

Constructor Detail

Quorum

public Quorum(int i)

Construct an instance using an integer value.

Parameters:

i - the quorum value

Method Detail

oneQuorum

public static Quorum oneQuorum()

Static factory method for a quorum of "one"

Returns:

a new Quorum with an integer value of -2

quorumQuorum

public static Quorum quorumQuorum()

Static factory method for a quorum of "quorum"

Returns:

a new Quorum with an integer value of -3

allQuorum

public static Quorum allQuorum()

Static factory method for a quorum of "all"

Returns:

a new Quorum with an integer value of -4

defaultQuorum

public static Quorum defaultQuorum()

Static factory method for a quorum of "default"

Returns:

a new Quorum with an integer value of -5

isSymbolic

public boolean isSymbolic()

Determine if the quorum has a symbolic value.

Returns:

true if this Quorum represents a symbolic value, false if literal integer value

getIntValue

public int getIntValue()

The int value of the quorum. Call isSymbolic to determine if you should use this.

Returns:

the int value. Will be a negative number for symbolic values.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object