Package org.concordion.api

Enum Class Scope

java.lang.Object

java.lang.Enum<Scope>

org.concordion.api.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, Constable

public enum Scope
extends Enum<Scope>

Defines the scope of fields.

Since:

2.0.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
EXAMPLE	Per example (where the example uses the concordion example command).
SPECIFICATION	Per specification.

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

EXAMPLE

public static final Scope EXAMPLE

Per example (where the example uses the concordion example command).

SPECIFICATION

public static final Scope SPECIFICATION

Per specification.

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