org.cache2k.core

Class BaseCache<K,V>

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, org.cache2k.AdvancedKeyValueSource<K,V>, org.cache2k.Cache<K,V>, CanCheckIntegrity, InternalCache<K,V>, org.cache2k.KeyValueSource<K,V>, org.cache2k.KeyValueStore<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 and Description
BaseCache()

Method Summary

Modifier and Type	Method and Description
ConcurrentMap<K,V>	asMap()
void	clearAndClose()
void	closeCustomization(Object _customization, String _customizationName) Call close on the customization if the Closeable interface is implemented
<T> T	createCustomization(org.cache2k.configuration.CustomizationSupplier<T> f) Calls factory and wraps exceptions.
protected abstract <R> EntryAction<K,V,R>	createEntryAction(K key, Entry<K,V> e, Semantic<K,V,R> op)
Iterable<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)
protected <R> R	execute(Semantic<K,V,R> op, EntryAction<K,V,R> _action)
StorageAdapter	getStorage()
<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()
Iterable<K>	keys() Key iteration on top of normal iterator.
static String	nameQualifier(org.cache2k.Cache cache)
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.core.InternalCache

cancelTimerJobs, expireOrScheduleFinalExpireEvent, getClock, getCommonMetrics, getEntryState, getInfo, getKeyType, getLatestInfo, getLog, getTotalEntryCount, getValueType, isNullValuePermitted, logAndCountInternalException, returnCacheEntry, timerEventExpireEntry, timerEventProbationTerminated, timerEventRefresh

Methods inherited from interface org.cache2k.Cache

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

Methods inherited from interface org.cache2k.core.CanCheckIntegrity

checkIntegrity

Constructor Detail

BaseCache

public BaseCache()

Method Detail

nameQualifier

public static String nameQualifier(org.cache2k.Cache cache)

See Also:

similar

iterator

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

keys

public Iterable<K> keys()

Key iteration on top of normal iterator.

Specified by:

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

entries

public Iterable<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>

Specified by:

removeAll in interface org.cache2k.KeyValueStore<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>

getStorage

public StorageAdapter getStorage()

Specified by:

getStorage in interface InternalCache<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>

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)

execute

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

execute

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

createCustomization

public <T> T createCustomization(org.cache2k.configuration.CustomizationSupplier<T> f)

Description copied from interface: InternalCache

Calls factory and wraps exceptions.

Specified by:

createCustomization in interface InternalCache<K,V>

Parameters:

f - factory or null. If null, then null is returned.

closeCustomization

public void closeCustomization(Object _customization,
                               String _customizationName)

Description copied from interface: InternalCache

Call close on the customization if the Closeable interface is implemented

Specified by:

closeCustomization in interface InternalCache<K,V>

clearAndClose

public void clearAndClose()

Specified by:

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

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