WeakHashMap (Java 2 Platform SE 5.0) (original) (raw)

java.util

Class WeakHashMap<K,V>

java.lang.Object java.util.AbstractMap<K,V> java.util.WeakHashMap<K,V>

All Implemented Interfaces:

Map<K,V>

public class WeakHashMap<K,V>

extends AbstractMap<K,V>

implements Map<K,V>

A hashtable-based Map implementation with weak keys. An entry in a WeakHashMap 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 WeakHashMap may be constructed using theCollections.synchronizedMap method.

This class is intended primarily for use with key objects whoseequals 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 aWeakHashMap 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 WeakHashMap entries whose keys have been discarded may prove to be confusing.

The behavior of the WeakHashMap 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, aWeakHashMap may behave as though an unknown thread is silently removing entries. In particular, even if you synchronize on aWeakHashMap 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 returntrue and later false for a given key, for theget method to return a value for a given key but later returnnull, for the put method to returnnull and the remove method to returnfalse 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 WeakHashMap is stored indirectly as the referent of a weak reference. Therefore a key will automatically be removed only after the weak references to it, both inside and outside of the map, have been cleared by the garbage collector.

Implementation note: The value objects in aWeakHashMap 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 WeakHashMap 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 withinWeakReferences before inserting, as in: m.put(key, new WeakReference(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 ownremove or add methods, the iterator will throw aConcurrentModificationException. 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.

This class is a member of the Java Collections Framework.

Since:

1.2

See Also:

HashMap, WeakReference

WeakHashMap

public WeakHashMap(int initialCapacity, float loadFactor)

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

Parameters:

initialCapacity - The initial capacity of the WeakHashMap

loadFactor - The load factor of the WeakHashMap

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - If the initial capacity is negative, or if the load factor is nonpositive.

WeakHashMap

public WeakHashMap(int initialCapacity)

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

Parameters:

initialCapacity - The initial capacity of the WeakHashMap

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - If the initial capacity is negative.

WeakHashMap

public WeakHashMap()

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

WeakHashMap

public WeakHashMap(Map<? extends K,? extends V> t)

Constructs a new WeakHashMap with the same mappings as the specified Map. The WeakHashMap 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:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the specified map is null.

Since:

1.3

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](../../java/util/Map.html#size%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[size](../../java/util/AbstractMap.html#size%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Returns:

the number of key-value mappings in this 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](../../java/util/Map.html#isEmpty%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[isEmpty](../../java/util/AbstractMap.html#isEmpty%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Returns:

true if this map contains no key-value mappings.

get

public V get(Object key)

Returns the value to which the specified key is mapped in this weak 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. ThecontainsKey method may be used to distinguish these two cases.

Specified by:

[get](../../java/util/Map.html#get%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[get](../../java/util/AbstractMap.html#get%28java.lang.Object%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Parameters:

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

Returns:

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

See Also:

[put(Object, Object)](../../java/util/WeakHashMap.html#put%28K, V%29)

containsKey

public boolean containsKey(Object key)

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

Specified by:

[containsKey](../../java/util/Map.html#containsKey%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[containsKey](../../java/util/AbstractMap.html#containsKey%28java.lang.Object%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

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 V put(K key, V 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](../../java/util/Map.html#put%28K, V%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[put](../../java/util/AbstractMap.html#put%28K, V%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

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 HashMap previously associatednull with the specified key.

putAll

public void putAll(Map<? extends K,? extends V> 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](../../java/util/Map.html#putAll%28java.util.Map%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[putAll](../../java/util/AbstractMap.html#putAll%28java.util.Map%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Parameters:

m - mappings to be stored in this map.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the specified map is null.

remove

public V remove(Object key)

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

Specified by:

[remove](../../java/util/Map.html#remove%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[remove](../../java/util/AbstractMap.html#remove%28java.lang.Object%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

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](../../java/util/Map.html#clear%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[clear](../../java/util/AbstractMap.html#clear%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

containsValue

public boolean containsValue(Object value)

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

Specified by:

[containsValue](../../java/util/Map.html#containsValue%28java.lang.Object%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[containsValue](../../java/util/AbstractMap.html#containsValue%28java.lang.Object%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

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 Set<K> 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, andclear operations. It does not support the add oraddAll operations.

Specified by:

[keySet](../../java/util/Map.html#keySet%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[keySet](../../java/util/AbstractMap.html#keySet%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Returns:

a set view of the keys contained in this map.

values

public Collection<V> 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 theIterator.remove, Collection.remove,removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

[values](../../java/util/Map.html#values%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Overrides:

[values](../../java/util/AbstractMap.html#values%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Returns:

a collection view of the values contained in this map.

entrySet

public Set<Map.Entry<K,V>> 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 theIterator.remove, Collection.remove,removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

[entrySet](../../java/util/Map.html#entrySet%28%29) in interface [Map](../../java/util/Map.html "interface in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Specified by:

[entrySet](../../java/util/AbstractMap.html#entrySet%28%29) in class [AbstractMap](../../java/util/AbstractMap.html "class in java.util")<[K](../../java/util/WeakHashMap.html "type parameter in WeakHashMap"),[V](../../java/util/WeakHashMap.html "type parameter in WeakHashMap")>

Returns:

a collection view of the mappings contained in this map.

See Also:

Map.Entry

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.