ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ConcurrentHashMap.java
(Generate patch)

Comparing jsr166/src/main/java/util/concurrent/ConcurrentHashMap.java (file contents):
Revision 1.33 by dl, Sat Dec 6 00:16:20 2003 UTC vs.
Revision 1.81 by jsr166, Mon Aug 22 01:57:42 2005 UTC

# Line 1 | Line 1
1   /*
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.
3 > * Expert Group and released to the public domain, as explained at
4 > * http://creativecommons.org/licenses/publicdomain
5   */
6  
7   package java.util.concurrent;
# Line 33 | Line 33 | import java.io.ObjectOutputStream;
33   * removal of only some entries.  Similarly, Iterators and
34   * Enumerations return elements reflecting the state of the hash table
35   * at some point at or since the creation of the iterator/enumeration.
36 < * They do <em>not</em> throw
37 < * {@link ConcurrentModificationException}.  However, iterators are
38 < * designed to be used by only one thread at a time.
36 > * They do <em>not</em> throw {@link ConcurrentModificationException}.
37 > * However, iterators are designed to be used by only one thread at a time.
38   *
39   * <p> The allowed concurrency among update operations is guided by
40   * the optional <tt>concurrencyLevel</tt> constructor argument
41 < * (default 16), which is used as a hint for internal sizing.  The
41 > * (default <tt>16</tt>), which is used as a hint for internal sizing.  The
42   * table is internally partitioned to try to permit the indicated
43   * number of concurrent updates without contention. Because placement
44   * in hash tables is essentially random, the actual concurrency will
# Line 49 | Line 48 | import java.io.ObjectOutputStream;
48   * and a significantly lower value can lead to thread contention. But
49   * overestimates and underestimates within an order of magnitude do
50   * not usually have much noticeable impact. A value of one is
51 < * appropriate when it is known that only one thread will modify
52 < * and all others will only read.
51 > * appropriate when it is known that only one thread will modify and
52 > * all others will only read. Also, resizing this or any other kind of
53 > * hash table is a relatively slow operation, so, when possible, it is
54 > * a good idea to provide estimates of expected table sizes in
55 > * constructors.
56   *
57 < * <p>This class implements all of the <em>optional</em> methods
58 < * of the {@link Map} and {@link Iterator} interfaces.
57 > * <p>This class and its views and iterators implement all of the
58 > * <em>optional</em> methods of the {@link Map} and {@link Iterator}
59 > * interfaces.
60   *
61 < * <p> Like {@link java.util.Hashtable} but unlike {@link
62 < * java.util.HashMap}, this class does NOT allow <tt>null</tt> to be
63 < * used as a key or value.
61 > * <p> Like {@link Hashtable} but unlike {@link HashMap}, this class
62 > * does <em>not</em> allow <tt>null</tt> to be used as a key or value.
63 > *
64 > * <p>This class is a member of the
65 > * <a href="{@docRoot}/../guide/collections/index.html">
66 > * Java Collections Framework</a>.
67   *
68   * @since 1.5
69   * @author Doug Lea
70   * @param <K> the type of keys maintained by this map
71 < * @param <V> the type of mapped values
71 > * @param <V> the type of mapped values
72   */
73   public class ConcurrentHashMap<K, V> extends AbstractMap<K, V>
74 <        implements ConcurrentMap<K, V>, Cloneable, Serializable {
74 >        implements ConcurrentMap<K, V>, Serializable {
75      private static final long serialVersionUID = 7249069246763182397L;
76  
77      /*
# Line 76 | Line 82 | public class ConcurrentHashMap<K, V> ext
82      /* ---------------- Constants -------------- */
83  
84      /**
85 <     * The default initial number of table slots for this table.
86 <     * Used when not otherwise specified in constructor.
85 >     * The default initial capacity for this table,
86 >     * used when not otherwise specified in a constructor.
87 >     */
88 >    static final int DEFAULT_INITIAL_CAPACITY = 16;
89 >
90 >    /**
91 >     * The default load factor for this table, used when not
92 >     * otherwise specified in a constructor.
93 >     */
94 >    static final float DEFAULT_LOAD_FACTOR = 0.75f;
95 >
96 >    /**
97 >     * The default concurrency level for this table, used when not
98 >     * otherwise specified in a constructor.
99       */
100 <    private static int DEFAULT_INITIAL_CAPACITY = 16;
100 >    static final int DEFAULT_CONCURRENCY_LEVEL = 16;
101  
102      /**
103       * The maximum capacity, used if a higher value is implicitly
104       * specified by either of the constructors with arguments.  MUST
105 <     * be a power of two <= 1<<30 to ensure that entries are indexible
105 >     * be a power of two <= 1<<30 to ensure that entries are indexable
106       * using ints.
107       */
108 <    static final int MAXIMUM_CAPACITY = 1 << 30;
108 >    static final int MAXIMUM_CAPACITY = 1 << 30;
109  
110      /**
111 <     * The default load factor for this table.  Used when not
112 <     * otherwise specified in constructor.
111 >     * The maximum number of segments to allow; used to bound
112 >     * constructor arguments.
113       */
114 <    static final float DEFAULT_LOAD_FACTOR = 0.75f;
97 <
98 <    /**
99 <     * The default number of concurrency control segments.
100 <     **/
101 <    private static final int DEFAULT_SEGMENTS = 16;
114 >    static final int MAX_SEGMENTS = 1 << 16; // slightly conservative
115  
116      /**
117 <     * The maximum number of segments to allow; used to bound ctor arguments.
117 >     * Number of unsynchronized retries in size and containsValue
118 >     * methods before resorting to locking. This is used to avoid
119 >     * unbounded retries if tables undergo continuous modification
120 >     * which would make it impossible to obtain an accurate result.
121       */
122 <    private static final int MAX_SEGMENTS = 1 << 16; // slightly conservative
122 >    static final int RETRIES_BEFORE_LOCK = 2;
123  
124      /* ---------------- Fields -------------- */
125  
126      /**
127       * Mask value for indexing into segments. The upper bits of a
128       * key's hash code are used to choose the segment.
129 <     **/
130 <    private final int segmentMask;
129 >     */
130 >    final int segmentMask;
131  
132      /**
133       * Shift value for indexing within segments.
134 <     **/
135 <    private final int segmentShift;
134 >     */
135 >    final int segmentShift;
136  
137      /**
138       * The segments, each of which is a specialized hash table
139       */
140 <    private final Segment[] segments;
140 >    final Segment<K,V>[] segments;
141  
142 <    private transient Set<K> keySet;
143 <    private transient Set<Map.Entry<K,V>> entrySet;
144 <    private transient Collection<V> values;
142 >    transient Set<K> keySet;
143 >    transient Set<Map.Entry<K,V>> entrySet;
144 >    transient Collection<V> values;
145  
146      /* ---------------- Small Utilities -------------- */
147  
148      /**
149 <     * Return a hash code for non-null Object x.
150 <     * Uses the same hash code spreader as most other j.u hash tables.
149 >     * Returns a hash code for non-null Object x.
150 >     * Uses the same hash code spreader as most other java.util hash tables.
151       * @param x the object serving as a key
152       * @return the hash code
153       */
154 <    private static int hash(Object x) {
154 >    static int hash(Object x) {
155          int h = x.hashCode();
156          h += ~(h << 9);
157          h ^=  (h >>> 14);
# Line 145 | Line 161 | public class ConcurrentHashMap<K, V> ext
161      }
162  
163      /**
164 <     * Return the segment that should be used for key with given hash
164 >     * Returns the segment that should be used for key with given hash
165 >     * @param hash the hash code for the key
166 >     * @return the segment
167       */
168 <    private Segment<K,V> segmentFor(int hash) {
169 <        return (Segment<K,V>) segments[(hash >>> segmentShift) & segmentMask];
168 >    final Segment<K,V> segmentFor(int hash) {
169 >        return segments[(hash >>> segmentShift) & segmentMask];
170      }
171  
172      /* ---------------- Inner Classes -------------- */
173  
174      /**
175 +     * ConcurrentHashMap list entry. Note that this is never exported
176 +     * out as a user-visible Map.Entry.
177 +     *
178 +     * Because the value field is volatile, not final, it is legal wrt
179 +     * the Java Memory Model for an unsynchronized reader to see null
180 +     * instead of initial value when read via a data race.  Although a
181 +     * reordering leading to this is not likely to ever actually
182 +     * occur, the Segment.readValueUnderLock method is used as a
183 +     * backup in case a null (pre-initialized) value is ever seen in
184 +     * an unsynchronized access method.
185 +     */
186 +    static final class HashEntry<K,V> {
187 +        final K key;
188 +        final int hash;
189 +        volatile V value;
190 +        final HashEntry<K,V> next;
191 +
192 +        HashEntry(K key, int hash, HashEntry<K,V> next, V value) {
193 +            this.key = key;
194 +            this.hash = hash;
195 +            this.next = next;
196 +            this.value = value;
197 +        }
198 +
199 +        @SuppressWarnings("unchecked")
200 +        static final <K,V> HashEntry<K,V>[] newArray(int i) {
201 +            return new HashEntry[i];
202 +        }
203 +    }
204 +
205 +    /**
206       * Segments are specialized versions of hash tables.  This
207       * subclasses from ReentrantLock opportunistically, just to
208       * simplify some locking and avoid separate construction.
209 <     **/
210 <    private static final class Segment<K,V> extends ReentrantLock implements Serializable {
209 >     */
210 >    static final class Segment<K,V> extends ReentrantLock implements Serializable {
211          /*
212           * Segments maintain a table of entry lists that are ALWAYS
213           * kept in a consistent state, so can be read without locking.
# Line 171 | Line 220 | public class ConcurrentHashMap<K, V> ext
220           * is less than two for the default load factor threshold.)
221           *
222           * Read operations can thus proceed without locking, but rely
223 <         * on a memory barrier to ensure that completed write
224 <         * operations performed by other threads are
225 <         * noticed. Conveniently, the "count" field, tracking the
226 <         * number of elements, can also serve as the volatile variable
227 <         * providing proper read/write barriers. This is convenient
228 <         * because this field needs to be read in many read operations
180 <         * anyway.
181 <         *
182 <         * Implementors note. The basic rules for all this are:
223 >         * on selected uses of volatiles to ensure that completed
224 >         * write operations performed by other threads are
225 >         * noticed. For most purposes, the "count" field, tracking the
226 >         * number of elements, serves as that volatile variable
227 >         * ensuring visibility.  This is convenient because this field
228 >         * needs to be read in many read operations anyway:
229           *
230 <         *   - All unsynchronized read operations must first read the
230 >         *   - All (unsynchronized) read operations must first read the
231           *     "count" field, and should not look at table entries if
232           *     it is 0.
233           *
234 <         *   - All synchronized write operations should write to
235 <         *     the "count" field after updating. The operations must not
236 <         *     take any action that could even momentarily cause
237 <         *     a concurrent read operation to see inconsistent
238 <         *     data. This is made easier by the nature of the read
239 <         *     operations in Map. For example, no operation
234 >         *   - All (synchronized) write operations should write to
235 >         *     the "count" field after structurally changing any bin.
236 >         *     The operations must not take any action that could even
237 >         *     momentarily cause a concurrent read operation to see
238 >         *     inconsistent data. This is made easier by the nature of
239 >         *     the read operations in Map. For example, no operation
240           *     can reveal that the table has grown but the threshold
241           *     has not yet been updated, so there are no atomicity
242           *     requirements for this with respect to reads.
243           *
244 <         * As a guide, all critical volatile reads and writes are marked
245 <         * in code comments.
244 >         * As a guide, all critical volatile reads and writes to the
245 >         * count field are marked in code comments.
246           */
247  
248          private static final long serialVersionUID = 2249069246763182397L;
249  
250          /**
251           * The number of elements in this segment's region.
252 <         **/
252 >         */
253          transient volatile int count;
254  
255          /**
256 <         * Number of updates; used for checking lack of modifications
257 <         * in bulk-read methods.
256 >         * Number of updates that alter the size of the table. This is
257 >         * used during bulk-read methods to make sure they see a
258 >         * consistent snapshot: If modCounts change during a traversal
259 >         * of segments computing size or checking containsValue, then
260 >         * we might have an inconsistent view of state so (usually)
261 >         * must retry.
262           */
263          transient int modCount;
264  
265          /**
266           * The table is rehashed when its size exceeds this threshold.
267 <         * (The value of this field is always (int)(capacity *
268 <         * loadFactor).)
267 >         * (The value of this field is always <tt>(int)(capacity *
268 >         * loadFactor)</tt>.)
269           */
270 <        private transient int threshold;
270 >        transient int threshold;
271  
272          /**
273 <         * The per-segment table
273 >         * The per-segment table.
274           */
275 <        transient HashEntry[] table;
275 >        transient volatile HashEntry<K,V>[] table;
276  
277          /**
278           * The load factor for the hash table.  Even though this value
# Line 230 | Line 280 | public class ConcurrentHashMap<K, V> ext
280           * links to outer object.
281           * @serial
282           */
283 <        private final float loadFactor;
283 >        final float loadFactor;
284  
285          Segment(int initialCapacity, float lf) {
286              loadFactor = lf;
287 <            setTable(new HashEntry[initialCapacity]);
287 >            setTable(HashEntry.<K,V>newArray(initialCapacity));
288 >        }
289 >
290 >        @SuppressWarnings("unchecked")
291 >        static final <K,V> Segment<K,V>[] newArray(int i) {
292 >            return new Segment[i];
293          }
294  
295          /**
296 <         * Set table to new HashEntry array.
296 >         * Sets table to new HashEntry array.
297           * Call only while holding lock or in constructor.
298 <         **/
299 <        private void setTable(HashEntry[] newTable) {
245 <            table = newTable;
298 >         */
299 >        void setTable(HashEntry<K,V>[] newTable) {
300              threshold = (int)(newTable.length * loadFactor);
301 <            count = count; // write-volatile
301 >            table = newTable;
302 >        }
303 >
304 >        /**
305 >         * Returns properly casted first entry of bin for given hash.
306 >         */
307 >        HashEntry<K,V> getFirst(int hash) {
308 >            HashEntry<K,V>[] tab = table;
309 >            return tab[hash & (tab.length - 1)];
310 >        }
311 >
312 >        /**
313 >         * Reads value field of an entry under lock. Called if value
314 >         * field ever appears to be null. This is possible only if a
315 >         * compiler happens to reorder a HashEntry initialization with
316 >         * its table assignment, which is legal under memory model
317 >         * but is not known to ever occur.
318 >         */
319 >        V readValueUnderLock(HashEntry<K,V> e) {
320 >            lock();
321 >            try {
322 >                return e.value;
323 >            } finally {
324 >                unlock();
325 >            }
326          }
327  
328          /* Specialized implementations of map methods */
329  
330          V get(Object key, int hash) {
331              if (count != 0) { // read-volatile
332 <                HashEntry[] tab = table;
255 <                int index = hash & (tab.length - 1);
256 <                HashEntry<K,V> e = (HashEntry<K,V>) tab[index];
332 >                HashEntry<K,V> e = getFirst(hash);
333                  while (e != null) {
334 <                    if (e.hash == hash && key.equals(e.key))
335 <                        return e.value;
334 >                    if (e.hash == hash && key.equals(e.key)) {
335 >                        V v = e.value;
336 >                        if (v != null)
337 >                            return v;
338 >                        return readValueUnderLock(e); // recheck
339 >                    }
340                      e = e.next;
341                  }
342              }
# Line 265 | Line 345 | public class ConcurrentHashMap<K, V> ext
345  
346          boolean containsKey(Object key, int hash) {
347              if (count != 0) { // read-volatile
348 <                HashEntry[] tab = table;
269 <                int index = hash & (tab.length - 1);
270 <                HashEntry<K,V> e = (HashEntry<K,V>) tab[index];
348 >                HashEntry<K,V> e = getFirst(hash);
349                  while (e != null) {
350                      if (e.hash == hash && key.equals(e.key))
351                          return true;
# Line 279 | Line 357 | public class ConcurrentHashMap<K, V> ext
357  
358          boolean containsValue(Object value) {
359              if (count != 0) { // read-volatile
360 <                HashEntry[] tab = table;
360 >                HashEntry<K,V>[] tab = table;
361                  int len = tab.length;
362 <                for (int i = 0 ; i < len; i++)
363 <                    for (HashEntry<K,V> e = (HashEntry<K,V>)tab[i] ; e != null ; e = e.next)
364 <                        if (value.equals(e.value))
362 >                for (int i = 0 ; i < len; i++) {
363 >                    for (HashEntry<K,V> e = tab[i]; e != null; e = e.next) {
364 >                        V v = e.value;
365 >                        if (v == null) // recheck
366 >                            v = readValueUnderLock(e);
367 >                        if (value.equals(v))
368                              return true;
369 +                    }
370 +                }
371              }
372              return false;
373          }
# Line 292 | Line 375 | public class ConcurrentHashMap<K, V> ext
375          boolean replace(K key, int hash, V oldValue, V newValue) {
376              lock();
377              try {
378 <                int c = count;
379 <                HashEntry[] tab = table;
297 <                int index = hash & (tab.length - 1);
298 <                HashEntry<K,V> first = (HashEntry<K,V>) tab[index];
299 <                HashEntry<K,V> e = first;
300 <                for (;;) {
301 <                    if (e == null)
302 <                        return false;
303 <                    if (e.hash == hash && key.equals(e.key))
304 <                        break;
378 >                HashEntry<K,V> e = getFirst(hash);
379 >                while (e != null && (e.hash != hash || !key.equals(e.key)))
380                      e = e.next;
306                }
381  
382 <                V v = e.value;
383 <                if (v == null || !oldValue.equals(v))
384 <                    return false;
385 <
386 <                e.value = newValue;
387 <                count = c; // write-volatile
314 <                return true;
315 <                
382 >                boolean replaced = false;
383 >                if (e != null && oldValue.equals(e.value)) {
384 >                    replaced = true;
385 >                    e.value = newValue;
386 >                }
387 >                return replaced;
388              } finally {
389                  unlock();
390              }
# Line 321 | Line 393 | public class ConcurrentHashMap<K, V> ext
393          V replace(K key, int hash, V newValue) {
394              lock();
395              try {
396 <                int c = count;
397 <                HashEntry[] tab = table;
326 <                int index = hash & (tab.length - 1);
327 <                HashEntry<K,V> first = (HashEntry<K,V>) tab[index];
328 <                HashEntry<K,V> e = first;
329 <                for (;;) {
330 <                    if (e == null)
331 <                        return null;
332 <                    if (e.hash == hash && key.equals(e.key))
333 <                        break;
396 >                HashEntry<K,V> e = getFirst(hash);
397 >                while (e != null && (e.hash != hash || !key.equals(e.key)))
398                      e = e.next;
335                }
399  
400 <                V v = e.value;
401 <                e.value = newValue;
402 <                count = c; // write-volatile
403 <                return v;
404 <                
400 >                V oldValue = null;
401 >                if (e != null) {
402 >                    oldValue = e.value;
403 >                    e.value = newValue;
404 >                }
405 >                return oldValue;
406              } finally {
407                  unlock();
408              }
# Line 349 | Line 413 | public class ConcurrentHashMap<K, V> ext
413              lock();
414              try {
415                  int c = count;
416 <                HashEntry[] tab = table;
416 >                if (c++ > threshold) // ensure capacity
417 >                    rehash();
418 >                HashEntry<K,V>[] tab = table;
419                  int index = hash & (tab.length - 1);
420 <                HashEntry<K,V> first = (HashEntry<K,V>) tab[index];
420 >                HashEntry<K,V> first = tab[index];
421 >                HashEntry<K,V> e = first;
422 >                while (e != null && (e.hash != hash || !key.equals(e.key)))
423 >                    e = e.next;
424  
425 <                for (HashEntry<K,V> e = first; e != null; e = (HashEntry<K,V>) e.next) {
426 <                    if (e.hash == hash && key.equals(e.key)) {
427 <                        V oldValue = e.value;
428 <                        if (!onlyIfAbsent)
429 <                            e.value = value;
361 <                        ++modCount;
362 <                        count = c; // write-volatile
363 <                        return oldValue;
364 <                    }
425 >                V oldValue;
426 >                if (e != null) {
427 >                    oldValue = e.value;
428 >                    if (!onlyIfAbsent)
429 >                        e.value = value;
430                  }
431 <
432 <                tab[index] = new HashEntry<K,V>(hash, key, value, first);
433 <                ++modCount;
434 <                ++c;
435 <                count = c; // write-volatile
436 <                if (c > threshold)
437 <                    setTable(rehash(tab));
373 <                return null;
431 >                else {
432 >                    oldValue = null;
433 >                    ++modCount;
434 >                    tab[index] = new HashEntry<K,V>(key, hash, first, value);
435 >                    count = c; // write-volatile
436 >                }
437 >                return oldValue;
438              } finally {
439                  unlock();
440              }
441          }
442  
443 <        private HashEntry[] rehash(HashEntry[] oldTable) {
443 >        void rehash() {
444 >            HashEntry<K,V>[] oldTable = table;
445              int oldCapacity = oldTable.length;
446              if (oldCapacity >= MAXIMUM_CAPACITY)
447 <                return oldTable;
447 >                return;
448  
449              /*
450               * Reclassify nodes in each list to new Map.  Because we are
# Line 395 | Line 460 | public class ConcurrentHashMap<K, V> ext
460               * right now.
461               */
462  
463 <            HashEntry[] newTable = new HashEntry[oldCapacity << 1];
463 >            HashEntry<K,V>[] newTable = HashEntry.newArray(oldCapacity<<1);
464 >            threshold = (int)(newTable.length * loadFactor);
465              int sizeMask = newTable.length - 1;
466              for (int i = 0; i < oldCapacity ; i++) {
467                  // We need to guarantee that any existing reads of old Map can
468                  //  proceed. So we cannot yet null out each bin.
469 <                HashEntry<K,V> e = (HashEntry<K,V>)oldTable[i];
469 >                HashEntry<K,V> e = oldTable[i];
470  
471                  if (e != null) {
472                      HashEntry<K,V> next = e.next;
# Line 428 | Line 494 | public class ConcurrentHashMap<K, V> ext
494                          // Clone all remaining nodes
495                          for (HashEntry<K,V> p = e; p != lastRun; p = p.next) {
496                              int k = p.hash & sizeMask;
497 <                            newTable[k] = new HashEntry<K,V>(p.hash,
498 <                                                             p.key,
499 <                                                             p.value,
434 <                                                             (HashEntry<K,V>) newTable[k]);
497 >                            HashEntry<K,V> n = newTable[k];
498 >                            newTable[k] = new HashEntry<K,V>(p.key, p.hash,
499 >                                                             n, p.value);
500                          }
501                      }
502                  }
503              }
504 <            return newTable;
504 >            table = newTable;
505          }
506  
507          /**
# Line 445 | Line 510 | public class ConcurrentHashMap<K, V> ext
510          V remove(Object key, int hash, Object value) {
511              lock();
512              try {
513 <                int c = count;
514 <                HashEntry[] tab = table;
513 >                int c = count - 1;
514 >                HashEntry<K,V>[] tab = table;
515                  int index = hash & (tab.length - 1);
516 <                HashEntry<K,V> first = (HashEntry<K,V>)tab[index];
452 <
516 >                HashEntry<K,V> first = tab[index];
517                  HashEntry<K,V> e = first;
518 <                for (;;) {
455 <                    if (e == null)
456 <                        return null;
457 <                    if (e.hash == hash && key.equals(e.key))
458 <                        break;
518 >                while (e != null && (e.hash != hash || !key.equals(e.key)))
519                      e = e.next;
460                }
520  
521 <                V oldValue = e.value;
522 <                if (value != null && !value.equals(oldValue))
523 <                    return null;
524 <
525 <                // All entries following removed node can stay in list, but
526 <                // all preceding ones need to be cloned.
527 <                HashEntry<K,V> newFirst = e.next;
528 <                for (HashEntry<K,V> p = first; p != e; p = p.next)
529 <                    newFirst = new HashEntry<K,V>(p.hash, p.key,
530 <                                                  p.value, newFirst);
531 <                tab[index] = newFirst;
532 <                ++modCount;
533 <                count = c-1; // write-volatile
521 >                V oldValue = null;
522 >                if (e != null) {
523 >                    V v = e.value;
524 >                    if (value == null || value.equals(v)) {
525 >                        oldValue = v;
526 >                        // All entries following removed node can stay
527 >                        // in list, but all preceding ones need to be
528 >                        // cloned.
529 >                        ++modCount;
530 >                        HashEntry<K,V> newFirst = e.next;
531 >                        for (HashEntry<K,V> p = first; p != e; p = p.next)
532 >                            newFirst = new HashEntry<K,V>(p.key, p.hash,
533 >                                                          newFirst, p.value);
534 >                        tab[index] = newFirst;
535 >                        count = c; // write-volatile
536 >                    }
537 >                }
538                  return oldValue;
539              } finally {
540                  unlock();
# Line 479 | Line 542 | public class ConcurrentHashMap<K, V> ext
542          }
543  
544          void clear() {
545 <            lock();
546 <            try {
547 <                HashEntry[] tab = table;
548 <                for (int i = 0; i < tab.length ; i++)
549 <                    tab[i] = null;
550 <                ++modCount;
551 <                count = 0; // write-volatile
552 <            } finally {
553 <                unlock();
545 >            if (count != 0) {
546 >                lock();
547 >                try {
548 >                    HashEntry<K,V>[] tab = table;
549 >                    for (int i = 0; i < tab.length ; i++)
550 >                        tab[i] = null;
551 >                    ++modCount;
552 >                    count = 0; // write-volatile
553 >                } finally {
554 >                    unlock();
555 >                }
556              }
557          }
558      }
559  
495    /**
496     * ConcurrentHashMap list entry. Note that this is never exported
497     * out as a user-visible Map.Entry
498     */
499    private static class HashEntry<K,V> {
500        private final K key;
501        private V value;
502        private final int hash;
503        private final HashEntry<K,V> next;
504
505        HashEntry(int hash, K key, V value, HashEntry<K,V> next) {
506            this.value = value;
507            this.hash = hash;
508            this.key = key;
509            this.next = next;
510        }
511    }
560  
561  
562      /* ---------------- Public operations -------------- */
563  
564      /**
565 <     * Constructs a new, empty map with the specified initial
566 <     * capacity and the specified load factor.
565 >     * Creates a new, empty map with the specified initial
566 >     * capacity, load factor and concurrency level.
567       *
568       * @param initialCapacity the initial capacity. The implementation
569       * performs internal sizing to accommodate this many elements.
570       * @param loadFactor  the load factor threshold, used to control resizing.
571 +     * Resizing may be performed when the average number of elements per
572 +     * bin exceeds this threshold.
573       * @param concurrencyLevel the estimated number of concurrently
574       * updating threads. The implementation performs internal sizing
575 <     * to try to accommodate this many threads.  
575 >     * to try to accommodate this many threads.
576       * @throws IllegalArgumentException if the initial capacity is
577       * negative or the load factor or concurrencyLevel are
578       * nonpositive.
# Line 544 | Line 594 | public class ConcurrentHashMap<K, V> ext
594          }
595          segmentShift = 32 - sshift;
596          segmentMask = ssize - 1;
597 <        this.segments = new Segment[ssize];
597 >        this.segments = Segment.newArray(ssize);
598  
599          if (initialCapacity > MAXIMUM_CAPACITY)
600              initialCapacity = MAXIMUM_CAPACITY;
# Line 560 | Line 610 | public class ConcurrentHashMap<K, V> ext
610      }
611  
612      /**
613 <     * Constructs a new, empty map with the specified initial
614 <     * capacity,  and with default load factor and concurrencyLevel.
613 >     * Creates a new, empty map with the specified initial capacity
614 >     * and load factor and with the default concurrencyLevel (16).
615       *
616       * @param initialCapacity The implementation performs internal
617       * sizing to accommodate this many elements.
618 +     * @param loadFactor  the load factor threshold, used to control resizing.
619 +     * Resizing may be performed when the average number of elements per
620 +     * bin exceeds this threshold.
621 +     * @throws IllegalArgumentException if the initial capacity of
622 +     * elements is negative or the load factor is nonpositive
623 +     *
624 +     * @since 1.6
625 +     */
626 +    public ConcurrentHashMap(int initialCapacity, float loadFactor) {
627 +        this(initialCapacity, loadFactor, DEFAULT_CONCURRENCY_LEVEL);
628 +    }
629 +
630 +    /**
631 +     * Creates a new, empty map with the specified initial capacity,
632 +     * and with default load factor (0.75) and concurrencyLevel (16).
633 +     *
634 +     * @param initialCapacity the initial capacity. The implementation
635 +     * performs internal sizing to accommodate this many elements.
636       * @throws IllegalArgumentException if the initial capacity of
637       * elements is negative.
638       */
639      public ConcurrentHashMap(int initialCapacity) {
640 <        this(initialCapacity, DEFAULT_LOAD_FACTOR, DEFAULT_SEGMENTS);
640 >        this(initialCapacity, DEFAULT_LOAD_FACTOR, DEFAULT_CONCURRENCY_LEVEL);
641      }
642  
643      /**
644 <     * Constructs a new, empty map with a default initial capacity,
645 <     * load factor, and concurrencyLevel.
644 >     * Creates a new, empty map with a default initial capacity (16),
645 >     * load factor (0.75) and concurrencyLevel (16).
646       */
647      public ConcurrentHashMap() {
648 <        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR, DEFAULT_SEGMENTS);
648 >        this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR, DEFAULT_CONCURRENCY_LEVEL);
649      }
650  
651      /**
652 <     * Constructs a new map with the same mappings as the given map.  The
653 <     * map is created with a capacity of twice the number of mappings in
654 <     * the given map or 11 (whichever is greater), and a default load factor.
652 >     * Creates a new map with the same mappings as the given map.
653 >     * The map is created with a capacity of 1.5 times the number
654 >     * of mappings in the given map or 16 (whichever is greater),
655 >     * and a default load factor (0.75) and concurrencyLevel (16).
656 >     *
657 >     * @param m the map
658       */
659 <    public <A extends K, B extends V> ConcurrentHashMap(Map<A,B> t) {
660 <        this(Math.max((int) (t.size() / DEFAULT_LOAD_FACTOR) + 1,
661 <                      11),
662 <             DEFAULT_LOAD_FACTOR, DEFAULT_SEGMENTS);
663 <        putAll(t);
659 >    public ConcurrentHashMap(Map<? extends K, ? extends V> m) {
660 >        this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1,
661 >                      DEFAULT_INITIAL_CAPACITY),
662 >             DEFAULT_LOAD_FACTOR, DEFAULT_CONCURRENCY_LEVEL);
663 >        putAll(m);
664      }
665  
666 <    // inherit Map javadoc
666 >    /**
667 >     * Returns <tt>true</tt> if this map contains no key-value mappings.
668 >     *
669 >     * @return <tt>true</tt> if this map contains no key-value mappings
670 >     */
671      public boolean isEmpty() {
672 +        final Segment<K,V>[] segments = this.segments;
673          /*
674 <         * We need to keep track of per-segment modCounts to avoid ABA
674 >         * We keep track of per-segment modCounts to avoid ABA
675           * problems in which an element in one segment was added and
676           * in another removed during traversal, in which case the
677           * table was never actually empty at any point. Note the
# Line 608 | Line 684 | public class ConcurrentHashMap<K, V> ext
684          for (int i = 0; i < segments.length; ++i) {
685              if (segments[i].count != 0)
686                  return false;
687 <            else
687 >            else
688                  mcsum += mc[i] = segments[i].modCount;
689          }
690          // If mcsum happens to be zero, then we know we got a snapshot
# Line 617 | Line 693 | public class ConcurrentHashMap<K, V> ext
693          if (mcsum != 0) {
694              for (int i = 0; i < segments.length; ++i) {
695                  if (segments[i].count != 0 ||
696 <                    mc[i] != segments[i].modCount)
696 >                    mc[i] != segments[i].modCount)
697                      return false;
698              }
699          }
700          return true;
701      }
702  
703 <    // inherit Map javadoc
703 >    /**
704 >     * Returns the number of key-value mappings in this map.  If the
705 >     * map contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
706 >     * <tt>Integer.MAX_VALUE</tt>.
707 >     *
708 >     * @return the number of key-value mappings in this map
709 >     */
710      public int size() {
711 +        final Segment<K,V>[] segments = this.segments;
712 +        long sum = 0;
713 +        long check = 0;
714          int[] mc = new int[segments.length];
715 <        for (;;) {
716 <            long sum = 0;
715 >        // Try a few times to get accurate count. On failure due to
716 >        // continuous async changes in table, resort to locking.
717 >        for (int k = 0; k < RETRIES_BEFORE_LOCK; ++k) {
718 >            check = 0;
719 >            sum = 0;
720              int mcsum = 0;
721              for (int i = 0; i < segments.length; ++i) {
722                  sum += segments[i].count;
723                  mcsum += mc[i] = segments[i].modCount;
724              }
637            int check = 0;
725              if (mcsum != 0) {
726                  for (int i = 0; i < segments.length; ++i) {
727                      check += segments[i].count;
# Line 644 | Line 731 | public class ConcurrentHashMap<K, V> ext
731                      }
732                  }
733              }
734 <            if (check == sum) {
735 <                if (sum > Integer.MAX_VALUE)
649 <                    return Integer.MAX_VALUE;
650 <                else
651 <                    return (int)sum;
652 <            }
734 >            if (check == sum)
735 >                break;
736          }
737 +        if (check != sum) { // Resort to locking all segments
738 +            sum = 0;
739 +            for (int i = 0; i < segments.length; ++i)
740 +                segments[i].lock();
741 +            for (int i = 0; i < segments.length; ++i)
742 +                sum += segments[i].count;
743 +            for (int i = 0; i < segments.length; ++i)
744 +                segments[i].unlock();
745 +        }
746 +        if (sum > Integer.MAX_VALUE)
747 +            return Integer.MAX_VALUE;
748 +        else
749 +            return (int)sum;
750      }
751  
656
752      /**
753 <     * Returns the value to which the specified key is mapped in this table.
753 >     * Returns the value to which this map maps the specified key, or
754 >     * <tt>null</tt> if the map contains no mapping for the key.
755       *
756 <     * @param   key   a key in the table.
757 <     * @return  the value to which the key is mapped in this table;
758 <     *          <tt>null</tt> if the key is not mapped to any value in
759 <     *          this table.
664 <     * @throws  NullPointerException  if the key is
665 <     *               <tt>null</tt>.
756 >     * @param key key whose associated value is to be returned
757 >     * @return the value to which this map maps the specified key, or
758 >     *         <tt>null</tt> if the map contains no mapping for the key
759 >     * @throws NullPointerException if the specified key is null
760       */
761      public V get(Object key) {
762          int hash = hash(key); // throws NullPointerException if key null
# Line 672 | Line 766 | public class ConcurrentHashMap<K, V> ext
766      /**
767       * Tests if the specified object is a key in this table.
768       *
769 <     * @param   key   possible key.
770 <     * @return  <tt>true</tt> if and only if the specified object
771 <     *          is a key in this table, as determined by the
772 <     *          <tt>equals</tt> method; <tt>false</tt> otherwise.
773 <     * @throws  NullPointerException  if the key is
680 <     *               <tt>null</tt>.
769 >     * @param  key   possible key
770 >     * @return <tt>true</tt> if and only if the specified object
771 >     *         is a key in this table, as determined by the
772 >     *         <tt>equals</tt> method; <tt>false</tt> otherwise.
773 >     * @throws NullPointerException if the specified key is null
774       */
775      public boolean containsKey(Object key) {
776          int hash = hash(key); // throws NullPointerException if key null
# Line 690 | Line 783 | public class ConcurrentHashMap<K, V> ext
783       * traversal of the hash table, and so is much slower than
784       * method <tt>containsKey</tt>.
785       *
786 <     * @param value value whose presence in this map is to be tested.
786 >     * @param value value whose presence in this map is to be tested
787       * @return <tt>true</tt> if this map maps one or more keys to the
788 <     * specified value.
789 <     * @throws  NullPointerException  if the value is <tt>null</tt>.
788 >     *         specified value
789 >     * @throws NullPointerException if the specified value is null
790       */
791      public boolean containsValue(Object value) {
792          if (value == null)
793              throw new NullPointerException();
794  
795 +        // See explanation of modCount use above
796 +
797 +        final Segment<K,V>[] segments = this.segments;
798          int[] mc = new int[segments.length];
799 <        for (;;) {
799 >
800 >        // Try a few times without locking
801 >        for (int k = 0; k < RETRIES_BEFORE_LOCK; ++k) {
802              int sum = 0;
803              int mcsum = 0;
804              for (int i = 0; i < segments.length; ++i) {
# Line 722 | Line 820 | public class ConcurrentHashMap<K, V> ext
820              if (cleanSweep)
821                  return false;
822          }
823 +        // Resort to locking all segments
824 +        for (int i = 0; i < segments.length; ++i)
825 +            segments[i].lock();
826 +        boolean found = false;
827 +        try {
828 +            for (int i = 0; i < segments.length; ++i) {
829 +                if (segments[i].containsValue(value)) {
830 +                    found = true;
831 +                    break;
832 +                }
833 +            }
834 +        } finally {
835 +            for (int i = 0; i < segments.length; ++i)
836 +                segments[i].unlock();
837 +        }
838 +        return found;
839      }
840  
841      /**
842       * Legacy method testing if some key maps into the specified value
843       * in this table.  This method is identical in functionality to
844 <     * {@link #containsValue}, and  exists solely to ensure
844 >     * {@link #containsValue}, and exists solely to ensure
845       * full compatibility with class {@link java.util.Hashtable},
846       * which supported this method prior to introduction of the
847       * Java Collections framework.
848  
849 <     * @param      value   a value to search for.
850 <     * @return     <tt>true</tt> if and only if some key maps to the
851 <     *             <tt>value</tt> argument in this table as
852 <     *             determined by the <tt>equals</tt> method;
853 <     *             <tt>false</tt> otherwise.
854 <     * @throws  NullPointerException  if the value is <tt>null</tt>.
849 >     * @param  value a value to search for
850 >     * @return <tt>true</tt> if and only if some key maps to the
851 >     *         <tt>value</tt> argument in this table as
852 >     *         determined by the <tt>equals</tt> method;
853 >     *         <tt>false</tt> otherwise
854 >     * @throws NullPointerException if the specified value is null
855       */
856      public boolean contains(Object value) {
857          return containsValue(value);
858      }
859  
860      /**
861 <     * Maps the specified <tt>key</tt> to the specified
862 <     * <tt>value</tt> in this table. Neither the key nor the
749 <     * value can be <tt>null</tt>. <p>
861 >     * Maps the specified key to the specified value in this table.
862 >     * Neither the key nor the value can be null.
863       *
864 <     * The value can be retrieved by calling the <tt>get</tt> method
864 >     * <p> The value can be retrieved by calling the <tt>get</tt> method
865       * with a key that is equal to the original key.
866       *
867 <     * @param      key     the table key.
868 <     * @param      value   the value.
869 <     * @return     the previous value of the specified key in this table,
870 <     *             or <tt>null</tt> if it did not have one.
871 <     * @throws  NullPointerException  if the key or value is
759 <     *               <tt>null</tt>.
867 >     * @param key key with which the specified value is to be associated
868 >     * @param value value to be associated with the specified key
869 >     * @return the previous value associated with <tt>key</tt>, or
870 >     *         <tt>null</tt> if there was no mapping for <tt>key</tt>
871 >     * @throws NullPointerException if the specified key or value is null
872       */
873      public V put(K key, V value) {
874          if (value == null)
# Line 766 | Line 878 | public class ConcurrentHashMap<K, V> ext
878      }
879  
880      /**
881 <     * If the specified key is not already associated
770 <     * with a value, associate it with the given value.
771 <     * This is equivalent to
772 <     * <pre>
773 <     *   if (!map.containsKey(key))
774 <     *      return map.put(key, value);
775 <     *   else
776 <     *      return map.get(key);
777 <     * </pre>
778 <     * Except that the action is performed atomically.
779 <     * @param key key with which the specified value is to be associated.
780 <     * @param value value to be associated with the specified key.
781 <     * @return previous value associated with specified key, or <tt>null</tt>
782 <     *         if there was no mapping for key.  A <tt>null</tt> return can
783 <     *         also indicate that the map previously associated <tt>null</tt>
784 <     *         with the specified key, if the implementation supports
785 <     *         <tt>null</tt> values.
786 <     *
787 <     * @throws UnsupportedOperationException if the <tt>put</tt> operation is
788 <     *            not supported by this map.
789 <     * @throws ClassCastException if the class of the specified key or value
790 <     *            prevents it from being stored in this map.
791 <     * @throws NullPointerException if the specified key or value is
792 <     *            <tt>null</tt>.
881 >     * {@inheritDoc}
882       *
883 <     **/
883 >     * @return the previous value associated with the specified key,
884 >     *         or <tt>null</tt> if there was no mapping for the key
885 >     * @throws NullPointerException if the specified key or value is null
886 >     */
887      public V putIfAbsent(K key, V value) {
888          if (value == null)
889              throw new NullPointerException();
# Line 799 | Line 891 | public class ConcurrentHashMap<K, V> ext
891          return segmentFor(hash).put(key, hash, value, true);
892      }
893  
802
894      /**
895       * Copies all of the mappings from the specified map to this one.
805     *
896       * These mappings replace any mappings that this map had for any of the
897 <     * keys currently in the specified Map.
897 >     * keys currently in the specified map.
898       *
899 <     * @param t Mappings to be stored in this map.
899 >     * @param m mappings to be stored in this map
900       */
901 <    public void putAll(Map<? extends K, ? extends V> t) {
902 <        for (Iterator<Map.Entry<? extends K, ? extends V>> it = (Iterator<Map.Entry<? extends K, ? extends V>>) t.entrySet().iterator(); it.hasNext(); ) {
901 >    public void putAll(Map<? extends K, ? extends V> m) {
902 >        for (Iterator<? extends Map.Entry<? extends K, ? extends V>> it = (Iterator<? extends Map.Entry<? extends K, ? extends V>>) m.entrySet().iterator(); it.hasNext(); ) {
903              Entry<? extends K, ? extends V> e = it.next();
904              put(e.getKey(), e.getValue());
905          }
906      }
907  
908      /**
909 <     * Removes the key (and its corresponding value) from this
910 <     * table. This method does nothing if the key is not in the table.
909 >     * Removes the key (and its corresponding value) from this map.
910 >     * This method does nothing if the key is not in the map.
911       *
912 <     * @param   key   the key that needs to be removed.
913 <     * @return  the value to which the key had been mapped in this table,
914 <     *          or <tt>null</tt> if the key did not have a mapping.
915 <     * @throws  NullPointerException  if the key is
826 <     *               <tt>null</tt>.
912 >     * @param  key the key that needs to be removed
913 >     * @return the previous value associated with <tt>key</tt>, or
914 >     *         <tt>null</tt> if there was no mapping for <tt>key</tt>.
915 >     * @throws NullPointerException if the specified key is null
916       */
917      public V remove(Object key) {
918          int hash = hash(key);
# Line 831 | Line 920 | public class ConcurrentHashMap<K, V> ext
920      }
921  
922      /**
923 <     * Remove entry for key only if currently mapped to given value.
924 <     * Acts as
925 <     * <pre>
837 <     *  if (map.get(key).equals(value)) {
838 <     *     map.remove(key);
839 <     *     return true;
840 <     * } else return false;
841 <     * </pre>
842 <     * except that the action is performed atomically.
843 <     * @param key key with which the specified value is associated.
844 <     * @param value value associated with the specified key.
845 <     * @return true if the value was removed
846 <     * @throws NullPointerException if the specified key is
847 <     *            <tt>null</tt>.
923 >     * {@inheritDoc}
924 >     *
925 >     * @throws NullPointerException if the specified key is null
926       */
927      public boolean remove(Object key, Object value) {
928 +        if (value == null)
929 +            return false;
930          int hash = hash(key);
931          return segmentFor(hash).remove(key, hash, value) != null;
932      }
933  
854
934      /**
935 <     * Replace entry for key only if currently mapped to given value.
936 <     * Acts as
937 <     * <pre>
859 <     *  if (map.get(key).equals(oldValue)) {
860 <     *     map.put(key, newValue);
861 <     *     return true;
862 <     * } else return false;
863 <     * </pre>
864 <     * except that the action is performed atomically.
865 <     * @param key key with which the specified value is associated.
866 <     * @param oldValue value expected to be associated with the specified key.
867 <     * @param newValue value to be associated with the specified key.
868 <     * @return true if the value was replaced
869 <     * @throws NullPointerException if the specified key or values are
870 <     * <tt>null</tt>.
935 >     * {@inheritDoc}
936 >     *
937 >     * @throws NullPointerException if any of the arguments are null
938       */
939      public boolean replace(K key, V oldValue, V newValue) {
940          if (oldValue == null || newValue == null)
# Line 877 | Line 944 | public class ConcurrentHashMap<K, V> ext
944      }
945  
946      /**
947 <     * Replace entry for key only if currently mapped to some value.
948 <     * Acts as
949 <     * <pre>
950 <     *  if ((map.containsKey(key)) {
951 <     *     return map.put(key, value);
885 <     * } else return null;
886 <     * </pre>
887 <     * except that the action is performed atomically.
888 <     * @param key key with which the specified value is associated.
889 <     * @param value value to be associated with the specified key.
890 <     * @return previous value associated with specified key, or <tt>null</tt>
891 <     *         if there was no mapping for key.  
892 <     * @throws NullPointerException if the specified key or value is
893 <     *            <tt>null</tt>.
947 >     * {@inheritDoc}
948 >     *
949 >     * @return the previous value associated with the specified key,
950 >     *         or <tt>null</tt> if there was no mapping for the key
951 >     * @throws NullPointerException if the specified key or value is null
952       */
953      public V replace(K key, V value) {
954          if (value == null)
# Line 899 | Line 957 | public class ConcurrentHashMap<K, V> ext
957          return segmentFor(hash).replace(key, hash, value);
958      }
959  
902
960      /**
961 <     * Removes all mappings from this map.
961 >     * Removes all of the mappings from this map.
962       */
963      public void clear() {
964          for (int i = 0; i < segments.length; ++i)
965              segments[i].clear();
966      }
967  
911
912    /**
913     * Returns a shallow copy of this
914     * <tt>ConcurrentHashMap</tt> instance: the keys and
915     * values themselves are not cloned.
916     *
917     * @return a shallow copy of this map.
918     */
919    public Object clone() {
920        // We cannot call super.clone, since it would share final
921        // segments array, and there's no way to reassign finals.
922
923        float lf = segments[0].loadFactor;
924        int segs = segments.length;
925        int cap = (int)(size() / lf);
926        if (cap < segs) cap = segs;
927        ConcurrentHashMap<K,V> t = new ConcurrentHashMap<K,V>(cap, lf, segs);
928        t.putAll(this);
929        return t;
930    }
931
968      /**
969 <     * Returns a set view of the keys contained in this map.  The set is
970 <     * backed by the map, so changes to the map are reflected in the set, and
971 <     * vice-versa.  The set supports element removal, which removes the
972 <     * corresponding mapping from this map, via the <tt>Iterator.remove</tt>,
973 <     * <tt>Set.remove</tt>, <tt>removeAll</tt>, <tt>retainAll</tt>, and
974 <     * <tt>clear</tt> operations.  It does not support the <tt>add</tt> or
969 >     * Returns a {@link Set} view of the keys contained in this map.
970 >     * The set is backed by the map, so changes to the map are
971 >     * reflected in the set, and vice-versa.  The set supports element
972 >     * removal, which removes the corresponding mapping from this map,
973 >     * via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
974 >     * <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt>
975 >     * operations.  It does not support the <tt>add</tt> or
976       * <tt>addAll</tt> operations.
977 <     * The returned <tt>iterator</tt> is a "weakly consistent" iterator that
978 <     * will never throw {@link java.util.ConcurrentModificationException},
977 >     *
978 >     * <p>The view's <tt>iterator</tt> is a "weakly consistent" iterator
979 >     * that will never throw {@link ConcurrentModificationException},
980       * and guarantees to traverse elements as they existed upon
981       * construction of the iterator, and may (but is not guaranteed to)
982       * reflect any modifications subsequent to construction.
945     *
946     * @return a set view of the keys contained in this map.
983       */
984      public Set<K> keySet() {
985          Set<K> ks = keySet;
986          return (ks != null) ? ks : (keySet = new KeySet());
987      }
988  
953
989      /**
990 <     * Returns a collection view of the values contained in this map.  The
991 <     * collection is backed by the map, so changes to the map are reflected in
992 <     * the collection, and vice-versa.  The collection supports element
993 <     * removal, which removes the corresponding mapping from this map, via the
994 <     * <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
995 <     * <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt> operations.
996 <     * It does not support the <tt>add</tt> or <tt>addAll</tt> operations.
997 <     * The returned <tt>iterator</tt> is a "weakly consistent" iterator that
998 <     * will never throw {@link java.util.ConcurrentModificationException},
990 >     * Returns a {@link Collection} view of the values contained in this map.
991 >     * The collection is backed by the map, so changes to the map are
992 >     * reflected in the collection, and vice-versa.  The collection
993 >     * supports element removal, which removes the corresponding
994 >     * mapping from this map, via the <tt>Iterator.remove</tt>,
995 >     * <tt>Collection.remove</tt>, <tt>removeAll</tt>,
996 >     * <tt>retainAll</tt>, and <tt>clear</tt> operations.  It does not
997 >     * support the <tt>add</tt> or <tt>addAll</tt> operations.
998 >     *
999 >     * <p>The view's <tt>iterator</tt> is a "weakly consistent" iterator
1000 >     * that will never throw {@link ConcurrentModificationException},
1001       * and guarantees to traverse elements as they existed upon
1002       * construction of the iterator, and may (but is not guaranteed to)
1003       * reflect any modifications subsequent to construction.
967     *
968     * @return a collection view of the values contained in this map.
1004       */
1005      public Collection<V> values() {
1006          Collection<V> vs = values;
1007          return (vs != null) ? vs : (values = new Values());
1008      }
1009  
975
1010      /**
1011 <     * Returns a collection view of the mappings contained in this map.  Each
1012 <     * element in the returned collection is a <tt>Map.Entry</tt>.  The
1013 <     * collection is backed by the map, so changes to the map are reflected in
1014 <     * the collection, and vice-versa.  The collection supports element
1015 <     * removal, which removes the corresponding mapping from the map, via the
1016 <     * <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>,
1017 <     * <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt> operations.
1018 <     * It does not support the <tt>add</tt> or <tt>addAll</tt> operations.
1019 <     * The returned <tt>iterator</tt> is a "weakly consistent" iterator that
1020 <     * will never throw {@link java.util.ConcurrentModificationException},
1011 >     * Returns a {@link Set} view of the mappings contained in this map.
1012 >     * The set is backed by the map, so changes to the map are
1013 >     * reflected in the set, and vice-versa.  The set supports element
1014 >     * removal, which removes the corresponding mapping from the map,
1015 >     * via the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>,
1016 >     * <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt>
1017 >     * operations.  It does not support the <tt>add</tt> or
1018 >     * <tt>addAll</tt> operations.
1019 >     *
1020 >     * <p>The view's <tt>iterator</tt> is a "weakly consistent" iterator
1021 >     * that will never throw {@link ConcurrentModificationException},
1022       * and guarantees to traverse elements as they existed upon
1023       * construction of the iterator, and may (but is not guaranteed to)
1024       * reflect any modifications subsequent to construction.
990     *
991     * @return a collection view of the mappings contained in this map.
1025       */
1026      public Set<Map.Entry<K,V>> entrySet() {
1027          Set<Map.Entry<K,V>> es = entrySet;
1028 <        return (es != null) ? es : (entrySet = (Set<Map.Entry<K,V>>) (Set) new EntrySet());
1028 >        return (es != null) ? es : (entrySet = new EntrySet());
1029      }
1030  
998
1031      /**
1032       * Returns an enumeration of the keys in this table.
1033       *
1034 <     * @return  an enumeration of the keys in this table.
1035 <     * @see     #keySet
1034 >     * @return an enumeration of the keys in this table
1035 >     * @see #keySet
1036       */
1037      public Enumeration<K> keys() {
1038          return new KeyIterator();
# Line 1008 | Line 1040 | public class ConcurrentHashMap<K, V> ext
1040  
1041      /**
1042       * Returns an enumeration of the values in this table.
1011     * Use the Enumeration methods on the returned object to fetch the elements
1012     * sequentially.
1043       *
1044 <     * @return  an enumeration of the values in this table.
1045 <     * @see     #values
1044 >     * @return an enumeration of the values in this table
1045 >     * @see #values
1046       */
1047      public Enumeration<V> elements() {
1048          return new ValueIterator();
# Line 1020 | Line 1050 | public class ConcurrentHashMap<K, V> ext
1050  
1051      /* ---------------- Iterator Support -------------- */
1052  
1053 <    private abstract class HashIterator {
1054 <        private int nextSegmentIndex;
1055 <        private int nextTableIndex;
1056 <        private HashEntry[] currentTable;
1057 <        private HashEntry<K, V> nextEntry;
1053 >    class HashIterator {
1054 >        int nextSegmentIndex;
1055 >        int nextTableIndex;
1056 >        HashEntry<K,V>[] currentTable;
1057 >        HashEntry<K, V> nextEntry;
1058          HashEntry<K, V> lastReturned;
1059  
1060 <        private HashIterator() {
1060 >        HashIterator() {
1061              nextSegmentIndex = segments.length - 1;
1062              nextTableIndex = -1;
1063              advance();
# Line 1035 | Line 1065 | public class ConcurrentHashMap<K, V> ext
1065  
1066          public boolean hasMoreElements() { return hasNext(); }
1067  
1068 <        private void advance() {
1068 >        final void advance() {
1069              if (nextEntry != null && (nextEntry = nextEntry.next) != null)
1070                  return;
1071  
1072              while (nextTableIndex >= 0) {
1073 <                if ( (nextEntry = (HashEntry<K,V>)currentTable[nextTableIndex--]) != null)
1073 >                if ( (nextEntry = currentTable[nextTableIndex--]) != null)
1074                      return;
1075              }
1076  
1077              while (nextSegmentIndex >= 0) {
1078 <                Segment<K,V> seg = (Segment<K,V>)segments[nextSegmentIndex--];
1078 >                Segment<K,V> seg = segments[nextSegmentIndex--];
1079                  if (seg.count != 0) {
1080                      currentTable = seg.table;
1081                      for (int j = currentTable.length - 1; j >= 0; --j) {
1082 <                        if ( (nextEntry = (HashEntry<K,V>)currentTable[j]) != null) {
1082 >                        if ( (nextEntry = currentTable[j]) != null) {
1083                              nextTableIndex = j - 1;
1084                              return;
1085                          }
# Line 1076 | Line 1106 | public class ConcurrentHashMap<K, V> ext
1106          }
1107      }
1108  
1109 <    private class KeyIterator extends HashIterator implements Iterator<K>, Enumeration<K> {
1109 >    final class KeyIterator extends HashIterator implements Iterator<K>, Enumeration<K> {
1110          public K next() { return super.nextEntry().key; }
1111          public K nextElement() { return super.nextEntry().key; }
1112      }
1113  
1114 <    private class ValueIterator extends HashIterator implements Iterator<V>, Enumeration<V> {
1114 >    final class ValueIterator extends HashIterator implements Iterator<V>, Enumeration<V> {
1115          public V next() { return super.nextEntry().value; }
1116          public V nextElement() { return super.nextEntry().value; }
1117      }
1118  
1089    
1119  
1120      /**
1121 <     * Exported Entry objects must write-through changes in setValue,
1122 <     * even if the nodes have been cloned. So we cannot return
1094 <     * internal HashEntry objects. Instead, the iterator itself acts
1095 <     * as a forwarding pseudo-entry.
1121 >     * Custom Entry class used by EntryIterator.next(), that relays
1122 >     * setValue changes to the underlying map.
1123       */
1124 <    private class EntryIterator extends HashIterator implements Map.Entry<K,V>, Iterator<Entry<K,V>> {
1125 <        public Map.Entry<K,V> next() {
1126 <            nextEntry();
1127 <            return this;
1128 <        }
1129 <
1130 <        public K getKey() {
1104 <            if (lastReturned == null)
1105 <                throw new IllegalStateException("Entry was removed");
1106 <            return lastReturned.key;
1124 >    static final class WriteThroughEntry<K,V>
1125 >        extends AbstractMap.SimpleEntry<K,V>
1126 >    {
1127 >        private final ConcurrentHashMap<K,V> map;
1128 >        WriteThroughEntry(ConcurrentHashMap map, K k, V v) {
1129 >            super(k,v);
1130 >            this.map = map;
1131          }
1132  
1133 <        public V getValue() {
1134 <            if (lastReturned == null)
1135 <                throw new IllegalStateException("Entry was removed");
1136 <            return ConcurrentHashMap.this.get(lastReturned.key);
1137 <        }
1138 <
1139 <        public V setValue(V value) {
1140 <            if (lastReturned == null)
1141 <                throw new IllegalStateException("Entry was removed");
1142 <            return ConcurrentHashMap.this.put(lastReturned.key, value);
1143 <        }
1144 <
1145 <        public boolean equals(Object o) {
1146 <            if (!(o instanceof Map.Entry))
1123 <                return false;
1124 <            Map.Entry e = (Map.Entry)o;
1125 <            return eq(getKey(), e.getKey()) && eq(getValue(), e.getValue());
1126 <        }
1127 <
1128 <        public int hashCode() {
1129 <            Object k = getKey();
1130 <            Object v = getValue();
1131 <            return ((k == null) ? 0 : k.hashCode()) ^
1132 <                   ((v == null) ? 0 : v.hashCode());
1133 <        }
1134 <
1135 <        public String toString() {
1136 <            return getKey() + "=" + getValue();
1133 >        /**
1134 >         * Set our entry's value and write through to the map. The
1135 >         * value to return is somewhat arbitrary here. Since a
1136 >         * WriteThroughEntry does not necessarily track asynchronous
1137 >         * changes, the most recent "previous" value could be
1138 >         * different from what we return (or could even have been
1139 >         * removed in which case the put will re-establish). We do not
1140 >         * and cannot guarantee more.
1141 >         */
1142 >        public V setValue(V value) {
1143 >            if (value == null) throw new NullPointerException();
1144 >            V v = super.setValue(value);
1145 >            map.put(getKey(), value);
1146 >            return v;
1147          }
1148 +    }
1149  
1150 <        private boolean eq(Object o1, Object o2) {
1151 <            return (o1 == null ? o2 == null : o1.equals(o2));
1150 >    final class EntryIterator extends HashIterator implements Iterator<Entry<K,V>> {
1151 >        public Map.Entry<K,V> next() {
1152 >            HashEntry<K,V> e = super.nextEntry();
1153 >            return new WriteThroughEntry<K,V>(ConcurrentHashMap.this,
1154 >                                              e.key, e.value);
1155          }
1142
1156      }
1157  
1158 <    private class KeySet extends AbstractSet<K> {
1158 >    final class KeySet extends AbstractSet<K> {
1159          public Iterator<K> iterator() {
1160              return new KeyIterator();
1161          }
# Line 1158 | Line 1171 | public class ConcurrentHashMap<K, V> ext
1171          public void clear() {
1172              ConcurrentHashMap.this.clear();
1173          }
1174 +        public Object[] toArray() {
1175 +            Collection<K> c = new ArrayList<K>();
1176 +            for (Iterator<K> i = iterator(); i.hasNext(); )
1177 +                c.add(i.next());
1178 +            return c.toArray();
1179 +        }
1180 +        public <T> T[] toArray(T[] a) {
1181 +            Collection<K> c = new ArrayList<K>();
1182 +            for (Iterator<K> i = iterator(); i.hasNext(); )
1183 +                c.add(i.next());
1184 +            return c.toArray(a);
1185 +        }
1186      }
1187  
1188 <    private class Values extends AbstractCollection<V> {
1188 >    final class Values extends AbstractCollection<V> {
1189          public Iterator<V> iterator() {
1190              return new ValueIterator();
1191          }
# Line 1173 | Line 1198 | public class ConcurrentHashMap<K, V> ext
1198          public void clear() {
1199              ConcurrentHashMap.this.clear();
1200          }
1201 +        public Object[] toArray() {
1202 +            Collection<V> c = new ArrayList<V>();
1203 +            for (Iterator<V> i = iterator(); i.hasNext(); )
1204 +                c.add(i.next());
1205 +            return c.toArray();
1206 +        }
1207 +        public <T> T[] toArray(T[] a) {
1208 +            Collection<V> c = new ArrayList<V>();
1209 +            for (Iterator<V> i = iterator(); i.hasNext(); )
1210 +                c.add(i.next());
1211 +            return c.toArray(a);
1212 +        }
1213      }
1214  
1215 <    private class EntrySet extends AbstractSet<Map.Entry<K,V>> {
1215 >    final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
1216          public Iterator<Map.Entry<K,V>> iterator() {
1217              return new EntryIterator();
1218          }
1219          public boolean contains(Object o) {
1220              if (!(o instanceof Map.Entry))
1221                  return false;
1222 <            Map.Entry<K,V> e = (Map.Entry<K,V>)o;
1222 >            Map.Entry<?,?> e = (Map.Entry<?,?>)o;
1223              V v = ConcurrentHashMap.this.get(e.getKey());
1224              return v != null && v.equals(e.getValue());
1225          }
1226          public boolean remove(Object o) {
1227              if (!(o instanceof Map.Entry))
1228                  return false;
1229 <            Map.Entry<K,V> e = (Map.Entry<K,V>)o;
1229 >            Map.Entry<?,?> e = (Map.Entry<?,?>)o;
1230              return ConcurrentHashMap.this.remove(e.getKey(), e.getValue());
1231          }
1232          public int size() {
# Line 1199 | Line 1236 | public class ConcurrentHashMap<K, V> ext
1236              ConcurrentHashMap.this.clear();
1237          }
1238          public Object[] toArray() {
1202            // Since we don't ordinarily have distinct Entry objects, we
1203            // must pack elements using exportable SimpleEntry
1239              Collection<Map.Entry<K,V>> c = new ArrayList<Map.Entry<K,V>>(size());
1240              for (Iterator<Map.Entry<K,V>> i = iterator(); i.hasNext(); )
1241 <                c.add(new SimpleEntry<K,V>(i.next()));
1241 >                c.add(i.next());
1242              return c.toArray();
1243          }
1244          public <T> T[] toArray(T[] a) {
1245              Collection<Map.Entry<K,V>> c = new ArrayList<Map.Entry<K,V>>(size());
1246              for (Iterator<Map.Entry<K,V>> i = iterator(); i.hasNext(); )
1247 <                c.add(new SimpleEntry<K,V>(i.next()));
1247 >                c.add(i.next());
1248              return c.toArray(a);
1249          }
1215
1216    }
1217
1218    /**
1219     * This duplicates java.util.AbstractMap.SimpleEntry until this class
1220     * is made accessible.
1221     */
1222    static class SimpleEntry<K,V> implements Entry<K,V> {
1223        K key;
1224        V value;
1225
1226        public SimpleEntry(K key, V value) {
1227            this.key   = key;
1228            this.value = value;
1229        }
1230
1231        public SimpleEntry(Entry<K,V> e) {
1232            this.key   = e.getKey();
1233            this.value = e.getValue();
1234        }
1235
1236        public K getKey() {
1237            return key;
1238        }
1239
1240        public V getValue() {
1241            return value;
1242        }
1243
1244        public V setValue(V value) {
1245            V oldValue = this.value;
1246            this.value = value;
1247            return oldValue;
1248        }
1249
1250        public boolean equals(Object o) {
1251            if (!(o instanceof Map.Entry))
1252                return false;
1253            Map.Entry e = (Map.Entry)o;
1254            return eq(key, e.getKey()) && eq(value, e.getValue());
1255        }
1256
1257        public int hashCode() {
1258            return ((key   == null)   ? 0 :   key.hashCode()) ^
1259                   ((value == null)   ? 0 : value.hashCode());
1260        }
1261
1262        public String toString() {
1263            return key + "=" + value;
1264        }
1265
1266        private static boolean eq(Object o1, Object o2) {
1267            return (o1 == null ? o2 == null : o1.equals(o2));
1268        }
1250      }
1251  
1252      /* ---------------- Serialization Support -------------- */
1253  
1254      /**
1255 <     * Save the state of the <tt>ConcurrentHashMap</tt>
1256 <     * instance to a stream (i.e.,
1276 <     * serialize it).
1255 >     * Save the state of the <tt>ConcurrentHashMap</tt> instance to a
1256 >     * stream (i.e., serialize it).
1257       * @param s the stream
1258       * @serialData
1259       * the key (Object) and value (Object)
# Line 1284 | Line 1264 | public class ConcurrentHashMap<K, V> ext
1264          s.defaultWriteObject();
1265  
1266          for (int k = 0; k < segments.length; ++k) {
1267 <            Segment<K,V> seg = (Segment<K,V>)segments[k];
1267 >            Segment<K,V> seg = segments[k];
1268              seg.lock();
1269              try {
1270 <                HashEntry[] tab = seg.table;
1270 >                HashEntry<K,V>[] tab = seg.table;
1271                  for (int i = 0; i < tab.length; ++i) {
1272 <                    for (HashEntry<K,V> e = (HashEntry<K,V>)tab[i]; e != null; e = e.next) {
1272 >                    for (HashEntry<K,V> e = tab[i]; e != null; e = e.next) {
1273                          s.writeObject(e.key);
1274                          s.writeObject(e.value);
1275                      }
# Line 1303 | Line 1283 | public class ConcurrentHashMap<K, V> ext
1283      }
1284  
1285      /**
1286 <     * Reconstitute the <tt>ConcurrentHashMap</tt>
1287 <     * instance from a stream (i.e.,
1308 <     * deserialize it).
1286 >     * Reconstitute the <tt>ConcurrentHashMap</tt> instance from a
1287 >     * stream (i.e., deserialize it).
1288       * @param s the stream
1289       */
1290      private void readObject(java.io.ObjectInputStream s)
# Line 1327 | Line 1306 | public class ConcurrentHashMap<K, V> ext
1306          }
1307      }
1308   }
1330

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines