Package com.priint.pubserver.comet.renderer

Enum Class Options.Scope

java.lang.Object

java.lang.Enum<Options.Scope>

com.priint.pubserver.comet.renderer.Options.Scope

All Implemented Interfaces:

Options.OptionEnumerationType, Serializable, Comparable<Options.Scope>, Constable

Enclosing class:

Options

public static enum Options.Scope
extends Enum<Options.Scope>
implements Options.OptionEnumerationType

The Enum Scope extension OptionEnumerationType

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
COMETGROUP	The cometgroup.
DOCUMENT	The document.
ELEMENT	The element.
PAGE	The page.
PLACEHOLDER	The placeholder.
SPREAD	The spread.

Method Summary

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

DOCUMENT

public static final Options.Scope DOCUMENT

The document.

COMETGROUP

public static final Options.Scope COMETGROUP

The cometgroup.

SPREAD

public static final Options.Scope SPREAD

The spread.

PAGE

public static final Options.Scope PAGE

The page.

ELEMENT

public static final Options.Scope ELEMENT

The element.

PLACEHOLDER

public static final Options.Scope PLACEHOLDER

The placeholder.

Method Details

values

public static Options.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 Options.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

getIdentifier

public String getIdentifier()

Description copied from interface: Options.OptionEnumerationType

Gets the identifier.

Specified by:

getIdentifier in interface Options.OptionEnumerationType

Returns:

the identifier