com.couchbase.lite

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

com.couchbase.lite.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>

public enum IndexType
extends Enum<IndexType>

Types of database indexes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FullText Full-text index.
Predictive Index of prediction() results (Enterprise Edition only)
Value Regular index of property values.

Method Summary

Modifier and Type	Method and Description
static IndexType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Value

public static final IndexType Value

Regular index of property values.

FullText

public static final IndexType FullText

Full-text index.

Predictive

public static final IndexType Predictive

Index of prediction() results (Enterprise Edition only)

Method Detail

values

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

Returns:

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

valueOf

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