com.couchbase.client.java.view

Enum Stale

java.lang.Object

java.lang.Enum<Stale>

com.couchbase.client.java.view.Stale

All Implemented Interfaces:

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

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

Sets the staleness requirement for the view query.

Since:

2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
TRUE
UPDATE_AFTER

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	identifier()
static Stale	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Stale[]	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

TRUE

public static final Stale TRUE

FALSE

public static final Stale FALSE

UPDATE_AFTER

public static final Stale UPDATE_AFTER

Method Detail

values

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

Returns:

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

valueOf

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

identifier

public java.lang.String identifier()