Constants.Config.Values.Scope

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.bemoko.live.platform
Enum Constants.Config.Values.Scope

java.lang.Object
  java.lang.Enum<Constants.Config.Values.Scope>
      com.bemoko.live.platform.Constants.Config.Values.Scope

All Implemented Interfaces:: Serializable, Comparable<Constants.Config.Values.Scope>

Enclosing class:: Constants.Config.Values

public static enum Constants.Config.Values.Scope
extends Enum<Constants.Config.Values.Scope>
extends Enum<Constants.Config.Values.Scope>

Enum Constant Summary
`CONTAINER` Container scope is when the object is to be taken from the container site
`PARENT` Parent scope is when the object is to be taken from the parent site (only applicable to script engine loading)
`REQUEST` Request scope is when the object is to be used / evaluated the current request
`SESSION` Session scope is when the object is to be used / evaluated the user session
`SITE` Site scope is when the object is to be used / evaluated the current site

Method Summary
`static Constants.Config.Values.Scope`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Constants.Config.Values.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

PARENT

public static final Constants.Config.Values.Scope PARENT

Parent scope is when the object is to be taken from the parent site (only applicable to script engine loading)

REQUEST

public static final Constants.Config.Values.Scope REQUEST

Request scope is when the object is to be used / evaluated the current request

SITE

public static final Constants.Config.Values.Scope SITE

Site scope is when the object is to be used / evaluated the current site

SESSION

public static final Constants.Config.Values.Scope SESSION

Session scope is when the object is to be used / evaluated the user session

CONTAINER

public static final Constants.Config.Values.Scope CONTAINER

Container scope is when the object is to be taken from the container site

Method Detail

values

public static Constants.Config.Values.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 (Constants.Config.Values.Scope c : Constants.Config.Values.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 Constants.Config.Values.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