com.couchbase.client.java

Enum PersistTo

java.lang.Object

java.lang.Enum<PersistTo>

com.couchbase.client.java.PersistTo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PersistTo>

public enum PersistTo
extends java.lang.Enum<PersistTo>

Defines the possible disk persistence constraints to observe.

Since:

2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOUR Observe disk persistence of four nodes (one master and three replicas).
MASTER Observe disk persistence to the master node of the document only.
NONE Do not observe any disk persistence constraint.
ONE Observe disk persistence of one node (master or replica).
THREE Observe disk persistence of three nodes (master or replica).
TWO Observe disk persistence of two nodes (master or replica).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	touchesReplica() Identifies if this enum property will touch a replica or just the master.
short	value() Returns the actual internal persistence representation for the enum.
static PersistTo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersistTo[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MASTER

public static final PersistTo MASTER

Observe disk persistence to the master node of the document only.

NONE

public static final PersistTo NONE

Do not observe any disk persistence constraint.

ONE

public static final PersistTo ONE

Observe disk persistence of one node (master or replica).

TWO

public static final PersistTo TWO

Observe disk persistence of two nodes (master or replica).

THREE

public static final PersistTo THREE

Observe disk persistence of three nodes (master or replica).

FOUR

public static final PersistTo FOUR

Observe disk persistence of four nodes (one master and three replicas).

Method Detail

values

public static PersistTo[] 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 (PersistTo c : PersistTo.values())
    System.out.println(c);

Returns:

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

valueOf

public static PersistTo valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public short value()

Returns the actual internal persistence representation for the enum.

Returns:

the internal persistence 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.