org.hibernate.query

Enum NullOrdering

java.lang.Object

java.lang.Enum<NullOrdering>

org.hibernate.query.NullOrdering

All Implemented Interfaces:

Serializable, Comparable<NullOrdering>

public enum NullOrdering
extends Enum<NullOrdering>

The order of null.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST Null is always ordered first.
GREATEST Null is treated as the greatest value.
LAST Null is always ordered last.
SMALLEST Null is treated as the smallest value.

Method Summary

Modifier and Type	Method and Description
static NullOrdering	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SMALLEST

public static final NullOrdering SMALLEST

Null is treated as the smallest value.

GREATEST

public static final NullOrdering GREATEST

Null is treated as the greatest value.

FIRST

public static final NullOrdering FIRST

Null is always ordered first.

LAST

public static final NullOrdering LAST

Null is always ordered last.

Method Detail

values

public static 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 (NullOrdering c : 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 NullOrdering valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null