io.ebean.annotation

Enum DocProperty.Option

java.lang.Object

java.lang.Enum<DocProperty.Option>

io.ebean.annotation.DocProperty.Option

All Implemented Interfaces:

Serializable, Comparable<DocProperty.Option>

Enclosing class:

DocProperty

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

Index options for a property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Use the default which means analysed string properties use POSITIONS as the default and all other types use DOCS.
DOCS Only index the doc number.
FREQS Doc number and term frequencies are indexed.
OFFSETS Doc number, term frequencies, term positions and start/end offsets are indexed.
POSITIONS Doc number, term frequencies and term positions are indexed.

Method Summary

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOCS

public static final DocProperty.Option DOCS

Only index the doc number.

FREQS

public static final DocProperty.Option FREQS

Doc number and term frequencies are indexed.

POSITIONS

public static final DocProperty.Option POSITIONS

Doc number, term frequencies and term positions are indexed.

OFFSETS

public static final DocProperty.Option OFFSETS

Doc number, term frequencies, term positions and start/end offsets are indexed.

DEFAULT

public static final DocProperty.Option DEFAULT

Use the default which means analysed string properties use POSITIONS as the default and all other types use DOCS.

Method Detail

values

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

Returns:

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

valueOf

public static DocProperty.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