org.castor.cache.distributed

Class JCache

java.lang.Object

org.castor.cache.AbstractBaseCache

org.castor.cache.distributed.AbstractDistributedCache

org.castor.cache.distributed.JCache

All Implemented Interfaces:

java.util.Map, Cache

public final class JCache
extends AbstractDistributedCache

JCACHE implementation of Castor JDO Cache. JCACHE is the Java Temporary Caching API (JSR-107). For more details of JCACHE, see http://www.jcp.org/en/jsr/detail?id=107

Since:

1.0

Version:

$Revision: 6230 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Tim Telcik, Werner Guttmann, Ralf Joachim

See Also:

JSR-107

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IMPLEMENTATION The classname of the implementations factory class.
static java.lang.String	TYPE The type of the cache.

Fields inherited from interface org.castor.cache.Cache

DEFAULT_DEBUG, DEFAULT_NAME, DEFAULT_TYPE, PARAM_DEBUG, PARAM_NAME, PARAM_TYPE

Constructor Summary

Constructors

Constructor and Description
JCache()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getType() Indicates the type of this cache.
void	initialize(java.util.Properties params) Lyfe-cycle method to allow custom initialization of cache implementations.
void	initialize(java.lang.String implementation, java.util.Properties params) Normally called to initialize JCache.

Methods inherited from class org.castor.cache.distributed.AbstractDistributedCache

clear, containsKey, containsValue, entrySet, get, getCache, isEmpty, keySet, put, putAll, remove, setCache, size, values

Methods inherited from class org.castor.cache.AbstractBaseCache

close, expire, expireAll, getName, invokeMethod, invokeStaticMethod

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

TYPE

public static final java.lang.String TYPE

The type of the cache.

See Also:

Constant Field Values

IMPLEMENTATION

public static final java.lang.String IMPLEMENTATION

The classname of the implementations factory class.

See Also:

Constant Field Values

Constructor Detail

JCache

public JCache()

Method Detail

initialize

public void initialize(java.util.Properties params)
                throws CacheAcquireException

Lyfe-cycle method to allow custom initialization of cache implementations.

Specified by:

initialize in interface Cache

Overrides:

initialize in class AbstractBaseCache

Parameters:

params - Parameters to initialize the cache (e.g. name, capacity).

Throws:

CacheAcquireException - If cache can not be initialized.

See Also:

Cache.initialize(java.util.Properties)

initialize

public void initialize(java.lang.String implementation,
              java.util.Properties params)
                throws CacheAcquireException

Normally called to initialize JCache. To be able to test the method without having javax.util.jcs.CacheAccessFactory implementation, it can also be called with a test implementations classname.

Parameters:

implementation - Cache implementation classname to initialize.

params - Parameters to initialize the cache (e.g. name, capacity).

Throws:

CacheAcquireException - If cache can not be initialized.

getType

public java.lang.String getType()

Indicates the type of this cache.

Returns:

The cache type.

See Also:

Cache.getType()