org.axsl.area
Enum PageCollection.Force

java.lang.Object
  java.lang.Enum<PageCollection.Force>
      org.axsl.area.PageCollection.Force

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PageCollection.Force>

Enclosing interface:

PageCollection

public static enum PageCollection.Force
extends java.lang.Enum<PageCollection.Force>

Enumeration of possible "force" values when creating new pages.

Enum Constant Summary

EVEN
The new page should be forced to be even.

NONE
The new page should not be forced to be either odd or even.

ODD
The new page should be forced to be odd.

Method Summary

static PageCollection.Force	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PageCollection.Force[]	values() Returns an array containing the constants of this enum type, in the order they're 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

ODD

public static final PageCollection.Force ODD

The new page should be forced to be odd.

EVEN

public static final PageCollection.Force EVEN

The new page should be forced to be even.

NONE

public static final PageCollection.Force NONE

The new page should not be forced to be either odd or even.

Method Detail

values

public static final PageCollection.Force[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PageCollection.Force c : PageCollection.Force.values())
        System.out.println(c);

Returns:

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

valueOf

public static PageCollection.Force 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