com.couchbase.client.java.query.dsl.path.index

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

com.couchbase.client.java.query.dsl.path.index.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public enum IndexType
extends Enum<IndexType>

Enum of the different types of indexes supported by N1QL.

Since:

2.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
GSI
VIEW

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

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

GSI

public static final IndexType GSI

VIEW

public static final IndexType VIEW

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