Package com.nsdev.lettergenerator.model.text

Enum Class PageNumber

java.lang.Object

java.lang.Enum<PageNumber>

com.nsdev.lettergenerator.model.text.PageNumber

All Implemented Interfaces:

Serializable, Comparable<PageNumber>, Constable

public enum PageNumber
extends Enum<PageNumber>

Dynamic physical page field evaluated by the renderer after pagination.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT	Number of the page on which the run is painted, starting at one.
TOTAL	Total physical pages, including an allocated signature-recovery page.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CURRENT

public static final PageNumber CURRENT

Number of the page on which the run is painted, starting at one.

TOTAL

public static final PageNumber TOTAL

Total physical pages, including an allocated signature-recovery page.

Method Details

values

public static PageNumber[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PageNumber valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null