Top Description Inners Fields Constructors Methods
EDU.oswego.cs.dl.util.concurrent

public Class ConcurrentHashMap

extends AbstractMap
implements Map, Cloneable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Cloneable, java.util.Map
Imports
java.util.Map, .AbstractMap, .AbstractSet, .AbstractCollection, .Collection, .Set, .Iterator, .Enumeration, .NoSuchElementException, java.io.Serializable, .IOException, .ObjectInputStream, .ObjectOutputStream

A version of Hashtable supporting concurrency for both retrievals and updates:
Retrievals
Retrievals may overlap updates. (This is the same policy as ConcurrentReaderHashMap.) Successful retrievals using get(key) and containsKey(key) usually run without locking. Unsuccessful retrievals (i.e., when the key is not present) do involve brief synchronization (locking). Because retrieval operations can ordinarily overlap with update operations (i.e., put, remove, and their derivatives), retrievals can only be guaranteed to return the results of the most recently completed operations holding upon their onset. Retrieval operations may or may not return results reflecting in-progress writing operations. However, the retrieval operations do always return consistent results -- either those holding before any single modification or after it, but never a nonsense result. For aggregate operations such as putAll and clear, concurrent reads may reflect insertion or removal of only some entries.

Iterators and Enumerations (i.e., those returned by keySet().iterator(), entrySet().iterator(), values().iterator(), keys(), and elements()) return elements reflecting the state of the hash table at some point at or since the creation of the iterator/enumeration. They will return at most one instance of each element (via next()/nextElement()), but might or might not reflect puts and removes that have been processed since they were created. They do not throw ConcurrentModificationException. However, these iterators are designed to be used by only one thread at a time. Passing an iterator across multiple threads may lead to unpredictable results if the table is being concurrently modified.

Updates
This class supports a hard-wired preset concurrency level of 32. This allows a maximum of 32 put and/or remove operations to proceed concurrently. This level is an upper bound on concurrency, not a guarantee, since it interacts with how well-strewn elements are across bins of the table. (The preset value in part reflects the fact that even on large multiprocessors, factors other than synchronization tend to be bottlenecks when more than 32 threads concurrently attempt updates.) Additionally, operations triggering internal resizing and clearing do not execute concurrently with any operation.

There is NOT any support for locking the entire table to prevent updates. This makes it imposssible, for example, to add an element only if it is not already present, since another thread may be in the process of doing the same thing. If you need such capabilities, consider instead using the ConcurrentReaderHashMap class.

Because of how concurrency control is split up, the size() and isEmpty() methods require accumulations across 32 control segments, and so might be slightly slower than you expect.

This class may be used as a direct replacement for java.util.Hashtable in any application that does not rely on the ability to lock the entire table to prevent updates. As of this writing, it performs much faster than Hashtable in typical multi-threaded applications with multiple readers and writers. Like Hashtable but unlike java.util.HashMap, this class does NOT allow null to be used as a key or value.

Implementation Note

A slightly faster implementation of this class will be possible once planned Java Memory Model revisions are in place.

See Also
Introduction to this package.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class
ConcurrentHashMap.Entry

ConcurrentHashMap collision list entry.

private class
protected class
protected class
private class
protected static class
ConcurrentHashMap.Segment

Bookkeeping for each concurrency control segment.

protected class
private class

Field Summary

Modifier and TypeField and Description
protected static final int
CONCURRENCY_LEVEL

The number of concurrency control segments.

public static int
DEFAULT_INITIAL_CAPACITY

The default initial number of table slots for this table (32).

public static final float
DEFAULT_LOAD_FACTOR

The default load factor for this table (0.75) Used when not otherwise specified in constructor.

protected transient Set<E>
protected transient Set<E>
protected final float
loadFactor

The load factor for the hash table.

private static final int
MAXIMUM_CAPACITY

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

private static final int
MINIMUM_CAPACITY

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

protected static final int
SEGMENT_MASK

Mask value for indexing into segments

protected final ConcurrentHashMap.Segment[]
segments

The array of concurrency control segments.

