org.craftercms.engine.macro.impl

Enum ScopeAttributeMacro.Scope

java.lang.Object

java.lang.Enum<ScopeAttributeMacro.Scope>

org.craftercms.engine.macro.impl.ScopeAttributeMacro.Scope

All Implemented Interfaces:

Serializable, Comparable<ScopeAttributeMacro.Scope>

Enclosing class:

ScopeAttributeMacro

public static enum ScopeAttributeMacro.Scope
extends Enum<ScopeAttributeMacro.Scope>

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUEST
SERVLET_CONTEXT
SESSION

Method Summary

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

SERVLET_CONTEXT

public static final ScopeAttributeMacro.Scope SERVLET_CONTEXT

SESSION

public static final ScopeAttributeMacro.Scope SESSION

REQUEST

public static final ScopeAttributeMacro.Scope REQUEST

Method Detail

values

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

Returns:

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

valueOf

public static ScopeAttributeMacro.Scope valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null