org.springframework.data.elasticsearch.core.suggest.response

Enum SortBy

java.lang.Object

java.lang.Enum<SortBy>

org.springframework.data.elasticsearch.core.suggest.response.SortBy

All Implemented Interfaces:

Serializable, Comparable<SortBy>

public enum SortBy
extends Enum<SortBy>

Since:

4.3

Author:

Peter-Josef Meisch

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREQUENCY
SCORE

Method Summary

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

FREQUENCY

public static final SortBy FREQUENCY

Method Detail

values

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

Returns:

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

valueOf

public static SortBy 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