Package de.espirit.firstspirit.access.store.templatestore.gom

Enum Class PageRefMode

java.lang.Object

java.lang.Enum<PageRefMode>

de.espirit.firstspirit.access.store.templatestore.gom.PageRefMode

All Implemented Interfaces:

Serializable, Comparable<PageRefMode>, Constable

public enum PageRefMode
extends Enum<PageRefMode>

Switch defining the kind of possible references

Since:

2.0

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
BOTH	Allow page references and references to sections thereof
PAGE	Allow page references only
SECTION	Allow references to the current page's sections only

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PAGE

public static final PageRefMode PAGE

Allow page references only

Since:

2.0

BOTH

public static final PageRefMode BOTH

Allow page references and references to sections thereof

Since:

2.0

SECTION

public static final PageRefMode SECTION

Allow references to the current page's sections only

Since:

2.0

Method Details

values

public static PageRefMode[] 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 PageRefMode 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