Package org.cache2k.core

Class BaseCache<K,V>

java.lang.Object

org.cache2k.core.BaseCache<K,V>

All Implemented Interfaces:

AutoCloseable, org.cache2k.Cache<K,V>, InternalCache<K,V>, InternalCacheCloseContext, TimerEventListener<K,V>, org.cache2k.DataAware<K,V>, org.cache2k.KeyValueSource<K,V>

Direct Known Subclasses:

HeapCache, WiredCache

public abstract class BaseCache<K,V>
extends Object
implements InternalCache<K,V>

Some default implementations for a cache.

Author:

Jens Wilke

Constructor Summary

Constructors

Constructor	Description
BaseCache()

Method Summary

Modifier and Type	Method	Description
ConcurrentMap<K,V>	asMap()
void	closeCustomization(Object customization, String customizationName)	Call close on the customization if the AutoCloseable interface is implemented
protected abstract <R> EntryAction<K,V,R>	createEntryAction(K key, Entry<K,V> e, Semantic<K,V,R> op)
protected abstract <R> EntryAction<K,V,R>	createFireAndForgetAction(Entry<K,V> e, Semantic<K,V,R> op)
Set<org.cache2k.CacheEntry<K,V>>	entries()
protected <R> R	execute(K key, Entry<K,V> e, Semantic<K,V,R> op)
protected <R> R	execute(K key, Semantic<K,V,R> op)
void	expireAt(K key, long time)
abstract Executor	getExecutor()
String	getQualifiedName()	Returns name of the cache with manager name.
<R> R	invoke(K key, org.cache2k.processor.EntryProcessor<K,V,R> processor)	Simply the EntryAction based code to provide the entry processor.
<R> Map<K,org.cache2k.processor.EntryProcessingResult<R>>	invokeAll(Iterable<? extends K> keys, org.cache2k.processor.EntryProcessor<K,V,R> entryProcessor)
protected abstract Iterator<org.cache2k.CacheEntry<K,V>>	iterator()
Set<K>	keys()	Key iteration on top of normal iterator.
void	removeAll()
void	removeAll(Iterable<? extends K> keys)
<X> X	requestInterface(Class<X> type)
String	toString()	Return status information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cache2k.Cache

clear, close, computeIfAbsent, containsAndRemove, containsKey, get, getAll, getCacheManager, getEntry, getName, isClosed, loadAll, mutate, mutateAll, peek, peekAll, peekAndPut, peekAndRemove, peekAndReplace, peekEntry, put, putAll, putIfAbsent, reloadAll, remove, removeIfEquals, replace, replaceIfEquals

Methods inherited from interface org.cache2k.core.api.InternalCache

cancelTimerJobs, checkIntegrity, getClock, getCommonMetrics, getConsistentInfo, getEntryState, getEviction, getInfo, getKeyType, getLog, getTimeReference, getTiming, getTotalEntryCount, getUserCache, getValueType, isDisabled, isLoaderPresent, isNullValuePermitted, isWeigherPresent, logAndCountInternalException, returnCacheEntry, setDisabled

Methods inherited from interface org.cache2k.core.api.InternalCacheCloseContext

getCacheManager, getName

Methods inherited from interface org.cache2k.core.timing.TimerEventListener

getName, timerEventExpireEntry, timerEventProbationTerminated, timerEventRefresh

Constructor Detail

BaseCache

public BaseCache()

Method Detail

getExecutor

public abstract Executor getExecutor()

createFireAndForgetAction

protected abstract <R> EntryAction<K,V,R> createFireAndForgetAction(Entry<K,V> e,
                                                                                Semantic<K,V,R> op)

getQualifiedName

public String getQualifiedName()

Returns name of the cache with manager name.

Specified by:

getQualifiedName in interface InternalCache<K,V>

See Also:

similar

iterator

protected abstract Iterator<org.cache2k.CacheEntry<K,V>> iterator()

keys

public Set<K> keys()

Key iteration on top of normal iterator.

Specified by:

keys in interface org.cache2k.Cache<K,V>

entries

public Set<org.cache2k.CacheEntry<K,V>> entries()

Specified by:

entries in interface org.cache2k.Cache<K,V>

removeAll

public void removeAll()

Specified by:

removeAll in interface org.cache2k.Cache<K,V>

removeAll

public void removeAll(Iterable<? extends K> keys)

Specified by:

removeAll in interface org.cache2k.Cache<K,V>

requestInterface

public <X> X requestInterface(Class<X> type)

Specified by:

requestInterface in interface org.cache2k.Cache<K,V>

asMap

public ConcurrentMap<K,V> asMap()

Specified by:

asMap in interface org.cache2k.Cache<K,V>

invoke

public <R> R invoke(K key,
                    org.cache2k.processor.EntryProcessor<K,V,R> processor)

Simply the EntryAction based code to provide the entry processor. If we code it directly this might be a little bit more efficient, but it gives quite a code bloat which has lots of corner cases for loader and exception handling.

Specified by:

invoke in interface org.cache2k.Cache<K,V>

invokeAll

public <R> Map<K,org.cache2k.processor.EntryProcessingResult<R>> invokeAll(Iterable<? extends K> keys,
                                                                                 org.cache2k.processor.EntryProcessor<K,V,R> entryProcessor)

Specified by:

invokeAll in interface org.cache2k.Cache<K,V>

expireAt

public void expireAt(K key,
                     long time)

Specified by:

expireAt in interface org.cache2k.Cache<K,V>

execute

protected <R> R execute(K key,
                        Semantic<K,V,R> op)

execute

protected <R> R execute(K key,
                        Entry<K,V> e,
                        Semantic<K,V,R> op)

createEntryAction

protected abstract <R> EntryAction<K,V,R> createEntryAction(K key,
                                                                        Entry<K,V> e,
                                                                        Semantic<K,V,R> op)

closeCustomization

public void closeCustomization(Object customization,
                               String customizationName)

Description copied from interface: InternalCacheCloseContext

Call close on the customization if the AutoCloseable interface is implemented

Specified by:

closeCustomization in interface InternalCacheCloseContext

customizationName - Name of customization like "expiryPolicy". This is used when an exception happens upon close.

toString

public String toString()

Return status information. The status collection is time-consuming, so this is an expensive operation.

Specified by:

toString in interface org.cache2k.Cache<K,V>

Overrides:

toString in class Object