pt.digitalis.dif.dem.objects.parameters
Enum ParameterScope

java.lang.Object
  java.lang.Enum<ParameterScope>
      pt.digitalis.dif.dem.objects.parameters.ParameterScope

All Implemented Interfaces:

Serializable, Comparable<ParameterScope>

public enum ParameterScope
extends Enum<ParameterScope>

Parameter persistence scopes

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

Nov 2, 2007

Enum Constant Summary

REQUEST
Parameter value will persist only during the request execution and for the current session.

SESSION
Parameter value will persist during the current session of the current user.

STATIC
Parameter value will persist while the JVM is up.

USER
Parameter value will persist between sessions for the current user.

Method Summary

static ParameterScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ParameterScope[]	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

REQUEST

public static final ParameterScope REQUEST

Parameter value will persist only during the request execution and for the current session. Much like an class instance attribute.

STATIC

public static final ParameterScope STATIC

Parameter value will persist while the JVM is up. It's value will be shared among sessions. Much like a class static attribute.

SESSION

public static final ParameterScope SESSION

Parameter value will persist during the current session of the current user.

USER

public static final ParameterScope USER

Parameter value will persist between sessions for the current user. A session parameter common to all session of the same user. Kept in the JVM, not in the persistent repository

Method Detail

values

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

Returns:

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

valueOf

public static ParameterScope 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