Package com.couchbase.client.java
Enum ReplicateTo
- java.lang.Object
-
- java.lang.Enum<ReplicateTo>
-
- com.couchbase.client.java.ReplicateTo
-
- All Implemented Interfaces:
Serializable
,Comparable<ReplicateTo>
public enum ReplicateTo extends Enum<ReplicateTo>
Defines the possible replication constraints to observe.- Since:
- 2.0
- Author:
- Michael Nitschinger
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
touchesReplica()
Identifies if this enum property will touch a replica or just the master.Observe.ReplicateTo
value()
Returns the actual internal replication representation for the enum.static ReplicateTo
valueOf(String name)
Returns the enum constant of this type with the specified name.static ReplicateTo[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final ReplicateTo NONE
Do not observe any replication constraint.
-
ONE
public static final ReplicateTo ONE
Observe replication to one replica.
-
TWO
public static final ReplicateTo TWO
Observe replication to two replicas.
-
THREE
public static final ReplicateTo THREE
Observe replication to three replicas.
-
-
Method Detail
-
values
public static ReplicateTo[] 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 (ReplicateTo c : ReplicateTo.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ReplicateTo 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
-
value
public Observe.ReplicateTo value()
Returns the actual internal replication representation for the enum.- Returns:
- the internal replication representation.
-
touchesReplica
public boolean touchesReplica()
Identifies if this enum property will touch a replica or just the master.- Returns:
- true if it includes a replica, false if not.
-
-