Top Description Inners Fields Constructors Methods
org.jruby.util.collections

public Class ConcurrentWeakHashMap<K, V>

extends AbstractMap<K, V>
implements ConcurrentMap<K, V>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.util.concurrent.ConcurrentMap, java.util.Map
Type Parameters
<K>
the type of keys maintained by this map
<V>
the type of mapped values
Imports
java.io.IOException, .Serializable, java.lang.ref.ReferenceQueue, .WeakReference, java.util.AbstractCollection, .AbstractMap, .AbstractSet, .Collection, .ConcurrentModificationException, .Enumeration, .HashMap, .Hashtable, .Iterator, .Map, .NoSuchElementException, .Set, java.util.concurrent.locks.ReentrantLock

A hash table with weak keys, full concurrency of retrievals, and adjustable expected concurrency for updates. Similar to java.util.WeakHashMap, entries of this table are periodically removed once their corresponding keys are no longer referenced outside of this table. In other words, this table will not prevent a key from being discarded by the garbage collector. Once a key has been discarded by the collector, the corresponding entry is no longer visible to this table; however, the entry may occupy space until a future table operation decides to reclaim it. For this reason, summary functions such as size and isEmpty might return a value greater than the observed number of entries. In order to support a high level of concurrency, stale entries are only reclaimed during blocking (usually mutating) operations. While keys in this table are only held using a weak reference, values are held using a normal strong reference. This provides the guarantee that a value will always have at least the same life-span as it's key. For this reason, care should be taken to ensure that a value never refers, either directly or indirectly, to its key, thereby preventing reclamation. If weak values are desired, one can simply use a WeakReference for the value type. Just like java.util.concurrent.ConcurrentHashMap, this class obeys the same functional specification as java.util.Hashtable, and includes versions of methods corresponding to each method of Hashtable. However, even though all operations are thread-safe, retrieval operations do not entail locking, and there is not any support for locking the entire table in a way that prevents all access. This class is fully interoperable with Hashtable in programs that rely on its thread safety but not on its synchronization details.

Retrieval operations (including get) generally do not block, so may overlap with update operations (including put and remove). Retrievals reflect the results of the most recently completed update operations holding upon their onset. For aggregate operations such as putAll and clear, concurrent retrievals may reflect insertion or removal of only some entries. Similarly, Iterators and Enumerations return elements reflecting the state of the hash table at some point at or since the creation of the iterator/enumeration. They do not throw ConcurrentModificationException. However, iterators are designed to be used by only one thread at a time.

The allowed concurrency among update operations is guided by the optional concurrencyLevel constructor argument (default 16), which is used as a hint for internal sizing. The table is internally partitioned to try to permit the indicated number of concurrent updates without contention. Because placement in hash tables is essentially random, the actual concurrency will vary. Ideally, you should choose a value to accommodate as many threads as will ever concurrently modify the table. Using a significantly higher value than you need can waste space and time, and a significantly lower value can lead to thread contention. But overestimates and underestimates within an order of magnitude do not usually have much noticeable impact. A value of one is appropriate when it is known that only one thread will modify and all others will only read. Also, resizing this or any other kind of hash table is a relatively slow operation, so, when possible, it is a good idea to provide estimates of expected table sizes in constructors.

This class and its views and iterators implement all of the optional methods of the Map and Iterator interfaces.

Like Hashtable but unlike HashMap, this class does not allow null to be used as a key or value.

This class is a member of the Java Collections Framework.

Authors
Doug Lea, Jason T. Greene

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
pack-priv class
pack-priv static class
ConcurrentWeakHashMap.HashEntry<K, V>

ConcurrentWeakHashMap list entry.

pack-priv abstract class
pack-priv class
pack-priv class
pack-priv static class
ConcurrentWeakHashMap.Segment<K, V>

Segments are specialized versions of hash tables.

pack-priv static class
pack-priv class
pack-priv class
pack-priv static class
ConcurrentWeakHashMap.WeakKeyReference<K>

A weak-key reference which stores the key hash needed for reclamation.

pack-priv class
ConcurrentWeakHashMap.WriteThroughEntry

Custom Entry class used by EntryIterator.next(), that relays setValue changes to the underlying map.

Field Summary

Modifier and TypeField and Description
pack-priv static final int
DEFAULT_CONCURRENCY_LEVEL

The default concurrency level for this table, used when not otherwise specified in a constructor.

pack-priv static final int
DEFAULT_INITIAL_CAPACITY

The default initial capacity for this table, used when not otherwise specified in a constructor.

pack-priv static final float
DEFAULT_LOAD_FACTOR

The default load factor for this table, used when not otherwise specified in a constructor.

pack-priv transient Set<Map.Entry<K, V>>
pack-priv transient Set<K>
pack-priv static final int
MAX_SEGMENTS

The maximum number of segments to allow; used to bound constructor arguments.

pack-priv static final int
MAXIMUM_CAPACITY

The maximum capacity, used if a higher value is implicitly specified by either of the constructors with arguments.

pack-priv static final int
RETRIES_BEFORE_LOCK

Number of unsynchronized retries in size and containsValue methods before resorting to locking.

pack-priv final int
segmentMask

Mask value for indexing into segments.

pack-priv final ConcurrentWeakHashMap.Segment<K, V>[]
segments

