File	Doc	Category	Size	Date	Package
Cache.java	API Doc	Glassfish v2 API	8706	Fri May 04 22:35:28 BST 2007	com.sun.appserv.util.cache

Cache

Fields Summary

Constructors Summary

Methods Summary
public void	add(java.lang.Object key, java.lang.Object value) add the given value to the cache at the specified key param key lookup key param object item value to be stored This function is suitable for multi-valued keys.
public void	add(java.lang.Object key, java.lang.Object value, int size) add the given value with specified size to the cache at specified key param key lookup key param object item value to be stored param size in bytes of the value being added This function is suitable for multi-valued keys.
public void	addCacheListener(CacheListener listener) add the cache module listener param listener CacheListener implementation
public int	clear() clear all the entries from the cache. returns the number of entries cleared from the cache
public void	clearStats() clear all stats
public boolean	contains(java.lang.Object key) check if the cache contains the item at the key param key lookup key returns true if there is an item stored at the key; false if not.
public void	destroy() Destroys this cache. This method should perform final clean ups.
public java.util.Enumeration	elements() get an Enumeration for the keys stored in the cache returns an Enumeration XXX: should use Iterator which is based on Collections
public java.lang.Object	get(java.lang.Object key) get the item stored at the key. param key lookup key returns the item stored at the key; null if not found. This function returns first value, for a multi-valued key.
public java.util.Iterator	getAll(java.lang.Object key) get all the items with the given key. param key lookup key returns an Iterator over the items with the given key
public int	getEntryCount() get the number of entries in the cache return the number of entries the cache currently holds
public int	getIndex(java.lang.Object key) get the index of the item given a key param key of the entry return the index to be used in the cache
public java.lang.Object	getStatByName(java.lang.String key) get the desired statistic counter param key to corresponding stat return an Object corresponding to the stat See also: Constant.java for the key
public java.util.Map	getStats() get the stats snapshot return a Map of stats See also: Constant.java for the keys
public void	init(int maxEntries, float loadFactor, java.util.Properties props) initialize the cache param maxEntries maximum number of entries expected in the cache param loadFactor the load factor param props opaque list of properties for a given cache implementation throws a generic Exception if the initialization failed
public void	init(int maxEntries, java.util.Properties props) initialize the cache with the default load factor (0.75) param maxEntries maximum number of entries expected in the cache param props opaque list of properties for a given cache implementation throws a generic Exception if the initialization failed
public boolean	isEmpty() is this cache empty? returns true if the cache is empty; false otherwise.
public java.util.Iterator	keys() get an Iterator for the keys stored in the cache returns an Iterator
public void	notifyRefresh(int index) notify threads waiting for a refresh on the object associated with the key param index index of the entry. The index must be obtained via one of the getIndex() methods.
public java.lang.Object	put(java.lang.Object key, java.lang.Object value) cache the given value at the specified key and return previous value param key lookup key param object item value to be stored returns the previous item stored at the key; null if not found. This function replaces first value, for a multi-valued key.
public java.lang.Object	put(java.lang.Object key, java.lang.Object value, int size) cache the given value at the specified key and return previous value param key lookup key param object item value to be stored param size in bytes of the value being cached returns the previous item stored at the key; null if not found. This function replaces first value, for a multi-valued key.
public java.lang.Object	remove(java.lang.Object key) remove the item with the given key. param key lookup key returns the item stored at the key; null if not found. This function removes first value, for a multi-valued key.
public java.lang.Object	remove(java.lang.Object key, java.lang.Object value) remove the given value stored at the key. param key lookup key param value to match (for multi-valued keys) returns the item stored at the key; null if not found.
public void	removeAll(java.lang.Object key) remove all the item with the given key. param key lookup key
public void	trimExpiredEntries(int maxCount) trim the expired entries from the cache. param maxCount maximum number of invalid entries to trim specify Integer.MAX_VALUE to trim all timedout entries This call is to be scheduled by a thread managed by the container.
public java.util.Iterator	values() get an Iterator for the values stored in the cache returns an Iterator
public boolean	waitRefresh(int index) wait for a refresh on the object associated with the key param index index of the entry. The index must be obtained via one of the getIndex() methods. returns true on successful notification, or false if there is no thread refreshing this entry.