Package com.couchbase.client.java.view

Enum DesignDocument.Option

java.lang.Object

java.lang.Enum<DesignDocument.Option>

com.couchbase.client.java.view.DesignDocument.Option

All Implemented Interfaces:

Serializable, Comparable<DesignDocument.Option>, java.lang.constant.Constable

Enclosing class:

DesignDocument

public static enum DesignDocument.Option
extends Enum<DesignDocument.Option>

Optional design document options.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REPLICA_UPDATE_MIN_CHANGES	The minimum changes to perform on a design document before replica indexing is triggered.
UPDATE_MIN_CHANGES	The minimum changes to perform on a design document before indexing is triggered.

Method Summary

Modifier and Type	Method	Description
String	alias()
static DesignDocument.Option	fromName(String name)
static DesignDocument.Option	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DesignDocument.Option[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UPDATE_MIN_CHANGES

public static final DesignDocument.Option UPDATE_MIN_CHANGES

The minimum changes to perform on a design document before indexing is triggered.

REPLICA_UPDATE_MIN_CHANGES

public static final DesignDocument.Option REPLICA_UPDATE_MIN_CHANGES

The minimum changes to perform on a design document before replica indexing is triggered.

Method Details

values

public static DesignDocument.Option[] values()

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

Returns:

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

valueOf

public static DesignDocument.Option 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

alias

public String alias()

fromName

public static DesignDocument.Option fromName(String name)