|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICache
This is the top level interface for all cache like structures. It defines the methods used internally by JCS to access, modify, and instrument such structures.
This allows for a suite of reusable components for accessing such structures, for example asynchronous access via an event queue.
Field Summary |
---|
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType |
---|
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE |
Method Summary | |
---|---|
void |
dispose()
Prepares for shutdown. |
ICacheElement |
get(java.io.Serializable key)
Gets an item from the cache. |
java.lang.String |
getCacheName()
Returns the cache name. |
java.util.Map |
getMatching(java.lang.String pattern)
Gets items from the cache matching the given pattern. |
java.util.Map |
getMultiple(java.util.Set keys)
Gets multiple items from the cache based on the given set of keys. |
int |
getSize()
Returns the current cache size in number of elements. |
java.lang.String |
getStats()
Returns the cache stats. |
int |
getStatus()
Returns the cache status. |
boolean |
remove(java.io.Serializable key)
Removes an item from the cache. |
void |
removeAll()
Removes all cached items from the cache. |
void |
setKeyMatcher(IKeyMatcher keyMatcher)
Sets the key matcher used by get matching. |
void |
update(ICacheElement element)
Puts an item to the cache. |
Methods inherited from interface org.apache.jcs.engine.behavior.ICacheType |
---|
getCacheType |
Method Detail |
---|
void update(ICacheElement element) throws java.io.IOException
element
-
java.io.IOException
ICacheElement get(java.io.Serializable key) throws java.io.IOException
key
-
java.io.IOException
java.util.Map getMultiple(java.util.Set keys) throws java.io.IOException
keys
-
java.io.IOException
java.util.Map getMatching(java.lang.String pattern) throws java.io.IOException
This only works with string keys. It's too expensive to do a toString on every key.
Auxiliaries will do their best to handle simple expressions. For instance, the JDBC disk cache will convert * to % and . to _
pattern
-
java.io.IOException
boolean remove(java.io.Serializable key) throws java.io.IOException
key
-
java.io.IOException
void removeAll() throws java.io.IOException
java.io.IOException
void dispose() throws java.io.IOException
java.io.IOException
int getSize()
int getStatus()
java.lang.String getStats()
java.lang.String getCacheName()
void setKeyMatcher(IKeyMatcher keyMatcher)
keyMatcher
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |