JcsCache (Castor JavaDoc)

java.lang.Object
- org.castor.cache.AbstractBaseCache
- - org.castor.cache.distributed.JcsCache

All Implemented Interfaces:

java.util.Map<java.lang.Object,java.lang.Object>, Cache
```
public final class JcsCache
extends AbstractBaseCache
```
JCS (Java Caching System) implementation of Castor JDO Cache. For more details of JCS, see http://jakarta.apache.org/jcs

Since:

1.0

Version:

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

Author:

Tim Telcik, Werner Guttmann, Ralf Joachim

See Also:

The JCS Home Page

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field 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

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

Constructor Summary

Constructors
Constructor Description

JcsCache()

Constructors
Constructor	Description
`JcsCache()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>>`	`entrySet()`
`java.lang.Object`	`get(java.lang.Object key)`
`java.lang.String`	`getType()`	Indicates the type of this cache.
`void`	`initialize(java.lang.String implementation, java.util.Properties params)`	Normally called to initialize JcsCache.
`void`	`initialize(java.util.Properties params)`	Lyfe-cycle method to allow custom initialization of cache implementations.
`boolean`	`isEmpty()`
`java.util.Set<java.lang.Object>`	`keySet()`
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)`
`void`	`putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)`
`java.lang.Object`	`remove(java.lang.Object key)`
`int`	`size()`
`java.util.Collection<java.lang.Object>`	`values()`

Methods inherited from class org.castor.cache.AbstractBaseCache
close, expire, expireAll, getName, invokeMethod, invokeStaticMethod

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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
- JcsCache
```
public JcsCache()
```

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.

initialize
```
public void initialize(java.lang.String implementation,
                       java.util.Properties params)
                throws CacheAcquireException
```
Normally called to initialize JcsCache. To be able to test the method without having org.apache.jcs.JCS 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.

size
```
public int size()
```

isEmpty
```
public boolean isEmpty()
```

containsKey

public boolean containsKey(java.lang.Object key)

containsValue

public boolean containsValue(java.lang.Object value)

get

public java.lang.Object get(java.lang.Object key)

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

remove

public java.lang.Object remove(java.lang.Object key)

putAll

public void putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)

clear
```
public void clear()
```

keySet

public java.util.Set<java.lang.Object> keySet()

values

public java.util.Collection<java.lang.Object> values()

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>> entrySet()

Class JcsCache

Nested Class Summary

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

Field Summary

Fields inherited from interface org.castor.cache.Cache

Constructor Summary

Method Summary

Methods inherited from class org.castor.cache.AbstractBaseCache

Methods inherited from interface java.util.Map

Methods inherited from class java.lang.Object

Field Detail

TYPE

IMPLEMENTATION

Constructor Detail

JcsCache

Method Detail

initialize

initialize

getType

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet