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

Enum OrderByItem.NullOrdering

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      The constant used when the ordering is not specify.
      NULLS_FIRST
      The constant for 'NULLS FIRST', which tells to order nulls first.
      NULLS_LAST
      The constant for 'NULLS LAST', which tells to order nulls last.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getIdentifier()
      Returns the actual JPQL composite identifiers identified by this enum constant.
      java.lang.String toString()
      static OrderByItem.NullOrdering valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OrderByItem.NullOrdering[] 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

      • NULLS_FIRST

        public static final OrderByItem.NullOrdering NULLS_FIRST
        The constant for 'NULLS FIRST', which tells to order nulls first.

      • NULLS_LAST

        public static final OrderByItem.NullOrdering NULLS_LAST
        The constant for 'NULLS LAST', which tells to order nulls last.

    • Method Detail

      • values

        public static OrderByItem.NullOrdering[] 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.NullOrdering c : OrderByItem.NullOrdering.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.NullOrdering 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

      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the actual JPQL composite identifiers identified by this enum constant.
        Returns:
        The composite identifiers