redis.clients.jedis.csc

Interface Cache

All Known Implementing Classes:

AbstractCache, DefaultCache

public interface Cache

The cache that is used by a connection

Method Summary

Modifier and Type	Method and Description
boolean	compatibilityMode()
boolean	delete(CacheKey cacheKey) Delete an entry by cache key
java.util.List<java.lang.Boolean>	delete(java.util.List<CacheKey> cacheKeys) Delete entries by cache key from the cache
java.util.List<CacheKey>	deleteByRedisKey(java.lang.Object key) Delete an entry by the Redis key from the cache
java.util.List<CacheKey>	deleteByRedisKeys(java.util.List keys) Delete entries by the Redis key from the cache
int	flush() Flushes the entire cache
CacheEntry	get(CacheKey cacheKey) Fetches a value from the cache
CacheStats	getAndResetStats()
java.util.Collection<CacheEntry>	getCacheEntries()
EvictionPolicy	getEvictionPolicy()
int	getMaxSize()
int	getSize()
CacheStats	getStats()
boolean	hasCacheKey(CacheKey cacheKey)
boolean	isCacheable(CacheKey cacheKey)
CacheEntry	set(CacheKey cacheKey, CacheEntry value) Puts a value into the cache

Method Detail

getMaxSize

int getMaxSize()

Returns:

The size of the cache

getSize

int getSize()

Returns:

The current size of the cache

getCacheEntries

java.util.Collection<CacheEntry> getCacheEntries()

Returns:

All the entries within the cache

get

CacheEntry get(CacheKey cacheKey)

Fetches a value from the cache

Parameters:

cacheKey - The key within the cache

Returns:

The entry within the cache

set

CacheEntry set(CacheKey cacheKey,
               CacheEntry value)

Puts a value into the cache

Parameters:

cacheKey - The key by which the value can be accessed within the cache

value - The value to be put into the cache

Returns:

The cache entry

delete

boolean delete(CacheKey cacheKey)

Delete an entry by cache key

Parameters:

cacheKey - The cache key of the entry in the cache

Returns:

True if the entry could be deleted, false if the entry wasn't found.

delete

java.util.List<java.lang.Boolean> delete(java.util.List<CacheKey> cacheKeys)

Delete entries by cache key from the cache

Parameters:

cacheKeys - The cache keys of the entries that should be deleted

Returns:

True for every entry that could be deleted. False if the entry was not there.

deleteByRedisKey

java.util.List<CacheKey> deleteByRedisKey(java.lang.Object key)

Delete an entry by the Redis key from the cache

Parameters:

key - The Redis key as binary

Returns:

True if the entry could be deleted. False if the entry was not there.

deleteByRedisKeys

java.util.List<CacheKey> deleteByRedisKeys(java.util.List keys)

Delete entries by the Redis key from the cache

Parameters:

keys - The Redis keys as binaries

Returns:

True for every entry that could be deleted. False if the entry was not there.

flush

int flush()

Flushes the entire cache

Returns:

Return the number of entries that were flushed

isCacheable

boolean isCacheable(CacheKey cacheKey)

Parameters:

cacheKey - The key of the cache entry

Returns:

True if the entry is cachable, false otherwise

hasCacheKey

boolean hasCacheKey(CacheKey cacheKey)

Parameters:

cacheKey - The key of the cache entry

Returns:

True if the cache already contains the key

getEvictionPolicy

EvictionPolicy getEvictionPolicy()

Returns:

The eviction policy that is used by the cache

getStats

CacheStats getStats()

Returns:

The statistics of the cache

getAndResetStats

CacheStats getAndResetStats()

Returns:

The statistics of the cache

compatibilityMode

boolean compatibilityMode()

Returns:

The compatibility of cache against different Redis versions