protected transient ConcurrentHashMap.Entry[]
table

The hash table data.

protected int
threshold

Per-segment resize threshold.

protected transient Collection<E>
protected transient volatile int
votesForResize

Number of segments voting for resize.

Constructor Summary

AccessConstructor and Description
public
ConcurrentHashMap(int
the initial capacity. The actual initial capacity is rounded to the nearest power of two.
initialCapacity
,
float
the load factor threshold, used to control resizing. This value is used in an approximate way: When at least a quarter of the segments of the table reach per-segment threshold, or one of the segments itself exceeds overall threshold, the table is doubled. This will on average cause resizing when the table-wide load factor is slightly less than the threshold. If you'd like to avoid resizing, you can set this to a ridiculously large value.
loadFactor
)

Constructs a new, empty map with the specified initial capacity and the specified load factor.

public
ConcurrentHashMap(int
the initial capacity of the ConcurrentHashMap.
initialCapacity
)

Constructs a new, empty map with the specified initial capacity and default load factor.

public
ConcurrentHashMap()

Constructs a new, empty map with a default initial capacity and default load factor.

public
ConcurrentHashMap(Map<K, V> t)

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

Method Summary

Modifier and TypeMethod and Description
protected static int
bitcount(int w)

Return the number of set bits in w.

public void
clear()

Overrides java.util.AbstractMap.clear.

Implements java.util.Map.clear.

Removes all mappings from this map.
public Object

Returns:

a shallow copy of this map.
clone
()

Overrides java.util.AbstractMap.clone.

Returns a shallow copy of this ConcurrentHashMap instance: the keys and values themselves are not cloned.
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
)

Tests 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<E>

Returns:

an enumeration of the values in this table.
elements
()

Returns an enumeration of the values in this table.

public Set<E>

Returns:

a collection view of the mappings contained in this map.
entrySet
()

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Returns a collection view of the mappings contained in this map.
protected boolean
eq(Object x, Object y)

Hides java.util.AbstractMap.eq.

Check for equality of non-null references x and y.
public Object

Returns:

the value to which the key is mapped in this table; null if the key is not mapped to any value in this table.
get
(Object
a key in the table.
key
)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Returns the value to which the specified key is mapped in this table.
protected static int
hash(Object x)

Return hash code for Object x.

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<E>

Returns:

an enumeration of the keys in this table.
keys
()

Returns an enumeration of the keys in this table.

public Set<E>

Returns:

a set view of the keys contained in this map.
keySet
()

Overrides java.util.AbstractMap.keySet.

Implements java.util.Map.keySet.

Returns a set view of the keys contained in this map.
protected ConcurrentHashMap.Entry[]
newTable(int capacity)

Create table array and set the per-segment threshold

private int
p2capacity(int initialCapacity)

Returns the appropriate capacity (power of two) for the specified initial capacity argument.

public Object

Returns:

the previous value of the specified key in this table, or null if it did not have one.
put
(Object
the table key.
key
,
Object
the value.
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<K, V>
Mappings to be stored in this map.
t
)

Overrides java.util.AbstractMap.putAll.

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this one.
private void
readObject(ObjectInputStream s)

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

protected void
rehash()

Rehashes the contents of this map into a new table with a larger capacity.

public Object

Returns:

the value to which the key had been mapped in this table, or null if the key did not have a mapping.
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 table.
protected Object

Returns:

the value to which the key had been mapped in this table, or null if the key did not have a mapping.
remove
(Object
the key that needs to be removed.
key
,
Object
the associated value. If the value is null, it means "any value".
value
)

Overrides default java.util.Map.remove.

Removes the (key, value) pair from this table.
protected void
resize(int
the current segment. initially call value must be 0
index
,
ConcurrentHashMap.Entry[]
the state of table on first call to resize. If this changes on any call, the attempt is aborted because the table has already been resized by another thread.
assumedTab
)

Gather all locks in order to call rehash, by recursing within synch blocks for each segment index.

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<E>

Returns:

a collection view of the values contained in this map.
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 s)

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

Inherited from java.util.AbstractMap:
equalshashCodetoString