org.castor.persist.cache.distributed

Class JCache

public class JCache extends AbstractBaseCache

JCACHE implementation of Castor JDO Cache. JCACHE is the Java Temporary Caching API (JSR-107). NOTE: While this cache implementation should work any JCACHE-compliant provider, it is currently intended to work with the FKache open source reference implementation. For more details of JCACHE, see http://www.jcp.org/en/jsr/detail?id=107 For more details of FKache, see http://jcache.sourceforge.net

Version: $Revision: 1.1 $ $Date: 2005/08/04 07:31:15 $

Author: Tim Telcik

See Also: http://jcache.sourceforge.net http://www.jcp.org/en/jsr/detail?id=107

Constructor Summary
	JCache() Default constructor.

Method Summary
void	clear()
void	close()
boolean	contains(Object key) Indicates whether the cache holds a value object for the specified key.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Enumeration	elements() Returns an enumeration of the values in this LRU map.
Set	entrySet()
Object	get(Object key) Returns the value to which the specified key is mapped in this Map.
void	initialize() Initializes this cache.
boolean	isEmpty()
Set	keySet()
Object	put(Object key, Object value) Maps the specified `key` to the specified `value` in this Map.
void	putAll(Map aMap)
Object	remove(Object key) Removes the key (and its corresponding value) from this Map.
int	size()
Collection	values()

Constructor Detail

JCache

public JCache()

Default constructor.

Method Detail

clear

public void clear()

See Also: clear

close

public void close()

contains

public boolean contains(Object key)

Indicates whether the cache holds a value object for the specified key.

See Also: Cache

containsKey

public boolean containsKey(Object key)

See Also: Cache

containsValue

public boolean containsValue(Object value)

See Also: Cache

elements

public Enumeration elements()

Returns an enumeration of the values in this LRU map. Use the Enumeration methods on the returned object to fetch the elements sequentially.

Returns: an enumeration of the values in this Map.

See Also: java.util.Enumeration

entrySet

public Set entrySet()

See Also: entrySet

get

public Object get(Object key)

Returns the value to which the specified key is mapped in this Map.

Parameters: key - a key in the Map.

Returns: the value to which the key is mapped in this Map; null if the key is not mapped to any value in this Map.

initialize

public void initialize()

Initializes this cache.

Throws: CacheAcquireException

isEmpty

public boolean isEmpty()

See Also: isEmpty

keySet

public Set keySet()

See Also: keySet

put

public Object put(Object key, Object value)

Maps the specified key to the specified value in this Map. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters: key the Map key. value the value.

Returns: the previous value of the specified key in this Map, or null if it did not have one.

Throws: NullPointerException if the key or value is null.

putAll

public void putAll(Map aMap)

See Also: putAll

remove

public Object remove(Object key)

Removes the key (and its corresponding value) from this Map. This method does nothing if the key is not in the Map.

Parameters: key the key that needs to be removed.

Returns: the value to which the key had been mapped in this Map, or null if the key did not have a mapping.

size

public int size()

See Also: size

values

public Collection values()

See Also: values

Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com