net.sf.kdgcommons.util

Enum ReadThroughCache.Synchronization

java.lang.Object

java.lang.Enum<ReadThroughCache.Synchronization>

net.sf.kdgcommons.util.ReadThroughCache.Synchronization

All Implemented Interfaces:

Serializable, Comparable<ReadThroughCache.Synchronization>

Enclosing class:

ReadThroughCache<K,V>

public static enum ReadThroughCache.Synchronization
extends Enum<ReadThroughCache.Synchronization>

Options for controlling concurrent retrieval.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BY_KEY Per-key synchronization: each retrieval request establishes a lock that is cleared when the retrieval completes.
NONE No synchronization: concurrent requests for the same key will invoke concurrent retrievals.
SINGLE_THREADED Single-threaded: only one invocation of the retriever will take place at a time; all subsequent requests will block until it completes.

Method Summary

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

NONE

public static final ReadThroughCache.Synchronization NONE

No synchronization: concurrent requests for the same key will invoke concurrent retrievals. The first value returned is cached, subsequent values are discarded.

BY_KEY

public static final ReadThroughCache.Synchronization BY_KEY

Per-key synchronization: each retrieval request establishes a lock that is cleared when the retrieval completes. Subsequent retrieves for the same key will block until the first returns. This is the default behavior.

SINGLE_THREADED

public static final ReadThroughCache.Synchronization SINGLE_THREADED

Single-threaded: only one invocation of the retriever will take place at a time; all subsequent requests will block until it completes. This should only be used if the retriever is not thread-safe.

Method Detail

values

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

Returns:

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

valueOf

public static ReadThroughCache.Synchronization 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