Package com.apple.foundationdb.record.lucene

Enum LuceneFunctionNames.LuceneFieldIndexOptions

java.lang.Object

java.lang.Enum<LuceneFunctionNames.LuceneFieldIndexOptions>

com.apple.foundationdb.record.lucene.LuceneFunctionNames.LuceneFieldIndexOptions

All Implemented Interfaces:

Serializable, Comparable<LuceneFunctionNames.LuceneFieldIndexOptions>, java.lang.constant.Constable

Enclosing class:

LuceneFunctionNames

public static enum LuceneFunctionNames.LuceneFieldIndexOptions
extends Enum<LuceneFunctionNames.LuceneFieldIndexOptions>

Option keys for LuceneFunctionNames.LUCENE_FULL_TEXT_FIELD_INDEX_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
DOCS
DOCS_AND_FREQS
DOCS_AND_FREQS_AND_POSITIONS
DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS

Method Summary

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

DOCS

public static final LuceneFunctionNames.LuceneFieldIndexOptions DOCS

DOCS_AND_FREQS

public static final LuceneFunctionNames.LuceneFieldIndexOptions DOCS_AND_FREQS

DOCS_AND_FREQS_AND_POSITIONS

public static final LuceneFunctionNames.LuceneFieldIndexOptions DOCS_AND_FREQS_AND_POSITIONS

DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS

public static final LuceneFunctionNames.LuceneFieldIndexOptions DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS

Method Details

values

public static LuceneFunctionNames.LuceneFieldIndexOptions[] 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 LuceneFunctionNames.LuceneFieldIndexOptions 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