Java Doc for ConcurrentHashMap.java in  » Apache-Harmony-Java-SE » java-package » java » util » concurrent » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Apache Harmony Java SE » java package » java.util.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.concurrent.ConcurrentHashMap

ConcurrentHashMap
public class ConcurrentHashMap extends AbstractMap implements ConcurrentMap<K, V>,Cloneable,Serializable(Code)
A hash table supporting full concurrency of retrievals and adjustable expected concurrency for updates. This class obeys the same functional specification as java.util.Hashtable , and includes versions of methods corresponding to each method of Hashtable. However, even though all operations are thread-safe, retrieval operations do not entail locking, and there is not any support for locking the entire table in a way that prevents all access. This class is fully interoperable with Hashtable in programs that rely on its thread safety but not on its synchronization details.

Retrieval operations (including get) generally do not block, so may overlap with update operations (including put and remove). Retrievals reflect the results of the most recently completed update operations holding upon their onset. For aggregate operations such as putAll and clear, concurrent retrievals may reflect insertion or removal of only some entries. Similarly, Iterators and Enumerations return elements reflecting the state of the hash table at some point at or since the creation of the iterator/enumeration. They do not throw ConcurrentModificationException . However, iterators are designed to be used by only one thread at a time.

The allowed concurrency among update operations is guided by the optional concurrencyLevel constructor argument (default 16), which is used as a hint for internal sizing. The table is internally partitioned to try to permit the indicated number of concurrent updates without contention. Because placement in hash tables is essentially random, the actual concurrency will vary. Ideally, you should choose a value to accommodate as many threads as will ever concurrently modify the table. Using a significantly higher value than you need can waste space and time, and a significantly lower value can lead to thread contention. But overestimates and underestimates within an order of magnitude do not usually have much noticeable impact. A value of one is appropriate when it is known that only one thread will modify and all others will only read.

This class implements all of the optional methods of the Map and Iterator interfaces.

Like java.util.Hashtable but unlike java.util.HashMap , this class does NOT allow null to be used as a key or value.

This class is a member of the Java Collections Framework.
since:
   1.5
author:
   Doug Lea<
Parameters:
  K - > the type of keys maintained by this map<
Parameters:
  V - > the type of mapped values


Inner Class :final static class Segment extends ReentrantLock implements Serializable
Inner Class :final static class HashEntry
Inner Class :abstract class HashIterator
Inner Class :final class KeyIterator extends HashIterator implements Iterator<K>,Enumeration<K>
Inner Class :final class ValueIterator extends HashIterator implements Iterator<V>,Enumeration<V>
Inner Class :final class EntryIterator extends HashIterator implements Map.Entry<K, V>,Iterator<Entry<K, V>>
Inner Class :final class KeySet extends AbstractSet
Inner Class :final class Values extends AbstractCollection
Inner Class :final class EntrySet extends AbstractSet>
Inner Class :final static class SimpleEntry implements Entry<K, V>

Field Summary
static  intDEFAULT_INITIAL_CAPACITY
     The default initial number of table slots for this table.
final static  floatDEFAULT_LOAD_FACTOR
     The default load factor for this table.
final static  intDEFAULT_SEGMENTS
     The default number of concurrency control segments.
final static  intMAXIMUM_CAPACITY
     The maximum capacity, used if a higher value is implicitly specified by either of the constructors with arguments.
final static  intMAX_SEGMENTS
     The maximum number of segments to allow; used to bound constructor arguments.
transient  Set<Map.Entry<K, V>>entrySet
    
transient  Set<K>keySet
    
final  intsegmentMask
     Mask value for indexing into segments.
final  intsegmentShift
     Shift value for indexing within segments.
final  Segment[]segments
    
transient  Collection<V>values
    

Constructor Summary
public  ConcurrentHashMap(int initialCapacity, float loadFactor, int concurrencyLevel)
     Creates a new, empty map with the specified initial capacity and the specified load factor.
Parameters:
  initialCapacity - the initial capacity.
public  ConcurrentHashMap(int initialCapacity)
     Creates a new, empty map with the specified initial capacity, and with default load factor and concurrencyLevel.
public  ConcurrentHashMap()
     Creates a new, empty map with a default initial capacity, load factor, and concurrencyLevel.
public  ConcurrentHashMap(Map<? extends K, ? extends V> t)
     Creates a new map with the same mappings as the given map.

Method Summary
public  voidclear()
     Removes all mappings from this map.
public  Objectclone()
     Returns a shallow copy of this ConcurrentHashMap instance: the keys and values themselves are not cloned.
public  booleancontains(Object value)
     Legacy method testing if some key maps into the specified value in this table.
public  booleancontainsKey(Object key)
     Tests if the specified object is a key in this table.
Parameters:
  key - possible key.
public  booleancontainsValue(Object value)
     Returns true if this map maps one or more keys to the specified value.
public  Enumeration<V>elements()
     Returns an enumeration of the values in this table.
public  Set<Map.Entry<K, V>>entrySet()
     Returns a collection view of the mappings contained in this map.
public  Vget(Object key)
     Returns the value to which the specified key is mapped in this table.
