|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Cache
Cache Generic cache interface
| Method Summary | |
|---|---|
void |
add(Object key,
Object value)
add the given value to the cache at the specified key |
void |
add(Object key,
Object value,
int size)
add the given value with specified size to the cache at specified key |
void |
addCacheListener(CacheListener listener)
add the cache module listener |
int |
clear()
clear all the entries from the cache. |
void |
clearStats()
clear all stats |
boolean |
contains(Object key)
check if the cache contains the item at the key |
void |
destroy()
Destroys this cache. |
Enumeration |
elements()
get an Enumeration for the keys stored in the cache |
Object |
get(Object key)
get the item stored at the key. |
Iterator |
getAll(Object key)
get all the items with the given key. |
int |
getEntryCount()
get the number of entries in the cache |
int |
getIndex(Object key)
get the index of the item given a key |
Object |
getStatByName(String key)
get the desired statistic counter |
Map |
getStats()
get the stats snapshot |
void |
init(int maxEntries,
float loadFactor,
Properties props)
initialize the cache |
void |
init(int maxEntries,
Properties props)
initialize the cache with the default load factor (0.75) |
boolean |
isEmpty()
is this cache empty? |
Iterator |
keys()
get an Iterator for the keys stored in the cache |
void |
notifyRefresh(int index)
notify threads waiting for a refresh on the object associated with the key |
Object |
put(Object key,
Object value)
cache the given value at the specified key and return previous value |
Object |
put(Object key,
Object value,
int size)
cache the given value at the specified key and return previous value |
Object |
remove(Object key)
remove the item with the given key. |
Object |
remove(Object key,
Object value)
remove the given value stored at the key. |
void |
removeAll(Object key)
remove all the item with the given key. |
void |
trimExpiredEntries(int maxCount)
trim the expired entries from the cache. |
Iterator |
values()
get an Iterator for the values stored in the cache |
boolean |
waitRefresh(int index)
wait for a refresh on the object associated with the key |
| Method Detail |
|---|
void init(int maxEntries,
float loadFactor,
Properties props)
throws Exception
maxEntries - maximum number of entries expected in the cacheloadFactor - the load factorprops - opaque list of properties for a given cache implementation
a - generic Exception if the initialization failed
Exception
void init(int maxEntries,
Properties props)
throws Exception
maxEntries - maximum number of entries expected in the cacheprops - opaque list of properties for a given cache implementation
a - generic Exception if the initialization failed
Exceptionvoid addCacheListener(CacheListener listener)
listener - CacheListener implementationint getIndex(Object key)
key - of the entry
Object get(Object key)
key - lookup keyIterator getAll(Object key)
key - lookup keyboolean contains(Object key)
key - lookup keyIterator keys()
Enumeration elements()
Iterator values()
Object put(Object key,
Object value)
key - lookup keyobject - item value to be stored
Object put(Object key,
Object value,
int size)
key - lookup keyobject - item value to be storedsize - in bytes of the value being cached
void add(Object key,
Object value)
key - lookup keyobject - item value to be stored
This function is suitable for multi-valued keys.
void add(Object key,
Object value,
int size)
key - lookup keyobject - item value to be storedsize - in bytes of the value being added
This function is suitable for multi-valued keys.Object remove(Object key)
key - lookup key
Object remove(Object key,
Object value)
key - lookup keyvalue - to match (for multi-valued keys)void removeAll(Object key)
key - lookup keyboolean waitRefresh(int index)
index - index of the entry. The index must be obtained via
one of the getIndex() methods.void notifyRefresh(int index)
index - index of the entry. The index must be obtained via
one of the getIndex() methods.int clear()
boolean isEmpty()
int getEntryCount()
Object getStatByName(String key)
key - to corresponding stat
Map getStats()
void clearStats()
void trimExpiredEntries(int maxCount)
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.void destroy()
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.