Package org.elasticsearch.search.suggest
Enum SortBy
java.lang.Object
java.lang.Enum<SortBy>
org.elasticsearch.search.suggest.SortBy
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SortBy>
,java.lang.constant.Constable
,Writeable
public enum SortBy extends java.lang.Enum<SortBy> implements Writeable
An enum representing the valid sorting options
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description static SortBy
readFromStream(StreamInput in)
static SortBy
resolve(java.lang.String str)
static SortBy
valueOf(java.lang.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.void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Enum Constant Details
-
Method Details
-
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
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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
readFromStream
- Throws:
java.io.IOException
-
resolve
-