com.helger.commons.cache

Interface ISimpleCache<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Cache key type.

VALUETYPE - Cache value type.

All Superinterfaces:

IHasName, IHasSize, SimpleCacheMBean

All Known Implementing Classes:

AbstractCache, AbstractNotifyingCache, AbstractNotifyingCacheWithMaxSize, DefaultSchemaCache, JAXBContextCache, RegExPool, SimpleCacheWithConversion, SimpleCacheWithConversionAndMaxSize, XMLSchemaCache

public interface ISimpleCache<KEYTYPE,VALUETYPE>
extends SimpleCacheMBean, IHasName

Interface for a very simple Map-like cache.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
VALUETYPE	getFromCache(KEYTYPE aKey) Get the cached value associated with the passed key.
EChange	removeFromCache(KEYTYPE aKey) Remove the given key from the cache.

Methods inherited from interface com.helger.commons.cache.SimpleCacheMBean

clearCache

Methods inherited from interface com.helger.commons.IHasSize

isEmpty, size

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

getName

Method Detail

getFromCache

@Nullable
VALUETYPE getFromCache(KEYTYPE aKey)

Get the cached value associated with the passed key.

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.

removeFromCache

@Nonnull
EChange removeFromCache(KEYTYPE aKey)

Remove the given key from the cache.

Parameters:

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

Returns:

EChange.CHANGED upon success, EChange.UNCHANGED if the key was not within the cache,