org.axsl.common.value

Enum ForcePageCount

java.lang.Object

java.lang.Enum<ForcePageCount>

org.axsl.common.value.ForcePageCount

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ForcePageCount>

public enum ForcePageCount
extends java.lang.Enum<ForcePageCount>

Enumeration of possible "force-page-count" values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Force the last page in this page-sequence to be an odd-page if the initial-page-number of the next page-sequence is even.
END_ON_EVEN Force the last page in this page-sequence to be an even-page.
END_ON_ODD Force the last page in this page-sequence to be an odd-page.
EVEN Force an even number of pages in this page-sequence.
NO_FORCE Do not force either an even or odd number of pages in this page-sequence.
ODD Force an odd number of pages in this page-sequence.

Method Summary

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

AUTO

public static final ForcePageCount AUTO

Force the last page in this page-sequence to be an odd-page if the initial-page-number of the next page-sequence is even. Force it to be an even-page if the initial-page-number of the next page-sequence is odd. If there is no next page-sequence or if the value of its initial-page-number is "auto" do not force any page.

EVEN

public static final ForcePageCount EVEN

Force an even number of pages in this page-sequence.

ODD

public static final ForcePageCount ODD

Force an odd number of pages in this page-sequence.

END_ON_EVEN

public static final ForcePageCount END_ON_EVEN

Force the last page in this page-sequence to be an even-page.

END_ON_ODD

public static final ForcePageCount END_ON_ODD

Force the last page in this page-sequence to be an odd-page.

NO_FORCE

public static final ForcePageCount NO_FORCE

Do not force either an even or odd number of pages in this page-sequence.

Method Detail

values

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

Returns:

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

valueOf

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