org.castor.cache.hashbelt.container
Class WeakReferenceContainer<K,V>

java.lang.Object
  extended by org.castor.cache.hashbelt.container.WeakReferenceContainer<K,V>
Type Parameters:
K - the type of keys maintained by this cache
V - the type of cached values
All Implemented Interfaces:
Map<K,V>, Container<K,V>

public final class WeakReferenceContainer<K,V>
extends Object
implements Container<K,V>

An implementation of a container that uses weak references for storing values in the map, so that values can be removed from the map by the system when the system is under memory pressure. Keys, however, are kept strong - so contains() may well find an element, but the value may have been lost. Make sure you test for null returns from put.

Note that keys are hard references; in a situation where OutOfMemory will occur, the JVM will first wipe out all unreferenced objects whose only link is a weak reference. An out of memory will wipe all values from the maps which are currently unreferenced. The keys remain until the hashbelt containers are garbage collected, an put is called with that key or when the value should be accessed through any operation of the Container interface.

Since:
1.0
Version:
$Revision: 9040 $ $Date: 2011-08-16 08:26:59 +0200 (Di, 16 Aug 2011) $
Author:
Gregory Block, Ralf Joachim

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Constructor Summary
WeakReferenceContainer()
           
 
Method Summary
 void clear()
          
 boolean containsKey(Object key)
          
 boolean containsValue(Object value)
          
 Set<Map.Entry<K,V>> entrySet()
          
 V get(Object key)
          
 long getTimestamp()
          Returns the timestamp of this container.
 boolean isEmpty()
          
 Iterator<K> keyIterator()
          Returns an iterator over the keys contained in this container.
 Set<K> keySet()
          
 V put(K key, V value)
          
 void putAll(Map<? extends K,? extends V> map)
          
 V remove(Object key)
          
 int size()
          
 void updateTimestamp()
          Set the timestamp of this container to System.currentTimeMillis().
 Iterator<V> valueIterator()
          Returns an iterator over the values contained in this container.
 Collection<V> values()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

WeakReferenceContainer

public WeakReferenceContainer()
Method Detail

updateTimestamp

public void updateTimestamp()
Set the timestamp of this container to System.currentTimeMillis().

Specified by:
updateTimestamp in interface Container<K,V>

getTimestamp

public long getTimestamp()
Returns the timestamp of this container.

Specified by:
getTimestamp in interface Container<K,V>
Returns:
The timestamp.

keyIterator

public Iterator<K> keyIterator()
Returns an iterator over the keys contained in this container. If the container is modified while an iteration is in progress, the results of the iteration is not affected and vice-versa.

Specified by:
keyIterator in interface Container<K,V>
Returns:
An iterator over the keys currently contained in the container.

valueIterator

public Iterator<V> valueIterator()
Returns an iterator over the values contained in this container. If the container is modified while an iteration is in progress, the results of the iteration is not affected and vice-versa.

Specified by:
valueIterator in interface Container<K,V>
Returns:
An iterator over the values currently contained in the container.

size

public int size()

Specified by:
size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:
isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:
containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:
containsValue in interface Map<K,V>

get

public V get(Object key)

Specified by:
get in interface Map<K,V>

put

public V put(K key,
             V value)

Specified by:
put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:
remove in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map)

Specified by:
putAll in interface Map<K,V>

clear

public void clear()

Specified by:
clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:
keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:
values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:
entrySet in interface Map<K,V>


Copyright © 2012. All Rights Reserved.