org.nuxeo.common.collections
Enum ScopeType

java.lang.Object
  java.lang.Enum<ScopeType>
      org.nuxeo.common.collections.ScopeType

All Implemented Interfaces:

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

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

Scope type definitions for a scoped map.

Only request and default scopes are defined for now, but others may be added.

Author:

Anahide Tchertchian

See Also:

ScopedMap

Enum Constant Summary

DEFAULT

REQUEST

Method Summary

java.lang.String	getScopedKey(java.lang.String key)
java.lang.String	getScopePrefix()
static ScopeType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScopeType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final ScopeType DEFAULT

REQUEST

public static final ScopeType REQUEST

Method Detail

values

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

Returns:

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

valueOf

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

getScopedKey

public java.lang.String getScopedKey(java.lang.String key)

getScopePrefix

public java.lang.String getScopePrefix()