org.conqat.lib.commons.cache4j.backend

Interface ICacheBackend<K,V>

Type Parameters:

K - the key type. This must have both Object.equals(Object) and Object.hashCode() correctly implemented.

V - the value type. It is generally recommended to use an immutable type here, but this is not required.

public interface ICacheBackend<K,V>

Interface for cache backends. This is a basic key-based get/set interface. However, we do not use the method names from the map interface, as we do not have map semantics (i.e. information can get lost).

Implementations are not required to deal with synchronization. This has to be handled by the caller.

Method Summary

Modifier and Type	Method and Description
ICacheBackend<K,V>	newInstance() Returns a new instance of this backend.
V	retrieve(K key) Returns the value stored at a given key or null.
void	store(K key, V value) Stores an element (value) using the given key.

Method Detail

store

void store(K key,
           V value)

Stores an element (value) using the given key.

retrieve

V retrieve(K key)

Returns the value stored at a given key or null. The cache guarantees, that only values inserted via store(Object, Object) can be returned. However, there is no guarantee that a non-null value is returned, i.e. the cache may forget information.

newInstance

ICacheBackend<K,V> newInstance()

Returns a new instance of this backend. This is required as certain cache implementations require multiple backends, and cloning is not an option as we do not want to duplicate the cache contents.