Package org.elasticsearch.search.sort

Enum Class SortOrder

<SortOrder>
org.elasticsearch.search.sort.SortOrder
All Implemented Interfaces:
, <, Writeable
public enum SortOrder extends <SortOrder> implements Writeable
A sorting order.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    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
     op)
     
    static SortOrder
    readFromStream​(StreamInput in)
     
    abstract int
    reverseMul()
    -1 if the sort is reversed from the standard comparators, 1 otherwise.
    static SortOrder
     name)
    Returns the enum constant of this class with the specified name.
    static SortOrder[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    abstract <T> <T>
    <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.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • 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 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  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:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • readFromStream

      public static SortOrder readFromStream​(StreamInput in) throws
      Throws:

    • writeTo

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

    • fromString

      public static  op)

    • reverseMul

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

    • wrap

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