com.couchbase.lite

Enum Query.IndexUpdateMode

java.lang.Object

java.lang.Enum<Query.IndexUpdateMode>

com.couchbase.lite.Query.IndexUpdateMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Query.IndexUpdateMode>

Enclosing class:

Query

public static enum Query.IndexUpdateMode
extends java.lang.Enum<Query.IndexUpdateMode>

Determines whether or when the view index is updated. By default, the index will be updated if necessary before the query runs -- this guarantees up-to-date results but can cause a delay.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER
BEFORE
NEVER

Method Summary

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

BEFORE

public static final Query.IndexUpdateMode BEFORE

NEVER

public static final Query.IndexUpdateMode NEVER

AFTER

public static final Query.IndexUpdateMode AFTER

Method Detail

values

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

Returns:

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

valueOf

public static Query.IndexUpdateMode 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