redis.clients.jedis.csc

Interface EvictionPolicy

All Known Implementing Classes:

LRUEviction

public interface EvictionPolicy

Describes the properties and functionality of an eviction policy

One policy instance belongs to exactly one cache instance

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EvictionPolicy.EvictionType Types of eviction policies AGE - based on the time of access, e.g., LRU FREQ - based on the frequency of access, e.g., LFU HYBR - AGE + FREQ, e.g., CLOCK MISC - Anythin that isn't time based, frequency based or a combination of the two, e.g., FIFO

Method Summary

Modifier and Type	Method and Description
java.util.List<CacheKey>	evictMany(int n)
CacheKey	evictNext() Evict the next element from the cache This one should provide O(1) complexity
Cache	getCache()
java.lang.String	getName()
EvictionPolicy.EvictionType	getType()
boolean	reset(CacheKey cacheKey) Resets the state that the eviction policy maintains about the cache key
int	resetAll() Resets the entire state of the eviction data
void	setCache(Cache cache) Sets the cache that is associated to this policy instance
void	touch(CacheKey cacheKey) Indicates that a cache key was touched This one should provide O(1) complexity

Method Detail

getCache

Cache getCache()

Returns:

The cache that is associated to this policy instance

setCache

void setCache(Cache cache)

Sets the cache that is associated to this policy instance

Parameters:

cache - The cache instance

getType

EvictionPolicy.EvictionType getType()

Returns:

The type of policy

getName

java.lang.String getName()

Returns:

The name of the policy

evictNext

CacheKey evictNext()

Evict the next element from the cache This one should provide O(1) complexity

Returns:

The key of the entry that was evicted

evictMany

java.util.List<CacheKey> evictMany(int n)

Parameters:

n - The number of entries to evict

Returns:

The list of keys of evicted entries

touch

void touch(CacheKey cacheKey)

Indicates that a cache key was touched This one should provide O(1) complexity

Parameters:

cacheKey - The key within the cache

reset

boolean reset(CacheKey cacheKey)

Resets the state that the eviction policy maintains about the cache key

Parameters:

cacheKey -

resetAll

int resetAll()

Resets the entire state of the eviction data

Returns:

True if the reset could be performed successfully