Package com.couchbase.client.java

Enum ReplicaMode

java.lang.Object

java.lang.Enum<ReplicaMode>

com.couchbase.client.java.ReplicaMode

All Implemented Interfaces:

Serializable, Comparable<ReplicaMode>, java.lang.constant.Constable

public enum ReplicaMode
extends Enum<ReplicaMode>

Represents the different modes to read from replica nodes.

Since:

2.0

Author:

Michael Nitschinger

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Get from all replicas and the active node.
FIRST	Get only from the first replica configured for the document.
SECOND	Get only from the second replica configured for the document.
THIRD	Get only from the third replica configured for the document.

Method Summary

Modifier and Type	Method	Description
int	maxAffectedNodes()
static ReplicaMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReplicaMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final ReplicaMode ALL

Get from all replicas and the active node.

FIRST

public static final ReplicaMode FIRST

Get only from the first replica configured for the document.

SECOND

public static final ReplicaMode SECOND

Get only from the second replica configured for the document.

THIRD

public static final ReplicaMode THIRD

Get only from the third replica configured for the document.

Method Details

values

public static ReplicaMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReplicaMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

maxAffectedNodes

public int maxAffectedNodes()