com.unboundid.directory.sdk.common.config

Enum VelocityContextProviderConfig.ObjectScope

java.lang.Object

java.lang.Enum<VelocityContextProviderConfig.ObjectScope>

com.unboundid.directory.sdk.common.config.VelocityContextProviderConfig.ObjectScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VelocityContextProviderConfig.ObjectScope>

Enclosing interface:

VelocityContextProviderConfig

public static enum VelocityContextProviderConfig.ObjectScope
extends java.lang.Enum<VelocityContextProviderConfig.ObjectScope>

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION Objects added to the context should be scoped for the lifetime of the application.
REQUEST Objects added to the context should be scoped to the client's request.
SESSION Objects added to the context should be scoped to the client's session.

Method Summary

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

APPLICATION

public static final VelocityContextProviderConfig.ObjectScope APPLICATION

Objects added to the context should be scoped for the lifetime of the application.

SESSION

public static final VelocityContextProviderConfig.ObjectScope SESSION

Objects added to the context should be scoped to the client's session.

REQUEST

public static final VelocityContextProviderConfig.ObjectScope REQUEST

Objects added to the context should be scoped to the client's request.

Method Detail

values

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

Returns:

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

valueOf

public static VelocityContextProviderConfig.ObjectScope 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