FileDocCategorySizeDatePackage
ConcurrentMap.javaAPI DocJava SE 6 API6052Tue Jun 10 00:25:56 BST 2008java.util.concurrent

ConcurrentMap

public interface ConcurrentMap implements Map
A {@link java.util.Map} providing additional atomic putIfAbsent, remove, and replace methods.

Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into a {@code ConcurrentMap} as a key or value happen-before actions subsequent to the access or removal of that object from the {@code ConcurrentMap} in another thread.

This interface is a member of the Java Collections Framework.

since
1.5
author
Doug Lea
param
the type of keys maintained by this map
param
the type of mapped values

Fields Summary
Constructors Summary
Methods Summary
public VputIfAbsent(K key, V value)
If the specified key is not already associated with a value, associate it with the given value. This is equivalent to
if (!map.containsKey(key))
return map.put(key, value);
else
return map.get(key);
except that the action is performed atomically.

param
key key with which the specified value is to be associated
param
value value to be associated with the specified key
return
the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)
throws
UnsupportedOperationException if the put operation is not supported by this map
throws
ClassCastException if the class of the specified key or value prevents it from being stored in this map
throws
NullPointerException if the specified key or value is null, and this map does not permit null keys or values
throws
IllegalArgumentException if some property of the specified key or value prevents it from being stored in this map

public booleanremove(java.lang.Object key, java.lang.Object value)
Removes the entry for a key only if currently mapped to a given value. This is equivalent to
if (map.containsKey(key) && map.get(key).equals(value)) {
map.remove(key);
return true;
} else return false;
except that the action is performed atomically.

param
key key with which the specified value is associated
param
value value expected to be associated with the specified key
return
true if the value was removed
throws
UnsupportedOperationException if the remove operation is not supported by this map
throws
ClassCastException if the key or value is of an inappropriate type for this map (optional)
throws
NullPointerException if the specified key or value is null, and this map does not permit null keys or values (optional)

public booleanreplace(K key, V oldValue, V newValue)
Replaces the entry for a key only if currently mapped to a given value. This is equivalent to
if (map.containsKey(key) && map.get(key).equals(oldValue)) {
map.put(key, newValue);
return true;
} else return false;
except that the action is performed atomically.

param
key key with which the specified value is associated
param
oldValue value expected to be associated with the specified key
param
newValue value to be associated with the specified key
return
true if the value was replaced
throws
UnsupportedOperationException if the put operation is not supported by this map
throws
ClassCastException if the class of a specified key or value prevents it from being stored in this map
throws
NullPointerException if a specified key or value is null, and this map does not permit null keys or values
throws
IllegalArgumentException if some property of a specified key or value prevents it from being stored in this map

public Vreplace(K key, V value)
Replaces the entry for a key only if currently mapped to some value. This is equivalent to
if (map.containsKey(key)) {
return map.put(key, value);
} else return null;
except that the action is performed atomically.

param
key key with which the specified value is associated
param
value value to be associated with the specified key
return
the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)
throws
UnsupportedOperationException if the put operation is not supported by this map
throws
ClassCastException if the class of the specified key or value prevents it from being stored in this map
throws
NullPointerException if the specified key or value is null, and this map does not permit null keys or values
throws
IllegalArgumentException if some property of the specified key or value prevents it from being stored in this map