Parameters:
  key - a key in the table.
static  inthash(Object x)
     Returns a hash code for non-null Object x.
public  booleanisEmpty()
    
public  Set<K>keySet()
     Returns a set view of the keys contained in this map.
public  Enumeration<K>keys()
     Returns an enumeration of the keys in this table.
public  Vput(K key, V value)
     Maps the specified key to the specified value in this table.
public  voidputAll(Map<? extends K, ? extends V> t)
     Copies all of the mappings from the specified map to this one.
public  VputIfAbsent(K key, V value)
     If the specified key is not already associated with a value, associate it with the given value. This is equivalent to
 if (!map.containsKey(key)) 
 return map.put(key, value);
 else
 return map.get(key);
 
Except that the action is performed atomically.
Parameters:
  key - key with which the specified value is to be associated.
Parameters:
  value - value to be associated with the specified key.
public  Vremove(Object key)
     Removes the key (and its corresponding value) from this table.
public  booleanremove(Object key, Object value)
     Remove entry for key only if currently mapped to given value. Acts as
 
 if (map.get(key).equals(value)) {
 map.remove(key);
 return true;
 } else return false;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  value - value associated with the specified key.
public  booleanreplace(K key, V oldValue, V newValue)
     Replace entry for key only if currently mapped to given value. Acts as
 
 if (map.get(key).equals(oldValue)) {
 map.put(key, newValue);
 return true;
 } else return false;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  oldValue - value expected to be associated with the specified key.
Parameters:
  newValue - value to be associated with the specified key.
