com.helger.commons.cache

Class CacheWithConversion<KEYTYPE,VALUETYPE>

java.lang.Object

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

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

Type Parameters:

KEYTYPE - Cache key type

VALUETYPE - Cache value type

All Implemented Interfaces:

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

@ThreadSafe
public class CacheWithConversion<KEYTYPE,VALUETYPE>
extends AbstractCache<KEYTYPE,VALUETYPE>

A special cache that can create the value to be cache automatically from the key.

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
CacheWithConversion(int nMaxSize, String sCacheName)
CacheWithConversion(String sCacheName)

Method Summary

Modifier and Type	Method and Description
VALUETYPE	getFromCache(KEYTYPE aKey, IConverter<KEYTYPE,VALUETYPE> aValueRetriever) Get the value from the cache.

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

clearCache, createCache, getFromCache, 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

Constructor Detail

CacheWithConversion

public CacheWithConversion(@Nonnull
                           String sCacheName)

CacheWithConversion

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

Method Detail

getFromCache

@Nonnull
public final VALUETYPE getFromCache(@Nonnull
                                              KEYTYPE aKey,
                                              @Nonnull
                                              IConverter<KEYTYPE,VALUETYPE> aValueRetriever)

Get the value from the cache. If no value is yet in the cache, the passed converter is used to get the value to cache.

Parameters:

aKey - The key of the cached object. May not be null.

aValueRetriever - The converter to be used to retrieve the object to cache. May not be null. This converter may not return null objects to cache!

Returns:

The cached value. Never null.