org.loom.servlet
Enum Scope

java.lang.Object
  java.lang.Enum<Scope>
      org.loom.servlet.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Scope>

public enum Scope
extends java.lang.Enum<Scope>

The web scope. Supported scopes are:

• Standard JEE scopes: page, request, session or application
• Extended scopes: flash or conversation. These have an ID value greater than 1000, and are handled apart by Loom.

Declaration order is the order of fetching scopes, unless a concrete scope has been specified.

Enum Constant Summary

APPLICATION

FLASH

PAGE

REQUEST

SESSION

Method Summary

static Scope	fromString(java.lang.String scope)
int	getId()
boolean	isJEE()
java.lang.String	toString()
static Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static 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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAGE

public static final Scope PAGE

REQUEST

public static final Scope REQUEST

FLASH

public static final Scope FLASH

SESSION

public static final Scope SESSION

APPLICATION

public static final Scope APPLICATION

Method Detail

values

public static 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 (Scope c : 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 Scope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getId

public int getId()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Scope>

fromString

public static Scope fromString(java.lang.String scope)

isJEE

public boolean isJEE()

Returns:

true if the scope is a standard JEE scope: page, request, session or application