public  Vreplace(K key, V value)
     Replace entry for key only if currently mapped to some value. Acts as
 
 if ((map.containsKey(key)) {
 return map.put(key, value);
 } else return null;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  value - value to be associated with the specified key.
final  Segment<K, V>segmentFor(int hash)
    
public  intsize()
    
public  Collection<V>values()
     Returns a collection view of the values contained in this map.

Field Detail
DEFAULT_INITIAL_CAPACITY
static int DEFAULT_INITIAL_CAPACITY(Code)
The default initial number of table slots for this table. Used when not otherwise specified in constructor.



DEFAULT_LOAD_FACTOR
final static float DEFAULT_LOAD_FACTOR(Code)
The default load factor for this table. Used when not otherwise specified in constructor.



DEFAULT_SEGMENTS
final static int DEFAULT_SEGMENTS(Code)
The default number of concurrency control segments.



MAXIMUM_CAPACITY
final static int MAXIMUM_CAPACITY(Code)
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 to ensure that entries are indexible using ints.



MAX_SEGMENTS
final static int MAX_SEGMENTS(Code)
The maximum number of segments to allow; used to bound constructor arguments.



entrySet
transient Set<Map.Entry<K, V>> entrySet(Code)



keySet
transient Set<K> keySet(Code)



segmentMask
final int segmentMask(Code)
Mask value for indexing into segments. The upper bits of a key's hash code are used to choose the segment.



segmentShift
final int segmentShift(Code)
Shift value for indexing within segments.



segments
final Segment[] segments(Code)
The segments, each of which is a specialized hash table



values
transient Collection<V> values(Code)




Constructor Detail
ConcurrentHashMap
public ConcurrentHashMap(int initialCapacity, float loadFactor, int concurrencyLevel)(Code)
Creates a new, empty map with the specified initial capacity and the specified load factor.
Parameters:
  initialCapacity - the initial capacity. The implementationperforms internal sizing to accommodate this many elements.
Parameters:
  loadFactor - the load factor threshold, used to control resizing.
Parameters:
  concurrencyLevel - the estimated number of concurrentlyupdating threads. The implementation performs internal sizingto try to accommodate this many threads.
throws:
  IllegalArgumentException - if the initial capacity isnegative or the load factor or concurrencyLevel arenonpositive.



ConcurrentHashMap
public ConcurrentHashMap(int initialCapacity)(Code)
Creates a new, empty map with the specified initial capacity, and with default load factor and concurrencyLevel.
Parameters:
  initialCapacity - The implementation performs internalsizing to accommodate this many elements.
throws:
  IllegalArgumentException - if the initial capacity ofelements is negative.



ConcurrentHashMap
public ConcurrentHashMap()(Code)
Creates a new, empty map with a default initial capacity, load factor, and concurrencyLevel.



ConcurrentHashMap
public ConcurrentHashMap(Map<? extends K, ? extends V> t)(Code)
Creates 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 11 (whichever is greater), and a default load factor.
Parameters:
  t - the map




Method Detail
clear
public void clear()(Code)
Removes all mappings from this map.



clone
public Object clone()(Code)
Returns a shallow copy of this ConcurrentHashMap instance: the keys and values themselves are not cloned. a shallow copy of this map.



contains
public boolean contains(Object value)(Code)
Legacy method testing if some key maps into the specified value in this table. This method is identical in functionality to ConcurrentHashMap.containsValue , and exists solely to ensure full compatibility with class java.util.Hashtable , which supported this method prior to introduction of the Java Collections framework.
Parameters:
  value - a value to search for. true if and only if some key maps to thevalue argument in this table asdetermined by the equals method;false otherwise.
throws:
  NullPointerException - if the value is null.



containsKey
public boolean containsKey(Object key)(Code)
Tests if the specified object is a key in this table.
Parameters:
  key - possible key. true if and only if the specified objectis a key in this table, as determined by theequals method; false otherwise.
throws:
  NullPointerException - if the key isnull.



containsValue
public boolean containsValue(Object value)(Code)
Returns true 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 containsKey.
Parameters:
  value - value whose presence in this map is to be tested. true if this map maps one or more keys to thespecified value.
throws:
  NullPointerException - if the value is null.



elements
public Enumeration<V> elements()(Code)
Returns an enumeration of the values in this table. an enumeration of the values in this table.
See Also:   ConcurrentHashMap.values



entrySet
public Set<Map.Entry<K, V>> entrySet()(Code)
Returns a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry. 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 Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations. The returned iterator is a "weakly consistent" iterator that will never throw java.util.ConcurrentModificationException , and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction. a collection view of the mappings contained in this map.



get
public V get(Object key)(Code)
Returns the value to which the specified key is mapped in this table.
Parameters:
  key - a key in the table. the value to which the key is mapped in this table;null if the key is not mapped to any value inthis table.
throws:
  NullPointerException - if the key isnull.



hash
static int hash(Object x)(Code)
Returns a hash code for non-null Object x. Uses the same hash code spreader as most other java.util hash tables.
Parameters:
  x - the object serving as a key the hash code



isEmpty
public boolean isEmpty()(Code)



keySet
public Set<K> keySet()(Code)
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 Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations. The returned iterator is a "weakly consistent" iterator that will never throw java.util.ConcurrentModificationException , and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction. a set view of the keys contained in this map.



keys
public Enumeration<K> keys()(Code)
Returns an enumeration of the keys in this table. an enumeration of the keys in this table.
See Also:   ConcurrentHashMap.keySet



put
public V put(K key, V value)(Code)
Maps the specified key to the specified value in this table. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.
Parameters:
  key - the table key.
Parameters:
  value - the value. the previous value of the specified key in this table,or null if it did not have one.
throws:
  NullPointerException - if the key or value isnull.




putAll
public void putAll(Map<? extends K, ? extends V> t)(Code)
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.
Parameters:
  t - Mappings to be stored in this map.



putIfAbsent
public V putIfAbsent(K key, V value)(Code)
If the specified key is not already associated with a value, associate it with the given value. This is equivalent to
 if (!map.containsKey(key)) 
 return map.put(key, value);
 else
 return map.get(key);
 
Except that the action is performed atomically.
Parameters:
  key - key with which the specified value is to be associated.
Parameters:
  value - value to be associated with the specified key. previous value associated with specified key, or nullif there was no mapping for key. A null return canalso indicate that the map previously associated nullwith the specified key, if the implementation supportsnull values.
throws:
  UnsupportedOperationException - if the put operation isnot supported by this map.
throws:
  ClassCastException - if the class of the specified key or valueprevents it from being stored in this map.
throws:
  NullPointerException - if the specified key or value isnull.



remove
public V remove(Object key)(Code)
Removes the key (and its corresponding value) from this table. This method does nothing if the key is not in the table.
Parameters:
  key - the key that needs to be removed. the value to which the key had been mapped in this table,or null if the key did not have a mapping.
throws:
  NullPointerException - if the key isnull.



remove
public boolean remove(Object key, Object value)(Code)
Remove entry for key only if currently mapped to given value. Acts as
 
 if (map.get(key).equals(value)) {
 map.remove(key);
 return true;
 } else return false;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  value - value associated with the specified key. true if the value was removed
throws:
  NullPointerException - if the specified key isnull.



replace
public boolean replace(K key, V oldValue, V newValue)(Code)
Replace entry for key only if currently mapped to given value. Acts as
 
 if (map.get(key).equals(oldValue)) {
 map.put(key, newValue);
 return true;
 } else return false;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  oldValue - value expected to be associated with the specified key.
Parameters:
  newValue - value to be associated with the specified key. true if the value was replaced
throws:
  NullPointerException - if the specified key or values arenull.



replace
public V replace(K key, V value)(Code)
Replace entry for key only if currently mapped to some value. Acts as
 
 if ((map.containsKey(key)) {
 return map.put(key, value);
 } else return null;
 
except that the action is performed atomically.
Parameters:
  key - key with which the specified value is associated.
Parameters:
  value - value to be associated with the specified key. previous value associated with specified key, or nullif there was no mapping for key.
throws:
  NullPointerException - if the specified key or value isnull.



segmentFor
final Segment<K, V> segmentFor(int hash)(Code)
Returns the segment that should be used for key with given hash
Parameters:
  hash - the hash code for the key the segment



size
public int size()(Code)



values
public Collection<V> values()(Code)
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 Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations. The returned iterator is a "weakly consistent" iterator that will never throw java.util.ConcurrentModificationException , and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction. a collection view of the values contained in this map.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.