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

Enum Class SortBy

java.lang.Object

java.lang.Enum<SortBy>

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

All Implemented Interfaces:

Serializable, Comparable<SortBy>, Constable

public enum SortBy
extends Enum<SortBy>

Since:

4.3

Author:

Peter-Josef Meisch

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
FREQUENCY
SCORE

Method Summary

Modifier and Type	Method	Description
static SortBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortBy[]	values()	Returns an array containing the constants of this enum class, 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

SCORE

public static final SortBy SCORE

FREQUENCY

public static final SortBy FREQUENCY

Method Details

values

public static SortBy[] values()

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

Returns:

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

valueOf

public static SortBy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null