Enum SortBy

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


    public enum SortBy
    extends java.lang.Enum<SortBy>
    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()
      Gets the value used by the API.
      static SortBy valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SortBy[] 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

      • POSITION

        public static final SortBy POSITION
      • TITLE

        public static final SortBy TITLE
      • CREATED_AT

        public static final SortBy CREATED_AT
      • UPDATED_AT

        public static final SortBy UPDATED_AT
    • Method Detail

      • values

        public static SortBy[] 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 (SortBy c : SortBy.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SortBy 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()
        Gets the value used by the API. This will be the enum's name in lower case.
        Returns:
        The value to use in an API call.