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>
public enum ReplicaMode extends Enum<ReplicaMode>
Represents the different modes to read from replica nodes.- Since:
- 2.0
- Author:
- Michael Nitschinger
-
-
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
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static ReplicaMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ReplicaMode c : ReplicaMode.values()) System.out.println(c);
- 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 nameNullPointerException
- if the argument is null
-
maxAffectedNodes
public int maxAffectedNodes()
-
-