org.apache.olingo.odata2.api.uri.expression

## Enum SortOrder

- java.lang.Object
- - java.lang.Enum<SortOrder>
  - - org.apache.olingo.odata2.api.uri.expression.SortOrder

- All Implemented Interfaces:
    Serializable, Comparable<SortOrder>

      public enum SortOrder
      extends Enum<SortOrder>

  Enumeration describing all possible sort orders used in an $orderby expression

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `asc` Sort order ascending
    `desc` Sort order descending

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `toString()`
    `String` | `toUriLiteral()`
    `static SortOrder` | `valueOf(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.

    - ### 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

    - #### asc

          public static final SortOrder asc

      Sort order ascending

    - #### desc

          public static final SortOrder desc

      Sort order descending

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Enum<SortOrder>`
      Returns:
        Operators name for usage in in text

    - #### toUriLiteral

          public String toUriLiteral()

      Returns:
        URI literal of the unary operator as used in the URL.

Copyright © 2013-2023 The Apache Software Foundation. All Rights Reserved.