The segments, each of which is a specialized hash table

pack-priv final int
segmentShift

Shift value for indexing within segments.

private static final long
pack-priv transient Collection<V>

Constructor Summary

AccessConstructor and Description
public
ConcurrentWeakHashMap(int
the initial capacity. The implementation performs internal sizing to accommodate this many elements.
initialCapacity
,
float
the load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.
loadFactor
,
int
the estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.
concurrencyLevel
)

Creates a new, empty map with the specified initial capacity, load factor and concurrency level.

public
ConcurrentWeakHashMap(int
The implementation performs internal sizing to accommodate this many elements.
initialCapacity
,
float
the load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.
loadFactor
)

Creates a new, empty map with the specified initial capacity and load factor and with the default concurrencyLevel (16).

public
ConcurrentWeakHashMap(int
the initial capacity. The implementation performs internal sizing to accommodate this many elements.
initialCapacity
)

Creates a new, empty map with the specified initial capacity, and with default load factor (0.75) and concurrencyLevel (16).

public
ConcurrentWeakHashMap()

Creates a new, empty map with a default initial capacity (16), load factor (0.75) and concurrencyLevel (16).

public
ConcurrentWeakHashMap(Map<? extends K, ? extends V>
the map
m
)

Creates a new map with the same mappings as the given map.

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Overrides java.util.AbstractMap.clear.

Implements java.util.Map.clear.

Removes all of the mappings from this map.

public boolean

Returns:

true if and only if some key maps to the value argument in this table as determined by the equals method; false otherwise
contains
(Object
a value to search for
value
)

Legacy method testing if some key maps into the specified value in this table.

public boolean

Returns:

true if and only if the specified object is a key in this table, as determined by the equals method; false otherwise.
containsKey
(Object
possible key
key
)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Tests if the specified object is a key in this table.

public boolean

Returns:

true if this map maps one or more keys to the specified value
containsValue
(Object
value whose presence in this map is to be tested
value
)

Overrides java.util.AbstractMap.containsValue.

Implements java.util.Map.containsValue.

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

public Enumeration<V>

Returns:

an enumeration of the values in this table
elements
()

Returns an enumeration of the values in this table.

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

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.

public V
get(Object
the key whose associated value is to be returned
key
)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

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

private static int
hash(int h)

Applies a supplemental hash function to a given hashCode, which defends against poor quality hash functions.

public boolean

Returns:

true if this map contains no key-value mappings
isEmpty
()

Overrides java.util.AbstractMap.isEmpty.

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

public Enumeration<K>

Returns:

an enumeration of the keys in this table
keys
()

Returns an enumeration of the keys in this table.

public Set<K>
keySet()

Overrides java.util.AbstractMap.keySet.

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

public V

Returns:

the previous value associated with key, or null if there was no mapping for key
put
(K
key with which the specified value is to be associated
key
,
V
value to be associated with the specified key
value
)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Maps the specified key to the specified value in this table.

public void
putAll(Map<? extends K, ? extends V>
mappings to be stored in this map
m
)

Overrides java.util.AbstractMap.putAll.

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this one.

public V

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key
putIfAbsent
(K
key with which the specified value is to be associated
key
,
V
value to be associated with the specified key
value
)

Overrides default java.util.Map.putIfAbsent.

Implements java.util.concurrent.ConcurrentMap.putIfAbsent.

If the specified key is not already associated with a value, associates it with the given value.

private void
readObject(ObjectInputStream
the stream
s
)

Reconstitute the ConcurrentWeakHashMap instance from a stream (i.e., deserialize it).

public V

Returns:

the previous value associated with key, or null if there was no mapping for key
remove
(Object
the key that needs to be removed
key
)

Overrides java.util.AbstractMap.remove.

Implements java.util.Map.remove.

Removes the key (and its corresponding value) from this map.

public boolean
remove(Object
key with which the specified value is associated
key
,
Object
value expected to be associated with the specified key
value
)

Overrides default java.util.Map.remove.

Implements java.util.concurrent.ConcurrentMap.remove.

Removes the entry for a key only if currently mapped to a given value.

public boolean
replace(K
key with which the specified value is associated
key
,
V
value expected to be associated with the specified key
oldValue
,
V
value to be associated with the specified key
newValue
)

Overrides default java.util.Map.replace.

Implements java.util.concurrent.ConcurrentMap.replace.

Replaces the entry for a key only if currently mapped to a given value.

public V

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key
replace
(K
key with which the specified value is associated
key
,
V
value to be associated with the specified key
value
)

Overrides default java.util.Map.replace.

Implements java.util.concurrent.ConcurrentMap.replace.

Replaces the entry for a key only if currently mapped to some value.

pack-priv final ConcurrentWeakHashMap.Segment<K, V>

Returns:

the segment
segmentFor
(int
the hash code for the key
hash
)

Returns the segment that should be used for key with given hash

public int

Returns:

the number of key-value mappings in this map
size
()

Overrides java.util.AbstractMap.size.

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.

public Collection<V>
values()

Overrides java.util.AbstractMap.values.

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

private void
writeObject(ObjectOutputStream
the stream
s
)

Save the state of the ConcurrentWeakHashMap instance to a stream (i.e., serialize it).

Inherited from java.util.AbstractMap:
cloneequalshashCodetoString