public class ConcurrentReaderHashMap extends AbstractMap implements Map, Cloneable, Serializable
Successful retrievals using get(key) and containsKey(key) usually run without locking. Unsuccessful ones (i.e., when the key is not present) do involve brief synchronization (locking). Also, the size and isEmpty methods are always synchronized.
Because retrieval operations can ordinarily overlap with writing 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. In those rare contexts in which you use a hash table to synchronize operations across threads (for example, to prevent reads until after clears), you should either encase operations in synchronized blocks, or instead use java.util.Hashtable.
This class also supports optional guaranteed
exclusive reads, simply by surrounding a call within a synchronized
block, as in
ConcurrentReaderHashMap t; ... Object v;
synchronized(t) { v = t.get(k); }
But this is not usually necessary in practice. For
example, it is generally inefficient to write:
ConcurrentReaderHashMap t; ... // Inefficient version
Object key; ...
Object value; ...
synchronized(t) {
if (!t.containsKey(key))
t.put(key, value);
// other code if not previously present
}
else {
// other code if it was previously present
}
}
Instead, if the values are intended to be the same in each case, just take advantage of the fact that put returns
null if the key was not previously present:
ConcurrentReaderHashMap t; ... // Use this instead
Object key; ...
Object value; ...
Object oldValue = t.put(key, value);
if (oldValue == null) {
// other code if not previously present
}
else {
// other code if it was previously present
}
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. Sharing an iterator across multiple threads may lead to unpredictable results if the table is being concurrently modified. Again, you can ensure interference-free iteration by enclosing the iteration in a synchronized block.
This class may be used as a direct replacement for any use of java.util.Hashtable that does not depend on readers being blocked during updates. Like Hashtable but unlike java.util.HashMap, this class does NOT allow null to be used as a key or value. This class is also typically faster than ConcurrentHashMap when there is usually only one thread updating the table, but possibly many retrieving values from it.
Implementation note: A slightly faster implementation of this class will be possible once planned Java Memory Model revisions are in place.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
ConcurrentReaderHashMap.BarrierLock
A Serializable class for barrier lock
|
protected static class |
ConcurrentReaderHashMap.Entry
ConcurrentReaderHashMap collision list entry.
|
protected class |
ConcurrentReaderHashMap.HashIterator |
protected class |
ConcurrentReaderHashMap.KeyIterator |
protected class |
ConcurrentReaderHashMap.ValueIterator |
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Modifier and Type | Field and Description |
|---|---|
protected ConcurrentReaderHashMap.BarrierLock |
barrierLock
Lock used only for its memory effects.
|
protected int |
count
The total number of mappings in the hash table.
|
static int |
DEFAULT_INITIAL_CAPACITY
The default initial number of table slots for this table (32).
|
static float |
DEFAULT_LOAD_FACTOR
The default load factor for this table (1.0).
|
protected Set |
entrySet |
protected Set |
keySet |
protected Object |
lastWrite
field written to only to guarantee lock ordering.
|
protected float |
loadFactor
The load factor for the hash table.
|
protected ConcurrentReaderHashMap.Entry[] |
table
The hash table data.
|
protected int |
threshold
The table is rehashed when its size exceeds this threshold.
|
protected Collection |
values |
| Constructor and Description |
|---|
ConcurrentReaderHashMap()
Constructs a new, empty map with a default initial capacity
and load factor.
|
ConcurrentReaderHashMap(int initialCapacity)
Constructs a new, empty map with the specified initial
capacity and default load factor.
|
ConcurrentReaderHashMap(int initialCapacity,
float loadFactor)
Constructs a new, empty map with the specified initial
capacity and the specified load factor.
|
ConcurrentReaderHashMap(Map t)
Constructs a new map with the same mappings as the given map.
|
| Modifier and Type | Method and Description |
|---|---|
int |
capacity() |
void |
clear()
Removes all mappings from this map.
|
Object |
clone()
Returns a shallow copy of this
ConcurrentReaderHashMap instance: the keys and
values themselves are not cloned.
|
boolean |
contains(Object value)
Tests if some key maps into the specified value in this table.
|
boolean |
containsKey(Object key)
Tests if the specified object is a key in this table.
|
boolean |
containsValue(Object value)
Returns true if this map maps one or more keys to the
specified value.
|
Enumeration |
elements()
Returns an enumeration of the values in this table.
|
Set |
entrySet()
Returns a collection view of the mappings contained in this map.
|
protected boolean |
eq(Object x,
Object y)
Check for equality of non-null references x and y.
|
protected boolean |
findAndRemoveEntry(Map.Entry entry)
Helper method for entrySet.remove
|
Object |
get(Object key)
Returns the value to which the specified key is mapped in this table.
|
protected ConcurrentReaderHashMap.Entry[] |
getTableForReading()
Get ref to table; the reference and the cells it
accesses will be at least as fresh as from last
use of barrierLock
|
boolean |
isEmpty()
Returns true if this map contains no key-value mappings.
|
Enumeration |
keys()
Returns an enumeration of the keys in this table.
|
Set |
keySet()
Returns a set view of the keys contained in this map.
|
float |
loadFactor() |
Object |
put(Object key,
Object value)
Maps the specified
key to the specified
value in this table. |
void |
putAll(Map t)
Copies all of the mappings from the specified map to this one.
|
protected void |
recordModification(Object x)
Force a memory synchronization that will cause
all readers to see table.
|
protected void |
rehash()
Rehashes the contents of this map into a new table
with a larger capacity.
|
Object |
remove(Object key)
Removes the key (and its corresponding value) from this
table.
|
int |
size()
Returns the number of key-value mappings in this map.
|
protected Object |
sput(Object key,
Object value,
int hash)
Continuation of put(), called only when sync lock is
held and interference has been detected.
|
protected Object |
sremove(Object key,
int hash)
Continuation of remove(), called only when sync lock is
held and interference has been detected.
|
Collection |
values()
Returns a collection view of the values contained in this map.
|
equals, hashCode, toStringprotected final ConcurrentReaderHashMap.BarrierLock barrierLock
protected transient Object lastWrite
public static final int DEFAULT_INITIAL_CAPACITY
public static final float DEFAULT_LOAD_FACTOR
protected transient ConcurrentReaderHashMap.Entry[] table
protected transient int count
protected int threshold
protected float loadFactor
protected transient Set keySet
protected transient Set entrySet
protected transient Collection values
public ConcurrentReaderHashMap(int initialCapacity,
float loadFactor)
initialCapacity - the initial capacity
The actual initial capacity is rounded to the nearest power of two.loadFactor - the load factor of the ConcurrentReaderHashMapIllegalArgumentException - if the initial maximum number
of elements is less
than zero, or if the load factor is non-positive.public ConcurrentReaderHashMap(int initialCapacity)
initialCapacity - the initial capacity of the
ConcurrentReaderHashMap.IllegalArgumentException - if the initial maximum number
of elements is less than zero.public ConcurrentReaderHashMap()
public ConcurrentReaderHashMap(Map t)
protected final void recordModification(Object x)
protected final ConcurrentReaderHashMap.Entry[] getTableForReading()
public int size()
size in interface Mapsize in class AbstractMappublic boolean isEmpty()
isEmpty in interface MapisEmpty in class AbstractMappublic Object get(Object key)
get in interface Mapget in class AbstractMapkey - a key in the table.null if the key is not mapped to any value in
this table.NullPointerException - if the key is null.put(Object, Object)public boolean containsKey(Object key)
containsKey in interface MapcontainsKey in class AbstractMapkey - possible key.true if and only if the specified object
is a key in this table, as determined by the
equals method; false otherwise.NullPointerException - if the key is null.contains(Object)public Object put(Object key, Object value)
key to the specified
value in this table. Neither the key nor the
value can be null.
The value can be retrieved by calling the get method
with a key that is equal to the original key.
put in interface Mapput in class AbstractMapkey - the table key.value - the value.null if it did not have one.NullPointerException - if the key or value is null.Object.equals(Object),
get(Object)protected Object sput(Object key, Object value, int hash)
protected void rehash()
public Object remove(Object key)
remove in interface Mapremove in class AbstractMapkey - the key that needs to be removed.null if the key did not have a mapping.NullPointerException - if the key is
null.protected Object sremove(Object key, int hash)
public boolean containsValue(Object value)
containsValue in interface MapcontainsValue in class AbstractMapvalue - value whose presence in this map is to be tested.NullPointerException - if the value is null.public boolean contains(Object value)
containsKey
method.Note that this method is identical in functionality to containsValue, (which is part of the Map interface in the collections framework).
value - a value to search for.true if and only if some key maps to the
value argument in this table as
determined by the equals method;
false otherwise.NullPointerException - if the value is null.containsKey(Object),
containsValue(Object),
Mappublic void putAll(Map t)
putAll in interface MapputAll in class AbstractMapt - Mappings to be stored in this map.public void clear()
clear in interface Mapclear in class AbstractMappublic Object clone()
clone in class AbstractMappublic Set keySet()
keySet in interface MapkeySet in class AbstractMappublic Collection values()
values in interface Mapvalues in class AbstractMappublic Set entrySet()
entrySet in interface MapentrySet in class AbstractMapprotected boolean findAndRemoveEntry(Map.Entry entry)
public Enumeration keys()
Enumeration,
elements(),
keySet(),
Mappublic Enumeration elements()
Enumeration,
keys(),
values(),
Mappublic int capacity()
public float loadFactor()