com.whitestein.lsps.common.cache

Class SoftCache<K,V>

java.lang.Object

com.whitestein.lsps.common.cache.SoftCache<K,V>

Type Parameters:

K - The type of a key with which a value is associated in the cache.

V - The type of a value which is stored in the cache.

public class SoftCache<K,V>
extends Object

A simple cache using SoftReferences to store values. It allows the values to be garbage collected if no more needed. When putting values into the cache the values are associated with keys. The keys are then used to retrieve values from the cache.

Note: This class is not thread-safe!

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
SoftCache()

Method Summary

Modifier and Type	Method and Description
V	get(K key) Returns the value to which the specified key is mapped, or null if this cache contains no mapping for the key or if the value to which the specified key is mapped has been garbage collected.
void	put(K key, V value) Associates the specified value with the specified key in this cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftCache

public SoftCache()

Method Detail

get

public V get(K key)

Returns the value to which the specified key is mapped, or null if this cache contains no mapping for the key or if the value to which the specified key is mapped has been garbage collected.

Parameters:

key - the key whose associated value is to be returned

Returns:

a value for the key or null if no value is available for the key

put

public void put(K key,
                V value)

Associates the specified value with the specified key in this cache. If the cache previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key