org.springframework.data.couchbase.core.query

Enum Consistency

java.lang.Object

java.lang.Enum<Consistency>

org.springframework.data.couchbase.core.query.Consistency

All Implemented Interfaces:

Serializable, Comparable<Consistency>

public enum Consistency
extends Enum<Consistency>

Enumeration of different consistency configurations to be used by the queries generated by the framework. Each consistency can be translated to a Stale (for the views) and ScanConsistency (for the N1QL queries).

Author:

Simon Baslé

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENTUALLY_CONSISTENT EVENTUALLY_CONSISTENT is Stale.TRUE and ScanConsistency.NOT_BOUNDED
READ_YOUR_OWN_WRITES READ_YOUR_OWN_WRITES is Stale.FALSE and ScanConsistency.STATEMENT_PLUS
STRONGLY_CONSISTENT STRONGLY_CONSISTENT is Stale.FALSE and ScanConsistency.REQUEST_PLUS
UPDATE_AFTER UPDATE_AFTER is Stale.UPDATE_AFTER and ScanConsistency.NOT_BOUNDED

Field Summary

Fields

Modifier and Type	Field and Description
static Consistency	DEFAULT_CONSISTENCY The static default Consistency (READ_YOUR_OWN_WRITES).

Method Summary

Modifier and Type	Method and Description
com.couchbase.client.java.query.consistency.ScanConsistency	n1qlConsistency() Returns the N1QL consistency corresponding to this Consistency.
static Consistency	valueOf(String name) Returns the enum constant of this type with the specified name.
static Consistency[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
com.couchbase.client.java.view.Stale	viewConsistency() Returns the view consistency corresponding to this Consistency.

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

READ_YOUR_OWN_WRITES

public static final Consistency READ_YOUR_OWN_WRITES

READ_YOUR_OWN_WRITES is Stale.FALSE and ScanConsistency.STATEMENT_PLUS

STRONGLY_CONSISTENT

public static final Consistency STRONGLY_CONSISTENT

STRONGLY_CONSISTENT is Stale.FALSE and ScanConsistency.REQUEST_PLUS

UPDATE_AFTER

public static final Consistency UPDATE_AFTER

UPDATE_AFTER is Stale.UPDATE_AFTER and ScanConsistency.NOT_BOUNDED

EVENTUALLY_CONSISTENT

public static final Consistency EVENTUALLY_CONSISTENT

EVENTUALLY_CONSISTENT is Stale.TRUE and ScanConsistency.NOT_BOUNDED

Field Detail

DEFAULT_CONSISTENCY

public static final Consistency DEFAULT_CONSISTENCY

The static default Consistency (READ_YOUR_OWN_WRITES).

Method Detail

values

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

Returns:

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

valueOf

public static Consistency 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

viewConsistency

public com.couchbase.client.java.view.Stale viewConsistency()

Returns the view consistency corresponding to this Consistency.

Returns:

the view consistency.

n1qlConsistency

public com.couchbase.client.java.query.consistency.ScanConsistency n1qlConsistency()

Returns the N1QL consistency corresponding to this Consistency.

Returns:

the N1QL consistency.