Package org.elasticsearch.search.sort

Enum ScriptSortBuilder.ScriptSortType

java.lang.Object

java.lang.Enum<ScriptSortBuilder.ScriptSortType>

org.elasticsearch.search.sort.ScriptSortBuilder.ScriptSortType

All Implemented Interfaces:

Serializable, Comparable<ScriptSortBuilder.ScriptSortType>, Writeable

Enclosing class:

ScriptSortBuilder

public static enum ScriptSortBuilder.ScriptSortType
extends Enum<ScriptSortBuilder.ScriptSortType>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NUMBER	script sort for a numeric value
STRING	script sort for a string value

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRING

public static final ScriptSortBuilder.ScriptSortType STRING

script sort for a string value

NUMBER

public static final ScriptSortBuilder.ScriptSortType NUMBER

script sort for a numeric value

Method Detail

values

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

Returns:

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

valueOf

public static ScriptSortBuilder.ScriptSortType 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

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromString

public static ScriptSortBuilder.ScriptSortType fromString(String str)

toString

public String toString()

Overrides:

toString in class Enum<ScriptSortBuilder.ScriptSortType>