org.sql.generation.api.grammar.query
Enum Ordering

java.lang.Object
  java.lang.Enum<Ordering>
      org.sql.generation.api.grammar.query.Ordering

All Implemented Interfaces:

Serializable, Comparable<Ordering>

public enum Ordering
extends Enum<Ordering>

This is enum for what kind of order will be applied to each ordering column. Can be either ASCENDING or DESCENDING.

Author:

Stanislav Muhametsin

See Also:

SortSpecification

Enum Constant Summary

ASCENDING
The ordering will be ascending (ASC).

DESCENDING
The ordering will be descending (DESC).

Method Summary

static Ordering	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

ASCENDING

public static final Ordering ASCENDING

The ordering will be ascending (ASC).

DESCENDING

public static final Ordering DESCENDING

The ordering will be descending (DESC).

Method Detail

values

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