Package org.cyclos.impl.utils.cache

Class AbstractCache<K extends Serializable,V extends Serializable>

java.lang.Object

org.cyclos.impl.utils.cache.AbstractCache<K,V>

All Implemented Interfaces:

Cache<K,V>

Direct Known Subclasses:

GuavaCache

public abstract class AbstractCache<K extends Serializable,V extends Serializable>
extends Object
implements Cache<K,V>

Base implementation for Cache

Field Summary

Fields

Modifier and Type	Field	Description
protected CacheHandlerImplementor	cacheHandler
protected static org.apache.logging.log4j.Logger	LOG
protected ConcurrentHashMap<K,org.cyclos.impl.utils.cache.AbstractCache.ProducerWrapper<K,V>>	pendingProducers
protected CacheType<K,V>	type

Constructor Summary

Constructors

Constructor	Description
AbstractCache(CacheHandlerImplementor cacheHandler, CacheType<K,V> type)

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all entries in this cache
protected abstract boolean	contains(K key)	Returns whether the cache contains the given key
void	destroy()	Destroys this cache instance
protected abstract void	doClear()
protected abstract void	doEvict(Collection<K> keys)
protected abstract V	doGet(K key, Callable<V> producer)	Must be implemented to actually return the cached value, or produce a new one if not present
void	evict(Collection<K> keys)	Evicts the given keys, if present
void	evict(Predicate<K> predicate)	Evicts the keys matching the given predicate
V	get(K key, Callable<V> producer)	Returns the value currently associated with the given key, or gets one from the given producer if none
protected abstract Collection<K>	getKeys(Predicate<K> predicate)
CacheType<K,V>	getType()	Returns this cache type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.apache.logging.log4j.Logger LOG

type

protected final CacheType<K extends Serializable,V extends Serializable> type

cacheHandler

protected final CacheHandlerImplementor cacheHandler

pendingProducers

protected ConcurrentHashMap<K extends Serializable,org.cyclos.impl.utils.cache.AbstractCache.ProducerWrapper<K extends Serializable,V extends Serializable>> pendingProducers

Constructor Detail

AbstractCache

public AbstractCache(CacheHandlerImplementor cacheHandler,
                     CacheType<K,V> type)

Method Detail

clear

public final void clear()

Description copied from interface: Cache

Removes all entries in this cache

Specified by:

clear in interface Cache<K extends Serializable,V extends Serializable>

destroy

public void destroy()

Description copied from interface: Cache

Destroys this cache instance

Specified by:

destroy in interface Cache<K extends Serializable,V extends Serializable>

evict

public final void evict(Collection<K> keys)

Description copied from interface: Cache

Evicts the given keys, if present

Specified by:

evict in interface Cache<K extends Serializable,V extends Serializable>

evict

public void evict(Predicate<K> predicate)

Description copied from interface: Cache

Evicts the keys matching the given predicate

Specified by:

evict in interface Cache<K extends Serializable,V extends Serializable>

get

public final V get(K key,
                   Callable<V> producer)

Description copied from interface: Cache

Returns the value currently associated with the given key, or gets one from the given producer if none

Specified by:

get in interface Cache<K extends Serializable,V extends Serializable>

getType

public final CacheType<K,V> getType()

Description copied from interface: Cache

Returns this cache type

Specified by:

getType in interface Cache<K extends Serializable,V extends Serializable>

contains

protected abstract boolean contains(K key)

Returns whether the cache contains the given key

doClear

protected abstract void doClear()

doEvict

protected abstract void doEvict(Collection<K> keys)

doGet

protected abstract V doGet(K key,
                           Callable<V> producer)

Must be implemented to actually return the cached value, or produce a new one if not present

getKeys

protected abstract Collection<K> getKeys(Predicate<K> predicate)