|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cache
Method Summary | |
---|---|
boolean |
contains(String key)
check if there is a entry inside the cache that match the given key |
List<CacheEntry> |
entries()
Returns a List of entries containing in this cache Each element in the returned list is a CacheEntry. |
List<CacheEntry> |
entries(CacheEntryFilter filter)
Returns a list of entries containing in this cache that match the given filter. |
List<CacheEntry> |
entries(CacheKeyFilter filter)
Returns a list of entries containing in this cache that match the given filter. |
CacheEntry |
getCacheEntry(String key)
return cache entry that match the key, throws a CacheException when entry does not exist or is stale |
CacheEntry |
getCacheEntry(String key,
CacheEntry defaultValue)
return cache entry that match the key or the defaultValue when entry does not exist |
Struct |
getCustomInfo()
get all information data available for this cache |
Object |
getValue(String key)
return value that match the key, throws a CacheException when entry does not exist or is stale |
Object |
getValue(String key,
Object defaultValue)
return value that match the key or the defaultValue when entry does not exist |
long |
hitCount()
how many time was the cache accessed? this information is optional and depends on the implementation, when information is not available -1 is returned |
void |
init(Config config,
String cacheName,
Struct arguments)
initialize the cache |
List<String> |
keys()
Returns a List of the keys contained in this cache. |
List<CacheEntry> |
keys(CacheEntryFilter filter)
Returns a List of the keys contained in this cache that match the given filter. |
List<String> |
keys(CacheKeyFilter filter)
Returns a List of the keys contained in this cache that match the given filter. |
long |
missCount()
how many time was the cache accessed for a record that does not exist? this information is optional and depends on the implementation, when information is not available -1 is returned |
void |
put(String key,
Object value,
Long idleTime,
Long until)
puts a cache entry to the cache, overwrite existing entries that already exists inside the cache with the same key |
int |
remove(CacheEntryFilter filter)
remove all entries that match the given filter |
int |
remove(CacheKeyFilter filter)
remove all entries that match the given filter |
boolean |
remove(String key)
remove entry that match this key |
List<Object> |
values()
Returns a List of values containing in this cache. |
List<Object> |
values(CacheEntryFilter filter)
Returns a list of values containing in this cache that match the given filter. |
List<Object> |
values(CacheKeyFilter filter)
Returns a list of values containing in this cache that match the given filter. |
Method Detail |
---|
void init(Config config, String cacheName, Struct arguments) throws IOException
arguments
- configuration arguments
CacheException
IOException
CacheEntry getCacheEntry(String key) throws IOException
key
- key of the cache entry to get
CacheException
IOException
Object getValue(String key) throws IOException
key
- key of the value to get
CacheException
IOException
CacheEntry getCacheEntry(String key, CacheEntry defaultValue)
key
- key of the cache entry to get
Object getValue(String key, Object defaultValue)
key
- key of the value to get
void put(String key, Object value, Long idleTime, Long until)
value
- boolean contains(String key)
key
-
boolean remove(String key) throws IOException
key
-
IOException
int remove(CacheKeyFilter filter) throws IOException
filter
-
IOException
int remove(CacheEntryFilter filter) throws IOException
filter
-
IOException
List<String> keys() throws IOException
IOException
List<String> keys(CacheKeyFilter filter) throws IOException
filter
-
IOException
List<CacheEntry> keys(CacheEntryFilter filter) throws IOException
filter
-
IOException
List<Object> values() throws IOException
IOException
List<Object> values(CacheKeyFilter filter) throws IOException
IOException
List<Object> values(CacheEntryFilter filter) throws IOException
IOException
List<CacheEntry> entries() throws IOException
IOException
List<CacheEntry> entries(CacheKeyFilter filter) throws IOException
IOException
List<CacheEntry> entries(CacheEntryFilter filter) throws IOException
IOException
long hitCount()
long missCount()
Struct getCustomInfo()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |