org.axsl.common.value

Enum PageNumberTreatment

java.lang.Object

java.lang.Enum<PageNumberTreatment>

org.axsl.common.value.PageNumberTreatment

All Implemented Interfaces:

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

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

An enumeration of possible "page-number-treatment" options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINK Page numbers in the index should be hyperlinks back to the source of the reference.
NO_LINK Page numbers in the index are not links.

Method Summary

Modifier and Type	Method and Description
boolean	isLink() Indicates whether page numbers should be linked.
static PageNumberTreatment	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PageNumberTreatment[]	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

LINK

public static final PageNumberTreatment LINK

Page numbers in the index should be hyperlinks back to the source of the reference.

NO_LINK

public static final PageNumberTreatment NO_LINK

Page numbers in the index are not links.

Method Detail

values

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

Returns:

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

valueOf

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

isLink

public boolean isLink()

Indicates whether page numbers should be linked.

Returns:

True iff page numbers should be linked.