ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ConcurrentMap.java
Revision: 1.4
Committed: Tue Jun 24 14:34:47 2003 UTC (20 years, 11 months ago) by dl
Branch: MAIN
CVS Tags: JSR166_PRELIMINARY_TEST_RELEASE_2
Changes since 1.3: +4 -2 lines
Log Message:
Added missing javadoc tags; minor reformatting

File Contents

# User Rev Content
1 dl 1.2 /*
2     * Written by Doug Lea with assistance from members of JCP JSR-166
3     * Expert Group and released to the public domain. Use, modify, and
4     * redistribute this code in any way without acknowledgement.
5     */
6    
7 tim 1.1 package java.util.concurrent;
8     import java.util.Map;
9    
10     /**
11 dl 1.3 * A {@link java.util.Map} providing an additional atomic
12 tim 1.1 * <tt>putIfAbsent</tt> method.
13 dl 1.4 * @since 1.5
14     * @author Doug Lea
15     */
16 tim 1.1 public interface ConcurrentMap<K, V> extends Map<K, V> {
17     /**
18     * If the specified key is not already associated
19     * with a value, associate it with the given value.
20     * This is equivalent to
21     * <pre>
22     * if (!map.containsKey(key)) map.put(key, value);
23     * return get(key);
24     * </pre>
25     * Except that the action is performed atomically.
26     * @param key key with which the specified value is to be associated.
27     * @param value value to be associated with the specified key.
28     * @return previous value associated with specified key, or <tt>null</tt>
29     * if there was no mapping for key. A <tt>null</tt> return can
30     * also indicate that the map previously associated <tt>null</tt>
31     * with the specified key, if the implementation supports
32     * <tt>null</tt> values.
33     *
34     * @throws UnsupportedOperationException if the <tt>put</tt> operation is
35     * not supported by this map.
36     * @throws ClassCastException if the class of the specified key or value
37     * prevents it from being stored in this map.
38     * @throws IllegalArgumentException if some aspect of this key or value
39     * prevents it from being stored in this map.
40     * @throws NullPointerException this map does not permit <tt>null</tt>
41     * keys or values, and the specified key or value is
42     * <tt>null</tt>.
43     *
44     **/
45 dl 1.4 V putIfAbsent(K key, V value);
46 tim 1.1 }