Package org.dspace.services.model

Enum CacheConfig.CacheScope

java.lang.Object

java.lang.Enum<CacheConfig.CacheScope>

org.dspace.services.model.CacheConfig.CacheScope

All Implemented Interfaces:

Serializable, Comparable<CacheConfig.CacheScope>

Enclosing class:

CacheConfig

public static enum CacheConfig.CacheScope
extends Enum<CacheConfig.CacheScope>

Controls the scope of each created cache.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLUSTERINVALIDATED	This cache is destroyed when the entire cluster goes down.
CLUSTERREPLICATED	This cache is destroyed when the entire cluster goes down.
INSTANCE	This cache is destroyed when the current JVM shuts down.
REQUEST	This cache is destroyed at the end of the current request for the current thread it was created in.

Method Summary

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

This cache is destroyed at the end of the current request for the current thread it was created in.

INSTANCE

public static final CacheConfig.CacheScope INSTANCE

This cache is destroyed when the current JVM shuts down.

CLUSTERINVALIDATED

public static final CacheConfig.CacheScope CLUSTERINVALIDATED

This cache is destroyed when the entire cluster goes down. The cache will invalidate the same entries in other caches when it changes.

CLUSTERREPLICATED

public static final CacheConfig.CacheScope CLUSTERREPLICATED

This cache is destroyed when the entire cluster goes down. The cache will copy an entry over to other caches when it changes or is created.

Method Detail

values

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

Returns:

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

valueOf

public static CacheConfig.CacheScope 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