Package com.priint.pubserver.metadata.base

Enum Class Scope

java.lang.Object

java.lang.Enum<Scope>

com.priint.pubserver.metadata.base.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, Constable

public enum Scope
extends Enum<Scope>

Values for the document.ref XML attribute.

Values for the document.ref XML attribute. Currently referred in the Document interface only.
Scope describes the region of the document, which is covered by a XML document. This could be the entire document (DOCUMENT) or a single frame (ELEMENT) or any other of the values defined by this enumeration.

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
DOCUMENT	entire document
ELEMENT	an element, i.e.
GROUP	a comet group
PAGE	single page
PLACEHOLDER	a placeholder
SPREAD	spread, i.e.
UNDEFINED	The scope is undefined.

Method Summary

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

UNDEFINED

public static final Scope UNDEFINED

The scope is undefined.

DOCUMENT

public static final Scope DOCUMENT

entire document

SPREAD

public static final Scope SPREAD

spread, i.e. one or several pages

PAGE

public static final Scope PAGE

single page

GROUP

public static final Scope GROUP

a comet group

ELEMENT

public static final Scope ELEMENT

an element, i.e. text or graphic frame

PLACEHOLDER

public static final Scope PLACEHOLDER

a placeholder

Method Details

values

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