Enum SortOrder

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SortOrder>


    public enum SortOrder
    extends java.lang.Enum<SortOrder>
    This enum models the sorting types available in Help Center
    See Also:
    Sorting
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getApiValue()
      This returns the value to use in an API call for this enum
      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.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ASCENDING

        public static final SortOrder ASCENDING
      • DESCENDING

        public static final SortOrder 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(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
      • getApiValue

        public java.lang.String getApiValue()
        This returns the value to use in an API call for this enum
        Returns:
        The value to use in an API call for this enum.