Package org.eclipse.persistence.jpa.jpql.parser

Enum OrderByItem.Ordering

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OrderByItem.Ordering>
    Enclosing class:
    OrderByItem
    public static enum OrderByItem.Ordering
extends java.lang.Enum<OrderByItem.Ordering>
    This enumeration lists all the possible choices for ordering an item.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ASC
      The constant for 'ASC', which tells to order the items in ascending ordering.
      DEFAULT
      The constant used when the ordering is not specify, the default is ascending ordering.
      DESC
      The constant for 'DESC', which tells to order the items in descending ordering.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static OrderByItem.Ordering valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OrderByItem.Ordering[] 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

      • ASC

        public static final OrderByItem.Ordering ASC
        The constant for 'ASC', which tells to order the items in ascending ordering.

      • DEFAULT

        public static final OrderByItem.Ordering DEFAULT
        The constant used when the ordering is not specify, the default is ascending ordering.

      • DESC

        public static final OrderByItem.Ordering DESC
        The constant for 'DESC', which tells to order the items in descending ordering.

    • Method Detail

      • values

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

      • valueOf

        public static OrderByItem.Ordering 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