org.alfresco.repo.cache

Interface SimpleCache<K extends Serializable,V>

All Known Subinterfaces:

LockingCache<K,V>

All Known Implementing Classes:

MemoryCache

@AlfrescoPublicApi
public interface SimpleCache<K extends Serializable,V>

Basic caching interface.

All implementations must be thread-safe. Additionally, the use of the Serializable for both keys and values ensures that the underlying cache implementations can support both clustered caches as well as persistent caches.

All implementations must support null values. It therefore follows that

    (simpleCache.contains(key) == true) does not imply (simpleCache.get(key) != null)
 

but

    (simpleCache.contains(key) == false) implies (simpleCache.get(key) == null)
 

Author:

Derek Hulley

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	contains(K key)
V	get(K key)
Collection<K>	getKeys()
void	put(K key, V value)
void	remove(K key) Removes the cache entry whether or not the value stored against it is null.

Method Detail

contains

boolean contains(K key)

Parameters:

key - the cache key to check up on

Returns:

Returns true if there is a cache entry, regardless of whether the value itself is null

getKeys

Collection<K> getKeys()

get

V get(K key)

Parameters:

key -

Returns:

Returns the value associated with the key. It will be null if the value is null or if the cache doesn't have an entry.

put

void put(K key,
       V value)

Parameters:

key - the key against which to store the value

value - the value to store. null is allowed.

remove

void remove(K key)

Removes the cache entry whether or not the value stored against it is null.

Parameters:

key - the key value to remove

clear

void clear()