org.infinispan.factories.scopes
Enum Scopes

java.lang.Object
  extended by java.lang.Enum<Scopes>
      extended by org.infinispan.factories.scopes.Scopes
All Implemented Interfaces:
Serializable, Comparable<Scopes>

public enum Scopes
extends Enum<Scopes>

The different scopes that can be declared for a component in the cache system. If components are not bounded to a specific scope explicitly, then it defaults to the NAMED_CACHE scope.

Since:
4.0
Author:
Manik Surtani
See Also:
Scope

Enum Constant Summary
GLOBAL
          Components bounded to this scope can only be created by a DefaultCacheManager and exist in the DefaultCacheManager's ComponentRegistry.
NAMED_CACHE
          Components bounded to this scope can only be created by a Cache and exist in the Cache's ComponentRegistry.
 
Method Summary
static Scopes getDefaultScope()
           
static Scopes valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Scopes[] 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

GLOBAL

public static final Scopes GLOBAL
Components bounded to this scope can only be created by a DefaultCacheManager and exist in the DefaultCacheManager's ComponentRegistry.


NAMED_CACHE

public static final Scopes NAMED_CACHE
Components bounded to this scope can only be created by a Cache and exist in the Cache's ComponentRegistry.

Method Detail

values

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

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

valueOf

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

getDefaultScope

public static Scopes getDefaultScope()


Copyright © 2011 JBoss, a division of Red Hat. All Rights Reserved.