org.cache2k.core

Interface InternalCache<K,V>

All Superinterfaces:

org.cache2k.AdvancedKeyValueSource<K,V>, AutoCloseable, org.cache2k.Cache<K,V>, CanCheckIntegrity, Closeable, org.cache2k.KeyValueSource<K,V>, org.cache2k.KeyValueStore<K,V>

All Known Implementing Classes:

BaseCache, HeapCache, IntHeapCache, IntWiredCache, LongHeapCache, LongWiredCache, WiredCache

public interface InternalCache<K,V>
extends org.cache2k.Cache<K,V>, CanCheckIntegrity

Interface to extended cache functions for the internal components.

Author:

Jens Wilke

Method Summary

Modifier and Type	Method and Description
void	cancelTimerJobs() used from the cache manager for shutdown
void	closeCustomization(Object _customization, String _name) 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.
void	expireOrScheduleFinalExpireEvent(Entry<K,V> e)
InternalClock	getClock() Time reference for the cache.
CommonMetrics	getCommonMetrics()
String	getEntryState(K key)
InternalCacheInfo	getInfo() Generate cache statistics.
org.cache2k.configuration.CacheType	getKeyType()
InternalCacheInfo	getLatestInfo() Generate fresh statistics.
Log	getLog() used from the cache manager
StorageAdapter	getStorage()
int	getTotalEntryCount() This method is used for ConcurrentMapWrapper.size()
org.cache2k.configuration.CacheType	getValueType()
boolean	isNullValuePermitted()
void	logAndCountInternalException(String s, Throwable t)
org.cache2k.CacheEntry<K,V>	returnCacheEntry(ExaminationEntry<K,V> e)
void	timerEventExpireEntry(Entry<K,V> e)
void	timerEventProbationTerminated(Entry<K,V> e)
void	timerEventRefresh(Entry<K,V> e)

Methods inherited from interface org.cache2k.Cache

asMap, clear, clearAndClose, close, computeIfAbsent, containsAndRemove, containsKey, entries, expireAt, get, getAll, getCacheManager, getEntry, getName, invoke, invokeAll, isClosed, keys, loadAll, peek, peekAll, peekAndPut, peekAndRemove, peekAndReplace, peekEntry, prefetch, prefetchAll, put, putAll, putIfAbsent, reloadAll, remove, removeAll, removeAll, removeIfEquals, replace, replaceIfEquals, requestInterface, toString

Methods inherited from interface org.cache2k.core.CanCheckIntegrity

checkIntegrity

Method Detail

getCommonMetrics

CommonMetrics getCommonMetrics()

getLog

Log getLog()

used from the cache manager

getStorage

StorageAdapter getStorage()

getKeyType

org.cache2k.configuration.CacheType getKeyType()

getValueType

org.cache2k.configuration.CacheType getValueType()

cancelTimerJobs

void cancelTimerJobs()

used from the cache manager for shutdown

timerEventRefresh

void timerEventRefresh(Entry<K,V> e)

timerEventExpireEntry

void timerEventExpireEntry(Entry<K,V> e)

timerEventProbationTerminated

void timerEventProbationTerminated(Entry<K,V> e)

expireOrScheduleFinalExpireEvent

void expireOrScheduleFinalExpireEvent(Entry<K,V> e)

getInfo

InternalCacheInfo getInfo()

Generate cache statistics. Some of the statistic values involve scanning portions of the cache content. To prevent system stress e.g. monitoring there is a the compute intensive parts will only be repeated if some time is passed.

getLatestInfo

InternalCacheInfo getLatestInfo()

Generate fresh statistics. This version is used by internal tests. This method is not intended to be called at high frequencies or for attaching monitoring or logging. Use the getInfo() method for requesting information for monitoring.

getEntryState

String getEntryState(K key)

getTotalEntryCount

int getTotalEntryCount()

This method is used for ConcurrentMapWrapper.size()

logAndCountInternalException

void logAndCountInternalException(String s,
                                  Throwable t)

isNullValuePermitted

boolean isNullValuePermitted()

createCustomization

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

Calls factory and wraps exceptions.

Parameters:

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

closeCustomization

void closeCustomization(Object _customization,
                        String _name)

Call close on the customization if the Closeable interface is implemented

getClock

InternalClock getClock()

Time reference for the cache.

returnCacheEntry

org.cache2k.CacheEntry<K,V> returnCacheEntry(ExaminationEntry<K,V> e)