com.couchbase.lite

Enum Query.AllDocsMode

java.lang.Object

java.lang.Enum<Query.AllDocsMode>

com.couchbase.lite.Query.AllDocsMode

All Implemented Interfaces:

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

Enclosing class:

Query

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

Changes the behavior of a query created by queryAllDocuments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_DOCS
BY_SEQUENCE
INCLUDE_DELETED
ONLY_CONFLICTS
SHOW_CONFLICTS

Method Summary

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

ALL_DOCS

public static final Query.AllDocsMode ALL_DOCS

INCLUDE_DELETED

public static final Query.AllDocsMode INCLUDE_DELETED

SHOW_CONFLICTS

public static final Query.AllDocsMode SHOW_CONFLICTS

ONLY_CONFLICTS

public static final Query.AllDocsMode ONLY_CONFLICTS

BY_SEQUENCE

public static final Query.AllDocsMode BY_SEQUENCE

Method Detail

values

public static Query.AllDocsMode[] 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.AllDocsMode c : Query.AllDocsMode.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.AllDocsMode 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