com.helger.commons.cache

Class AbstractNotifyingCache<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.cache.AbstractCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCache<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Cache key type

VALUETYPE - Cache value type

All Implemented Interfaces:

ICache<KEYTYPE,VALUETYPE>, IMutableCache<KEYTYPE,VALUETYPE>, IHasSize, IHasName

Direct Known Subclasses:

DateTimeFormatterCache, RegExCache, SchemaCache

@ThreadSafe
public abstract class AbstractNotifyingCache<KEYTYPE,VALUETYPE>
extends AbstractCache<KEYTYPE,VALUETYPE>

A caching class that has the ability to fill itself with the abstract getValueToCache(Object) method.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.commons.cache.AbstractCache

m_aCacheAccessStats, m_aRWLock, STATISTICS_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractNotifyingCache(int nMaxSize, String sCacheName)
AbstractNotifyingCache(String sCacheName)

Method Summary

Modifier and Type	Method and Description
VALUETYPE	getFromCache(KEYTYPE aKey) Get the cached value associated with the passed key.
protected abstract VALUETYPE	getValueToCache(KEYTYPE aKey) This abstract method is invoked, once a new value needs to be put into the cache.

Methods inherited from class com.helger.commons.cache.AbstractCache

clearCache, createCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getFromCacheNotLocked, getMaxSize, getName, getSize, hasMaxSize, isEmpty, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Constructor Detail

AbstractNotifyingCache

public AbstractNotifyingCache(@Nonnull
                              String sCacheName)

AbstractNotifyingCache

public AbstractNotifyingCache(@CheckForSigned
                              int nMaxSize,
                              @Nonnull
                              String sCacheName)

Method Detail

getValueToCache

@Nonnull
 @IsLocked(value=WRITE)
protected abstract VALUETYPE getValueToCache(KEYTYPE aKey)

This abstract method is invoked, once a new value needs to be put into the cache. This method is invoked within a locked section.

Parameters:

aKey - The key for which the value to cache is required. May be nullable or not - depends upon the implementation.

Returns:

The value to be cached. May not be null.

getFromCache

public final VALUETYPE getFromCache(KEYTYPE aKey)

Description copied from interface: ICache

Get the cached value associated with the passed key.

Specified by:

getFromCache in interface ICache<KEYTYPE,VALUETYPE>

Overrides:

getFromCache in class AbstractCache<KEYTYPE,VALUETYPE>

Parameters:

aKey - The key to be looked up. May be nullable or not - depends upon the implementation.

Returns:

null if no such value is in the cache.