com.triactive.jdo.util
Class SoftHashMap

java.lang.Object
  java.util.AbstractMap
      com.triactive.jdo.util.SoftHashMap

All Implemented Interfaces:

java.util.Map

public class SoftHashMap

extends java.util.AbstractMap

implements java.util.Map

A hashtable-based Map implementation with soft keys. An entry in a SoftHashMap will automatically be removed when its key is no longer in ordinary use. More precisely, the presence of a mapping for a given key will not prevent the key from being discarded by the garbage collector, that is, made finalizable, finalized, and then reclaimed. When a key has been discarded its entry is effectively removed from the map, so this class behaves somewhat differently than other Map implementations.

Both null values and the null key are supported. This class has performance characteristics similar to those of the HashMap class, and has the same efficiency parameters of initial capacity and load factor.

Like most collection classes, this class is not synchronized. A synchronized SoftHashMap may be constructed using the Collections.synchronizedMap method.

This class is intended primarily for use with key objects whose equals methods test for object identity using the == operator. Once such a key is discarded it can never be recreated, so it is impossible to do a lookup of that key in a SoftHashMap at some later time and be surprised that its entry has been removed. This class will work perfectly well with key objects whose equals methods are not based upon object identity, such as String instances. With such recreatable key objects, however, the automatic removal of SoftHashMap entries whose keys have been discarded may prove to be confusing.

The behavior of the SoftHashMap class depends in part upon the actions of the garbage collector, so several familiar (though not required) Map invariants do not hold for this class. Because the garbage collector may discard keys at any time, a SoftHashMap may behave as though an unknown thread is silently removing entries.s In particular, even if you synchronize on a SoftHashMap instance and invoke none of its mutator methods, it is possible for the size method to return smaller values over time, for the isEmpty method to return false and then true, for the containsKey method to return true and later false for a given key, for the get method to return a value for a given key but later return null, for the put method to return null and the remove method to return false for a key that previously appeared to be in the map, and for successive examinations of the key set, the value set, and the entry set to yield successively smaller numbers of elements.

Each key object in a SoftHashMap is stored indirectly as the referent of a soft reference. Therefore a key will automatically be removed only after the soft references to it, both inside and outside of the map, have been cleared by the garbage collector.

Implementation note: The value objects in a SoftHashMap are held by ordinary strong references. Thus care should be taken to ensure that value objects do not strongly refer to their own keys, either directly or indirectly, since that will prevent the keys from being discarded. Note that a value object may refer indirectly to its key via the SoftHashMap itself; that is, a value object may strongly refer to some other key object whose associated value object, in turn, strongly refers to the key of the first value object. One way to deal with this is to wrap values themselves within SoftReferences before inserting, as in: m.put(key, new SoftReference(value)), and then unwrapping upon each get.

The iterators returned by all of this class's "collection view methods" are fail-fast: if the map is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove or add methods, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

Author:

Mike Martin (borrowing liberally from java.util.WeakHashMap)

Constructor Summary

SoftHashMap()
Constructs a new, empty SoftHashMap with the default initial capacity (16) and the default load factor (0.75).

SoftHashMap(int initialCapacity)
Constructs a new, empty SoftHashMap with the given initial capacity and the default load factor, which is 0.75.

SoftHashMap(int initialCapacity, float loadFactor)
Constructs a new, empty SoftHashMap with the given initial capacity and the given load factor.

SoftHashMap(java.util.Map t)
Constructs a new SoftHashMap with the same mappings as the specified Map.

Method Summary

void	clear() Removes all mappings from this map.
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.util.Set	entrySet() Returns a collection view of the mappings contained in this map.
java.lang.Object	get(java.lang.Object key) Returns the value to which the specified key is mapped in this soft hash map, or null if the map contains no mapping for this key.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set	keySet() Returns a set view of the keys contained in this map.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Associates the specified value with the specified key in this map.
void	putAll(java.util.Map m) Copies all of the mappings from the specified map to this map.
java.lang.Object	remove(java.lang.Object key) Removes the mapping for this key from this map if present.
int	size() Returns the number of key-value mappings in this map.
java.util.Collection	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

SoftHashMap

public SoftHashMap(int initialCapacity,
                   float loadFactor)

Constructs a new, empty SoftHashMap with the given initial capacity and the given load factor.

Parameters:

initialCapacity - The initial capacity of the SoftHashMap

loadFactor - The load factor of the SoftHashMap

Throws:

java.lang.IllegalArgumentException - If the initial capacity is negative, or if the load factor is nonpositive.

SoftHashMap

public SoftHashMap(int initialCapacity)

Constructs a new, empty SoftHashMap with the given initial capacity and the default load factor, which is 0.75.

Parameters:

initialCapacity - The initial capacity of the SoftHashMap

Throws:

java.lang.IllegalArgumentException - If the initial capacity is negative.

SoftHashMap

public SoftHashMap()

Constructs a new, empty SoftHashMap with the default initial capacity (16) and the default load factor (0.75).

SoftHashMap

public SoftHashMap(java.util.Map t)

Constructs a new SoftHashMap with the same mappings as the specified Map. The SoftHashMap is created with default load factor, which is 0.75 and an initial capacity sufficient to hold the mappings in the specified Map.

Parameters:

t - the map whose mappings are to be placed in this map.

Throws:

java.lang.NullPointerException - if the specified map is null.

Method Detail

size

public int size()

Returns the number of key-value mappings in this map. This result is a snapshot, and may not reflect unprocessed entries that will be removed before next attempted access because they are no longer referenced.

Specified by:

size in interface java.util.Map

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings. This result is a snapshot, and may not reflect unprocessed entries that will be removed before next attempted access because they are no longer referenced.

Specified by:

isEmpty in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Returns the value to which the specified key is mapped in this soft hash map, or null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to null. The containsKey method may be used to distinguish these two cases.

Specified by:

get in interface java.util.Map

Parameters:

key - the key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key, or null if the map contains no mapping for this key.

See Also:

put(Object, Object)

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface java.util.Map

Parameters:

key - The key whose presence in this map is to be tested

Returns:

true if there is a mapping for key; false otherwise

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

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

Specified by:

put in interface java.util.Map

Parameters:

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

value - value to be associated with the specified key.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

putAll

public void putAll(java.util.Map m)

Copies all of the mappings from the specified map to this map. These mappings will replace any mappings that this map had for any of the keys currently in the specified map.

Specified by:

putAll in interface java.util.Map

Parameters:

m - mappings to be stored in this map.

Throws:

java.lang.NullPointerException - if the specified map is null.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the mapping for this key from this map if present.

Specified by:

remove in interface java.util.Map

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

clear

public void clear()

Removes all mappings from this map.

Specified by:

clear in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface java.util.Map

Parameters:

value - value whose presence in this map is to be tested.

Returns:

true if this map maps one or more keys to the specified value.

keySet

public java.util.Set keySet()

Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

keySet in interface java.util.Map

Returns:

a set view of the keys contained in this map.

values

public java.util.Collection values()

Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

values in interface java.util.Map

Returns:

a collection view of the values contained in this map.

entrySet

public java.util.Set entrySet()

Returns a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface java.util.Map

Returns:

a collection view of the mappings contained in this map.