Package org.hibernate

Enum NullPrecedence

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

    public enum NullPrecedence
    extends java.lang.Enum<NullPrecedence>
    Defines precedence of null values within ORDER BY clause.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FIRST
      Null values appear at the beginning of the sorted collection.
      LAST
      Null values appear at the end of the sorted collection.
      NONE
      Null precedence not specified.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static NullPrecedence parse​(java.lang.String name)
      Interprets a string representation of a NullPrecedence, returning null by default.
      static NullPrecedence parse​(java.lang.String name, NullPrecedence defaultValue)
      Interprets a string representation of a NullPrecedence, returning the specified default if not recognized.
      static NullPrecedence valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NullPrecedence[] 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

      • NONE

        public static final NullPrecedence NONE
        Null precedence not specified. Relies on the RDBMS implementation.
      • FIRST

        public static final NullPrecedence FIRST
        Null values appear at the beginning of the sorted collection.
      • LAST

        public static final NullPrecedence LAST
        Null values appear at the end of the sorted collection.
    • Method Detail

      • values

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

        public static NullPrecedence 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
      • parse

        public static NullPrecedence parse​(java.lang.String name)
        Interprets a string representation of a NullPrecedence, returning null by default. For alternative default handling, see parse(String, NullPrecedence)
        Parameters:
        name - The String representation to interpret
        Returns:
        The recognized NullPrecedence, or null
      • parse

        public static NullPrecedence parse​(java.lang.String name,
                                           NullPrecedence defaultValue)
        Interprets a string representation of a NullPrecedence, returning the specified default if not recognized.
        Parameters:
        name - The String representation to interpret
        defaultValue - The default value to use
        Returns:
        The recognized NullPrecedence, or defaultValue.