org.elasticsearch.search.suggest

Enum Suggest.Suggestion.Sort

java.lang.Object

java.lang.Enum<Suggest.Suggestion.Sort>

org.elasticsearch.search.suggest.Suggest.Suggestion.Sort

All Implemented Interfaces:

Serializable, Comparable<Suggest.Suggestion.Sort>

Enclosing class:

Suggest.Suggestion<T extends Suggest.Suggestion.Entry>

public static enum Suggest.Suggestion.Sort
extends Enum<Suggest.Suggestion.Sort>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREQUENCY Sort should first be based on document frequency.
SCORE Sort should first be based on score.

Method Summary

Methods

Modifier and Type	Method and Description
static Suggest.Suggestion.Sort	fromId(byte id)
byte	id()
static Suggest.Suggestion.Sort	valueOf(String name) Returns the enum constant of this type with the specified name.
static Suggest.Suggestion.Sort[]	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

SCORE

public static final Suggest.Suggestion.Sort SCORE

Sort should first be based on score.

FREQUENCY

public static final Suggest.Suggestion.Sort FREQUENCY

Sort should first be based on document frequency.

Method Detail

values

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

Returns:

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

valueOf

public static Suggest.Suggestion.Sort 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

id

public byte id()

fromId

public static Suggest.Suggestion.Sort fromId(byte id)