ConcurrentHashMap.java

Index Score
net.sf.l2j.util
L2J

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
LOOPSNumber of loops
COMMENTSComment lines
DOC_COMMENTNumber of javadoc comment lines
JAVA0034JAVA0034 Missing braces in if statement
DECL_COMMENTSComments in declarations
LINESNumber of lines in the source file
SIZESize of the file in bytes
RETURNSNumber of return points from functions
CYCLOMATICCyclomatic complexity
FUNCTIONSNumber of function declarations
LOGICAL_LINESNumber of statements
LOCLines of code
JAVA0035JAVA0035 Missing braces in for statement
JAVA0177JAVA0177 Variable declaration missing initializer
INTERFACE_COMPLEXITYInterface complexity
EXEC_COMMENTSComments in executable code
COMPARISONSNumber of comparison operators
LINE_COMMENTNumber of line comments
JAVA0279JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
ELOCEffective lines of code
OPERATORSNumber of operators
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
BLOCKSNumber of blocks
PROGRAM_LENGTHHalstead program length
OPERANDSNumber of operands
JAVA0123JAVA0123 Use all three components of for loop
JAVA0145JAVA0145 Tab character used in source file
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
PROGRAM_VOCABHalstead program vocabulary
UNIQUE_OPERANDSNumber of unique operands
JAVA0036JAVA0036 Missing braces in while statement
JAVA0143JAVA0143 Synchronized method
UNIQUE_OPERATORSNumber of unique operators
WHITESPACENumber of whitespace lines
JAVA0009JAVA0009 Protected member in final class
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
BLOCK_COMMENTNumber of block comment lines
PARAMSNumber of formal parameter declarations
JAVA0270JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0096JAVA0096 Field in nested class hides outer field
NEST_DEPTHMaximum nesting depth
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0076JAVA0076 Use of magic number
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0130JAVA0130 Non-static method does not use instance fields
JAVA0068JAVA0068 Modifiers not declared in recommended order
/* File: ConcurrentHashMap Written by Doug Lea. Adapted and released, under explicit permission, from JDK1.2 HashMap.java and Hashtable.java which carries the following copyright: * Copyright 1997 by Sun Microsystems, Inc., * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. * All rights reserved. * * This software is the confidential and proprietary information * of Sun Microsystems, Inc. ("Confidential Information"). You * shall not disclose such Confidential Information and shall use * it only in accordance with the terms of the license agreement * you entered into with Sun. History: Date Who What 26nov2000 dl Created, based on ConcurrentReaderHashMap 12jan2001 dl public release 17nov2001 dl Minor tunings 24oct2003 dl Segment implements Serializable */ package net.sf.l2j.util; import java.util.Map; import java.util.AbstractMap; import java.util.AbstractSet; import java.util.AbstractCollection; import java.util.Collection; import java.util.Set; import java.util.Iterator; import java.util.Enumeration; import java.util.NoSuchElementException; import java.io.Serializable; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; /** * A version of Hashtable supporting concurrency for both retrievals and * updates: * * <dl> * <dt>Retrievals * * <dd>Retrievals may overlap updates. (This is the same policy as * ConcurrentReaderHashMap.) Successful retrievals using get(key) and * containsKey(key) usually run without locking. Unsuccessful retrievals (i.e., * when the key is not present) do involve brief synchronization (locking). * Because retrieval operations can ordinarily overlap with update operations * (i.e., put, remove, and their derivatives), retrievals can only be guaranteed * to return the results of the most recently <em>completed</em> 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. * <p> * * 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 * <em>not</em> throw ConcurrentModificationException. However, these * iterators are designed to be used by only one thread at a time. Passing an * iterator across multiple threads may lead to unpredictable results if the * table is being concurrently modified. * <p> * * * <dt>Updates * * <dd>This class supports a hard-wired preset <em>concurrency * level</em> of * 32. This allows a maximum of 32 put and/or remove operations to proceed * concurrently. This level is an upper bound on concurrency, not a guarantee, * since it interacts with how well-strewn elements are across bins of the * table. (The preset value in part reflects the fact that even on large * multiprocessors, factors other than synchronization tend to be bottlenecks * when more than 32 threads concurrently attempt updates.) Additionally, * operations triggering internal resizing and clearing do not execute * concurrently with any operation. * <p> * * There is <em>NOT</em> any support for locking the entire table to prevent * updates. This makes it imposssible, for example, to add an element only if it * is not already present, since another thread may be in the process of doing * the same thing. If you need such capabilities, consider instead using the * ConcurrentReaderHashMap class. * * </dl> * * Because of how concurrency control is split up, the size() and isEmpty() * methods require accumulations across 32 control segments, and so might be * slightly slower than you expect. * <p> * * This class may be used as a direct replacement for java.util.Hashtable in any * application that does not rely on the ability to lock the entire table to * prevent updates. As of this writing, it performs much faster than Hashtable * in typical multi-threaded applications with multiple readers and writers. * Like Hashtable but unlike java.util.HashMap, this class does NOT allow * <tt>null</tt> to be used as a key or value. * <p> * * Implementation note: A slightly faster implementation of this class will be * possible once planned Java Memory Model revisions are in place. * * <p>[ <a * href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> * Introduction to this package. </a>] * */ public class ConcurrentHashMap extends AbstractMap implements Map, Cloneable, Serializable { /* * The basic strategy is an optimistic-style scheme based on the guarantee * that the hash table and its lists are always kept in a consistent enough * state to be read without locking: * * Read operations first proceed without locking, by traversing the * apparently correct list of the apparently correct bin. If an entry is * found, but not invalidated (value field null), it is returned. If not * found, operations must recheck (after a memory barrier) to make sure they * are using both the right list and the right table (which can change under * resizes). If invalidated, reads must acquire main update lock to wait out * the update, and then re-traverse. * * All list additions are at the front of each bin, making it easy to check * changes, and also fast to traverse. Entry next pointers are never * assigned. Remove() builds new nodes when necessary to preserve this. * * Remove() (also clear()) invalidates removed nodes to alert read * operations that they must wait out the full modifications. * * Locking for puts, removes (and, when necessary gets, etc) is controlled * by Segments, each covering a portion of the table. During operations * requiring global exclusivity (mainly resize and clear), ALL of these * locks are acquired at once. Note that these segments are NOT contiguous -- * they are based on the least 5 bits of hashcodes. This ensures that the * same segment controls the same slots before and after resizing, which is * necessary for supporting concurrent retrievals. This comes at the price * of a mismatch of logical vs physical locality, but this seems not to be a * performance problem in practice. * */ /** * Comment for <code>serialVersionUID</code> */ private static final long serialVersionUID = 3257847671166546738L; /** * The hash table data. */ protected transient Entry[] table; /** * The number of concurrency control segments. The value can be at most 32 * since ints are used as bitsets over segments. Emprically, it doesn't seem * to pay to decrease it either, so the value should be at least 32. In * other words, do not redefine this :-) */ protected static final int CONCURRENCY_LEVEL = 32; /** * Mask value for indexing into segments */ protected static final int SEGMENT_MASK = CONCURRENCY_LEVEL - 1; /** * Bookkeeping for each concurrency control segment. Each segment contains a * local count of the number of elements in its region. However, the main * use of a Segment is for its lock. */ protected final static class Segment implements Serializable { /** * Comment for <code>serialVersionUID</code> */ private static final long serialVersionUID = 3257565118136203062L; /** * The number of elements in this segment's region. It is always updated * within synchronized blocks. */ protected int count; /** * Get the count under synch. */ protected synchronized int getCount() { return count; } /** * Force a synchronization */ protected synchronized void synch() { } } /** * The array of concurrency control segments. */ protected final Segment[] segments = new Segment[CONCURRENCY_LEVEL]; /** * The default initial number of table slots for this table (32). Used when * not otherwise specified in constructor. */ public static int DEFAULT_INITIAL_CAPACITY = 32; /** * The minimum capacity, used if a lower value is implicitly specified by * either of the constructors with arguments. MUST be a power of two. */ private static final int MINIMUM_CAPACITY = 32; /** * The maximum capacity, used if a higher value is implicitly specified by * either of the constructors with arguments. MUST be a power of two <= 1 < * <30. */ private static final int MAXIMUM_CAPACITY = 1 << 30; /** * The default load factor for this table (0.75) Used when not otherwise * specified in constructor. */ public static final float DEFAULT_LOAD_FACTOR = 0.75f; /** * The load factor for the hash table. * * @serial */ protected final float loadFactor; /** * Per-segment resize threshold. * * @serial */ protected int threshold; /** * Number of segments voting for resize. The table is doubled when 1/4 of * the segments reach threshold. Volatile but updated without synch since * this is just a heuristic. */ protected transient volatile int votesForResize; /** * Return the number of set bits in w. For a derivation of this algorithm, * see "Algorithms and data structures with applications to graphics and * geometry", by Jurg Nievergelt and Klaus Hinrichs, Prentice Hall, 1993. * See also notes by Torsten Sillke at * http://www.mathematik.uni-bielefeld.de/~sillke/PROBLEMS/bitcount */ protected static int bitcount(int w) { w -= (0xaaaaaaaa & w) >>> 1; w = (w & 0x33333333) + ((w >>> 2) & 0x33333333); w = (w + (w >>> 4)) & 0x0f0f0f0f; w += w >>> 8; w += w >>> 16; return w & 0xff; } /** * Returns the appropriate capacity (power of two) for the specified initial * capacity argument. */ private int p2capacity(int initialCapacity) { int cap = initialCapacity; // Compute the appropriate capacity int result; if (cap > MAXIMUM_CAPACITY || cap < 0) { result = MAXIMUM_CAPACITY; } else { result = MINIMUM_CAPACITY; while (result < cap) result <<= 1; } return result; } /** * Return hash code for Object x. Since we are using power-of-two tables, it * is worth the effort to improve hashcode via the same multiplicative * scheme as used in IdentityHashMap. */ protected static int hash(Object x) { int h = x.hashCode(); // Multiply by 127 (quickly, via shifts), and mix in some high // bits to help guard against bunching of codes that are // consecutive or equally spaced. return ((h << 7) - h + (h >>> 9) + (h >>> 17)); } /** * Check for equality of non-null references x and y. */ protected boolean eq(Object x, Object y) { return x == y || x.equals(y); } /** Create table array and set the per-segment threshold * */ protected Entry[] newTable(int capacity) { threshold = (int) (capacity * loadFactor / CONCURRENCY_LEVEL) + 1; return new Entry[capacity]; } /** * Constructs a new, empty map with the specified initial capacity and the * specified load factor. * * @param initialCapacity * the initial capacity. The actual initial capacity is rounded * to the nearest power of two. * @param loadFactor * the load factor threshold, used to control resizing. This * value is used in an approximate way: When at least a quarter * of the segments of the table reach per-segment threshold, or * one of the segments itself exceeds overall threshold, the * table is doubled. This will on average cause resizing when the * table-wide load factor is slightly less than the threshold. If * you'd like to avoid resizing, you can set this to a * ridiculously large value. * @throws IllegalArgumentException * if the load factor is nonpositive. */ public ConcurrentHashMap(int initialCapacity, float loadFactor) { if (!(loadFactor > 0)) throw new IllegalArgumentException("Illegal Load factor: " + loadFactor); this.loadFactor = loadFactor; for (int i = 0; i < segments.length; ++i) segments[i] = new Segment(); int cap = p2capacity(initialCapacity); table = newTable(cap); } /** * Constructs a new, empty map with the specified initial capacity and * default load factor. * * @param initialCapacity * the initial capacity of the ConcurrentHashMap. * @throws IllegalArgumentException * if the initial maximum number of elements is less than zero. */ public ConcurrentHashMap(int initialCapacity) { this(initialCapacity, DEFAULT_LOAD_FACTOR); } /** * Constructs a new, empty map with a default initial capacity and default * load factor. */ public ConcurrentHashMap() { this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR); } /** * Constructs a new map with the same mappings as the given map. The map is * created with a capacity of twice the number of mappings in the given map * or 32 (whichever is greater), and a default load factor. */ public ConcurrentHashMap(Map t) { this(Math.max((int) (t.size() / DEFAULT_LOAD_FACTOR) + 1, MINIMUM_CAPACITY), DEFAULT_LOAD_FACTOR); putAll(t); } /** * Returns the number of key-value mappings in this map. * * @return the number of key-value mappings in this map. */ public int size() { int c = 0; for (int i = 0; i < segments.length; ++i) c += segments[i].getCount(); return c; } /** * Returns <tt>true</tt> if this map contains no key-value mappings. * * @return <tt>true</tt> if this map contains no key-value mappings. */ public boolean isEmpty() { for (int i = 0; i < segments.length; ++i) if (segments[i].getCount() != 0) return false; return true; } /** * Returns the value to which the specified key is mapped in this table. * * @param key * a key in the table. * @return the value to which the key is mapped in this table; * <code>null</code> if the key is not mapped to any value in this * table. * @exception NullPointerException * if the key is <code>null</code>. * @see #put(Object, Object) */ public Object get(Object key) { int hash = hash(key); // throws null pointer exception if key null // Try first without locking... Entry[] tab = table; int index = hash & (tab.length - 1); Entry first = tab[index]; Entry e; for (e = first; e != null; e = e.next) { if (e.hash == hash && eq(key, e.key)) { Object value = e.value; if (value != null) return value; else break; } } // Recheck under synch if key apparently not there or interference Segment seg = segments[hash & SEGMENT_MASK]; synchronized (seg) { tab = table; index = hash & (tab.length - 1); Entry newFirst = tab[index]; if (e != null || first != newFirst) { for (e = newFirst; e != null; e = e.next) { if (e.hash == hash && eq(key, e.key)) return e.value; } } return null; } } /** * Tests if the specified object is a key in this table. * * @param key * possible key. * @return <code>true</code> if and only if the specified object is a key * in this table, as determined by the <tt>equals</tt> method; * <code>false</code> otherwise. * @exception NullPointerException * if the key is <code>null</code>. * @see #contains(Object) */ public boolean containsKey(Object key) { return get(key) != null; } /** * Maps the specified <code>key</code> to the specified <code>value</code> * in this table. Neither the key nor the value can be <code>null</code>. * (Note that this policy is the same as for java.util.Hashtable, but unlike * java.util.HashMap, which does accept nulls as valid keys and values.) * <p> * * The value can be retrieved by calling the <code>get</code> method with * a key that is equal to the original key. * * @param key * the table key. * @param value * the value. * @return the previous value of the specified key in this table, or * <code>null</code> if it did not have one. * @exception NullPointerException * if the key or value is <code>null</code>. * @see Object#equals(Object) * @see #get(Object) */ public Object put(Object key, Object value) { if (value == null) throw new NullPointerException(); int hash = hash(key); Segment seg = segments[hash & SEGMENT_MASK]; int segcount; Entry[] tab; int votes; synchronized (seg) { tab = table; int index = hash & (tab.length - 1); Entry first = tab[index]; for (Entry e = first; e != null; e = e.next) { if (e.hash == hash && eq(key, e.key)) { Object oldValue = e.value; e.value = value; return oldValue; } } // Add to front of list Entry newEntry = new Entry(hash, key, value, first); tab[index] = newEntry; if ((segcount = ++seg.count) < threshold) return null; int bit = (1 << (hash & SEGMENT_MASK)); votes = votesForResize; if ((votes & bit) == 0) votes = votesForResize |= bit; } // Attempt resize if 1/4 segs vote, // or if this seg itself reaches the overall threshold. // (The latter check is just a safeguard to avoid pathological cases.) if (bitcount(votes) >= CONCURRENCY_LEVEL / 4 || segcount > (threshold * CONCURRENCY_LEVEL)) resize(0, tab); return null; } /** * Gather all locks in order to call rehash, by recursing within synch * blocks for each segment index. * * @param index * the current segment. initially call value must be 0 * @param assumedTab * the state of table on first call to resize. If this changes on * any call, the attempt is aborted because the table has already * been resized by another thread. */ protected void resize(int index, Entry[] assumedTab) { Segment seg = segments[index]; synchronized (seg) { if (assumedTab == table) { int next = index + 1; if (next < segments.length) resize(next, assumedTab); else rehash(); } } } /** * Rehashes the contents of this map into a new table with a larger * capacity. */ protected void rehash() { votesForResize = 0; // reset Entry[] oldTable = table; int oldCapacity = oldTable.length; if (oldCapacity >= MAXIMUM_CAPACITY) { threshold = Integer.MAX_VALUE; // avoid retriggering return; } int newCapacity = oldCapacity << 1; Entry[] newTable = newTable(newCapacity); int mask = newCapacity - 1; /* * Reclassify nodes in each list to new Map. Because we are using * power-of-two expansion, the elements from each bin must either stay * at same index, or move to oldCapacity+index. We also eliminate * unnecessary node creation by catching cases where old nodes can be * reused because their next fields won't change. Statistically, at the * default threshhold, only about one-sixth of them need cloning. (The * nodes they replace will be garbage collectable as soon as they are no * longer referenced by any reader thread that may be in the midst of * traversing table right now.) */ for (int i = 0; i < oldCapacity; i++) { // We need to guarantee that any existing reads of old Map can // proceed. So we cannot yet null out each bin. Entry e = oldTable[i]; if (e != null) { int idx = e.hash & mask; Entry next = e.next; // Single node on list if (next == null) newTable[idx] = e; else { // Reuse trailing consecutive sequence of all same bit Entry lastRun = e; int lastIdx = idx; for (Entry last = next; last != null; last = last.next) { int k = last.hash & mask; if (k != lastIdx) { lastIdx = k; lastRun = last; } } newTable[lastIdx] = lastRun; // Clone all remaining nodes for (Entry p = e; p != lastRun; p = p.next) { int k = p.hash & mask; newTable[k] = new Entry(p.hash, p.key, p.value, newTable[k]); } } } } table = newTable; } /** * Removes the key (and its corresponding value) from this table. This * method does nothing if the key is not in the table. * * @param key * the key that needs to be removed. * @return the value to which the key had been mapped in this table, or * <code>null</code> if the key did not have a mapping. * @exception NullPointerException * if the key is <code>null</code>. */ public Object remove(Object key) { return remove(key, null); } /** * Removes the (key, value) pair from this table. This method does nothing * if the key is not in the table, or if the key is associated with a * different value. This method is needed by EntrySet. * * @param key * the key that needs to be removed. * @param value * the associated value. If the value is null, it means "any * value". * @return the value to which the key had been mapped in this table, or * <code>null</code> if the key did not have a mapping. * @exception NullPointerException * if the key is <code>null</code>. */ protected Object remove(Object key, Object value) { /* * Find the entry, then 1. Set value field to null, to force get() to * retry 2. Rebuild the list without this entry. All entries following * removed node can stay in list, but all preceeding ones need to be * cloned. Traversals rely on this strategy to ensure that elements will * not be repeated during iteration. */ int hash = hash(key); Segment seg = segments[hash & SEGMENT_MASK]; synchronized (seg) { Entry[] tab = table; int index = hash & (tab.length - 1); Entry first = tab[index]; Entry e = first; for (;;) { if (e == null) return null; if (e.hash == hash && eq(key, e.key)) break; e = e.next; } Object oldValue = e.value; if (value != null && !value.equals(oldValue)) return null; e.value = null; Entry head = e.next; for (Entry p = first; p != e; p = p.next) head = new Entry(p.hash, p.key, p.value, head); tab[index] = head; seg.count--; return oldValue; } } /** * Returns <tt>true</tt> if this map maps one or more keys to the * specified value. Note: This method requires a full internal traversal of * the hash table, and so is much slower than method <tt>containsKey</tt>. * * @param value * value whose presence in this map is to be tested. * @return <tt>true</tt> if this map maps one or more keys to the * specified value. * @exception NullPointerException * if the value is <code>null</code>. */ public boolean containsValue(Object value) { if (value == null) throw new NullPointerException(); for (int s = 0; s < segments.length; ++s) { Segment seg = segments[s]; Entry[] tab; synchronized (seg) { tab = table; } for (int i = s; i < tab.length; i += segments.length) { for (Entry e = tab[i]; e != null; e = e.next) if (value.equals(e.value)) return true; } } return false; } /** * Tests if some key maps into the specified value in this table. This * operation is more expensive than the <code>containsKey</code> method. * <p> * * Note that this method is identical in functionality to containsValue, * (which is part of the Map interface in the collections framework). * * @param value * a value to search for. * @return <code>true</code> if and only if some key maps to the * <code>value</code> argument in this table as determined by the * <tt>equals</tt> method; <code>false</code> otherwise. * @exception NullPointerException * if the value is <code>null</code>. * @see #containsKey(Object) * @see #containsValue(Object) * @see Map */ public boolean contains(Object value) { return containsValue(value); } /** * Copies all of the mappings from the specified map to this one. * * These mappings replace any mappings that this map had for any of the keys * currently in the specified Map. * * @param t * Mappings to be stored in this map. */ public void putAll(Map t) { int n = t.size(); if (n == 0) return; // Expand enough to hold at least n elements without resizing. // We can only resize table by factor of two at a time. // It is faster to rehash with fewer elements, so do it now. for (;;) { Entry[] tab; int max; synchronized (segments[0]) { // must synch on some segment. pick 0. tab = table; max = threshold * CONCURRENCY_LEVEL; } if (n < max) break; resize(0, tab); } for (Iterator it = t.entrySet().iterator(); it.hasNext();) { Map.Entry entry = (Map.Entry) it.next(); put(entry.getKey(), entry.getValue()); } } /** * Removes all mappings from this map. */ public void clear() { // We don't need all locks at once so long as locks // are obtained in low to high order for (int s = 0; s < segments.length; ++s) { Segment seg = segments[s]; synchronized (seg) { Entry[] tab = table; for (int i = s; i < tab.length; i += segments.length) { for (Entry e = tab[i]; e != null; e = e.next) e.value = null; tab[i] = null; seg.count = 0; } } } } /** * Returns a shallow copy of this <tt>ConcurrentHashMap</tt> instance: the * keys and values themselves are not cloned. * * @return a shallow copy of this map. */ public Object clone() { // We cannot call super.clone, since it would share final segments // array, // and there's no way to reassign finals. return new ConcurrentHashMap(this); } // Views protected transient Set keySet = null; protected transient Set entrySet = null; protected transient Collection values = null; /** * Returns a set view of the keys contained in this map. The set is backed * by the map, so changes to the map are reflected in the set, and * vice-versa. The set supports element removal, which removes the * corresponding mapping from this map, via the <tt>Iterator.remove</tt>, * <tt>Set.remove</tt>,<tt>removeAll</tt>,<tt>retainAll</tt>, and * <tt>clear</tt> operations. It does not support the <tt>add</tt> or * <tt>addAll</tt> operations. * * @return a set view of the keys contained in this map. */ public Set keySet() { Set ks = keySet; return (ks != null) ? ks : (keySet = new KeySet()); } private class KeySet extends AbstractSet { public Iterator iterator() { return new KeyIterator(); } public int size() { return ConcurrentHashMap.this.size(); } public boolean contains(Object o) { return ConcurrentHashMap.this.containsKey(o); } public boolean remove(Object o) { return ConcurrentHashMap.this.remove(o) != null; } public void clear() { ConcurrentHashMap.this.clear(); } } /** * Returns a collection view of the values contained in this map. The * collection is backed by the map, so changes to the map are reflected in * the collection, and vice-versa. The collection supports element removal, * which removes the corresponding mapping from this map, via the * <tt>Iterator.remove</tt>,<tt>Collection.remove</tt>, * <tt>removeAll</tt>,<tt>retainAll</tt>, and <tt>clear</tt> * operations. It does not support the <tt>add</tt> or <tt>addAll</tt> * operations. * * @return a collection view of the values contained in this map. */ public Collection values() { Collection vs = values; return (vs != null) ? vs : (values = new Values()); } private class Values extends AbstractCollection { public Iterator iterator() { return new ValueIterator(); } public int size() { return ConcurrentHashMap.this.size(); } public boolean contains(Object o) { return ConcurrentHashMap.this.containsValue(o); } public void clear() { ConcurrentHashMap.this.clear(); } } /** * Returns a collection view of the mappings contained in this map. Each * element in the returned collection is a <tt>Map.Entry</tt>. The * collection is backed by the map, so changes to the map are reflected in * the collection, and vice-versa. The collection supports element removal, * which removes the corresponding mapping from the map, via the * <tt>Iterator.remove</tt>,<tt>Collection.remove</tt>, * <tt>removeAll</tt>,<tt>retainAll</tt>, and <tt>clear</tt> * operations. It does not support the <tt>add</tt> or <tt>addAll</tt> * operations. * * @return a collection view of the mappings contained in this map. */ public Set entrySet() { Set es = entrySet; return (es != null) ? es : (entrySet = new EntrySet()); } private class EntrySet extends AbstractSet { public Iterator iterator() { return new HashIterator(); } public boolean contains(Object o) { if (!(o instanceof Map.Entry)) return false; Map.Entry entry = (Map.Entry) o; Object v = ConcurrentHashMap.this.get(entry.getKey()); return v != null && v.equals(entry.getValue()); } public boolean remove(Object o) { if (!(o instanceof Map.Entry)) return false; Map.Entry e = (Map.Entry) o; return ConcurrentHashMap.this.remove(e.getKey(), e.getValue()) != null; } public int size() { return ConcurrentHashMap.this.size(); } public void clear() { ConcurrentHashMap.this.clear(); } } /** * Returns an enumeration of the keys in this table. * * @return an enumeration of the keys in this table. * @see Enumeration * @see #elements() * @see #keySet() * @see Map */ public Enumeration keys() { return new KeyIterator(); } /** * Returns an enumeration of the values in this table. Use the Enumeration * methods on the returned object to fetch the elements sequentially. * * @return an enumeration of the values in this table. * @see java.util.Enumeration * @see #keys() * @see #values() * @see Map */ public Enumeration elements() { return new ValueIterator(); } /** * ConcurrentHashMap collision list entry. */ protected static class Entry implements Map.Entry { /* * The use of volatile for value field ensures that we can detect status * changes without synchronization. The other fields are never changed, * and are marked as final. */ protected final Object key; protected volatile Object value; protected final int hash; protected final Entry next; Entry(int hash, Object key, Object value, Entry next) { this.value = value; this.hash = hash; this.key = key; this.next = next; } // Map.Entry Ops public Object getKey() { return key; } /** * Get the value. Note: In an entrySet or entrySet.iterator, unless you * can guarantee lack of concurrent modification, * <tt>getValue</tt> <em>might</em> return null, reflecting the fact * that the entry has been concurrently removed. However, there are no * assurances that concurrent removals will be reflected using this * method. * * @return the current value, or null if the entry has been detectably * removed. */ public Object getValue() { return value; } /** * Set the value of this entry. Note: In an entrySet or * entrySet.iterator), unless you can guarantee lack of concurrent * modification, <tt>setValue</tt> is not strictly guaranteed to * actually replace the value field obtained via the <tt>get</tt> * operation of the underlying hash table in multithreaded applications. * If iterator-wide synchronization is not used, and any other * concurrent <tt>put</tt> or <tt>remove</tt> operations occur, * sometimes even to <em>other</em> entries, then this change is not * guaranteed to be reflected in the hash table. (It might, or it might * not. There are no assurances either way.) * * @param value * the new value. * @return the previous value, or null if entry has been detectably * removed. * @exception NullPointerException * if the value is <code>null</code>. * */ public Object setValue(Object value) { if (value == null) throw new NullPointerException(); Object oldValue = this.value; this.value = value; return oldValue; } public boolean equals(Object o) { if (!(o instanceof Map.Entry)) return false; Map.Entry e = (Map.Entry) o; return (key.equals(e.getKey()) && value.equals(e.getValue())); } public int hashCode() { return key.hashCode() ^ value.hashCode(); } public String toString() { return key + "=" + value; } } protected class HashIterator implements Iterator, Enumeration { protected final Entry[] tab; // snapshot of table protected int index; // current slot protected Entry entry = null; // current node of slot protected Object currentKey; // key for current node protected Object currentValue; // value for current node protected Entry lastReturned = null; // last node returned by next protected HashIterator() { // force all segments to synch synchronized (segments[0]) { tab = table; } for (int i = 1; i < segments.length; ++i) segments[i].synch(); index = tab.length - 1; } public boolean hasMoreElements() { return hasNext(); } public Object nextElement() { return next(); } public boolean hasNext() { /* * currentkey and currentValue are set here to ensure that next() * returns normally if hasNext() returns true. This avoids surprises * especially when final element is removed during traversal -- * instead, we just ignore the removal during current traversal. */ for (;;) { if (entry != null) { Object v = entry.value; if (v != null) { currentKey = entry.key; currentValue = v; return true; } else entry = entry.next; } while (entry == null && index >= 0) entry = tab[index--]; if (entry == null) { currentKey = currentValue = null; return false; } } } protected Object returnValueOfNext() { return entry; } public Object next() { if (currentKey == null && !hasNext()) throw new NoSuchElementException(); Object result = returnValueOfNext(); lastReturned = entry; currentKey = currentValue = null; entry = entry.next; return result; } public void remove() { if (lastReturned == null) throw new IllegalStateException(); ConcurrentHashMap.this.remove(lastReturned.key); lastReturned = null; } } protected class KeyIterator extends HashIterator { protected Object returnValueOfNext() { return currentKey; } } protected class ValueIterator extends HashIterator { protected Object returnValueOfNext() { return currentValue; } } /** * Save the state of the <tt>ConcurrentHashMap</tt> instance to a stream * (i.e., serialize it). * * @serialData An estimate of the table size, followed by the key (Object) * and value (Object) for each key-value mapping, followed by a * null pair. The key-value mappings are emitted in no * particular order. */ private void writeObject(ObjectOutputStream s) throws IOException { // Write out the loadfactor, and any hidden stuff s.defaultWriteObject(); // Write out capacity estimate. It is OK if this // changes during the write, since it is only used by // readObject to set initial capacity, to avoid needless resizings. int cap; synchronized (segments[0]) { cap = table.length; } s.writeInt(cap); // Write out keys and values (alternating) for (int k = 0; k < segments.length; ++k) { Segment seg = segments[k]; Entry[] tab; synchronized (seg) { tab = table; } for (int i = k; i < tab.length; i += segments.length) { for (Entry e = tab[i]; e != null; e = e.next) { s.writeObject(e.key); s.writeObject(e.value); } } } s.writeObject(null); s.writeObject(null); } /** * Reconstitute the <tt>ConcurrentHashMap</tt> instance from a stream * (i.e., deserialize it). */ private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException { // Read in the threshold, loadfactor, and any hidden stuff s.defaultReadObject(); int cap = s.readInt(); table = newTable(cap); for (int i = 0; i < segments.length; ++i) segments[i] = new Segment(); // Read the keys and values, and put the mappings in the table for (;;) { Object key = s.readObject(); Object value = s.readObject(); if (key == null) break; put(key, value); } } }

The table below shows all metrics for ConcurrentHashMap.java.

MetricValueDescription
BLOCKS103.00Number of blocks
BLOCK_COMMENT84.00Number of block comment lines
COMMENTS567.00Comment lines
COMMENT_DENSITY 1.35Comment density
COMPARISONS81.00Number of comparison operators
CYCLOMATIC141.00Cyclomatic complexity
DECL_COMMENTS56.00Comments in declarations
DOC_COMMENT450.00Number of javadoc comment lines
ELOC420.00Effective lines of code
EXEC_COMMENTS22.00Comments in executable code
EXITS37.00Procedure exits
FUNCTIONS62.00Number of function declarations
HALSTEAD_DIFFICULTY124.14Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY130.00Interface complexity
JAVA0001 1.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 1.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 1.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 3.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA003427.00JAVA0034 Missing braces in if statement
JAVA0035 8.00JAVA0035 Missing braces in for statement
JAVA0036 2.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 1.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 1.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 3.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 1.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 9.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 6.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 1.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 1.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 3.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 2.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 4.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 1.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 1.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 2.00JAVA0143 Synchronized method
JAVA0144 0.00JAVA0144 Line exceeds maximum M characters
JAVA01452151.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA017710.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 1.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 1.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 2.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 2.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES1359.00Number of lines in the source file
LINE_COMMENT33.00Number of line comments
LOC642.00Lines of code
LOGICAL_LINES312.00Number of statements
LOOPS28.00Number of loops
NEST_DEPTH 6.00Maximum nesting depth
OPERANDS1121.00Number of operands
OPERATORS2230.00Number of operators
PARAMS35.00Number of formal parameter declarations
PROGRAM_LENGTH3351.00Halstead program length
PROGRAM_VOCAB364.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS95.00Number of return points from functions
SIZE37498.00Size of the file in bytes
UNIQUE_OPERANDS298.00Number of unique operands
UNIQUE_OPERATORS66.00Number of unique operators
WHITESPACE150.00Number of whitespace lines