com.gnostice.documents.enums

Enum PageOrdering

java.lang.Object

java.lang.Enum<PageOrdering>

com.gnostice.documents.enums.PageOrdering

All Implemented Interfaces:

Serializable, Comparable<PageOrdering>

public enum PageOrdering
extends Enum<PageOrdering>

Defines constants for ordering pages in a given page range.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL In the specified/available order.
REVERSE Reverse of the specified/available order.

Method Summary

Modifier and Type	Method and Description
static PageOrdering	valueOf(String name) Returns the enum constant of this type with the specified name.
static PageOrdering[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final PageOrdering NORMAL

In the specified/available order.

REVERSE

public static final PageOrdering REVERSE

Reverse of the specified/available order.

Method Detail

values

public static PageOrdering[] 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 (PageOrdering c : PageOrdering.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PageOrdering 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