com.gnostice.documents.enums

Enum PageRange

java.lang.Object

java.lang.Enum<PageRange>

com.gnostice.documents.enums.PageRange

All Implemented Interfaces:

Serializable, Comparable<PageRange>

public enum PageRange
extends Enum<PageRange>

Defines constants for specifying which pages in a page range need to be used for a document-processing operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All pages.
EVEN Only even pages.
ODD Only odd pages.

Method Summary

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

ALL

public static final PageRange ALL

All pages.

EVEN

public static final PageRange EVEN

Only even pages.

ODD

public static final PageRange ODD

Only odd pages.

Method Detail

values

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

Returns:

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

valueOf

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