Package org.elasticsearch.search.sort

Enum SortOrder

java.lang.Object
java.lang.Enum<SortOrder>
org.elasticsearch.search.sort.SortOrder
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SortOrder>, java.lang.constant.Constable, Writeable
public enum SortOrder
extends java.lang.Enum<SortOrder>
implements Writeable
A sorting order.

  • 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

    Enum Constants
    Enum Constant Description
    ASC
    Ascending order.
    DESC
    Descending order.

  • Method Summary

    Modifier and Type Method Description
    static SortOrder fromString​(java.lang.String op)  
    static SortOrder readFromStream​(StreamInput in)  
    abstract int reverseMul()
    -1 if the sort is reversed from the standard comparators, 1 otherwise.
    static SortOrder valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SortOrder[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    abstract <T> java.util.Comparator<T> wrap​(java.util.Comparator<T> delegate)
    Wrap a comparator in one for this direction.
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    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

    • ASC

      public static final SortOrder ASC
      Ascending order.

    • DESC

      public static final SortOrder DESC
      Descending order.

  • Method Details

    • values

      public static SortOrder[] 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

      public static SortOrder valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • readFromStream

      public static SortOrder readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • fromString

      public static SortOrder fromString​(java.lang.String op)

    • reverseMul

      public abstract int reverseMul()
      -1 if the sort is reversed from the standard comparators, 1 otherwise.

    • wrap

      public abstract <T> java.util.Comparator<T> wrap​(java.util.Comparator<T> delegate)
      Wrap a comparator in one for this direction.