| public class java.util HashMap<K, V>
|
Java SE 6 |
This implementation provides constant-time performance for the basic operations (get and put), assuming the hash function disperses the elements properly among the buckets. Iteration over collection views requires time proportional to the "capacity" of the HashMap instance (the number of buckets) plus its size (the number of key-value mappings). Thus, it's very important not to set the initial capacity too high (or the load factor too low) if iteration performance is important.
An instance of HashMap has two parameters that affect its performance: initial capacity and load factor. The capacity is the number of buckets in the hash table, and the initial capacity is simply the capacity at the time the hash table is created. The load factor is a measure of how full the hash table is allowed to get before its capacity is automatically increased. When the number of entries in the hash table exceeds the product of the load factor and the current capacity, the hash table is rehashed (that is, internal data structures are rebuilt) so that the hash table has approximately twice the number of buckets.
As a general rule, the default load factor (.75) offers a good tradeoff between time and space costs. Higher values decrease the space overhead but increase the lookup cost (reflected in most of the operations of the HashMap class, including get and put). The expected number of entries in the map and its load factor should be taken into account when setting its initial capacity, so as to minimize the number of rehash operations. If the initial capacity is greater than the maximum number of entries divided by the load factor, no rehash operations will ever occur.
If many mappings are to be stored in a HashMap instance, creating it with a sufficiently large capacity will allow the mappings to be stored more efficiently than letting it perform automatic rehashing as needed to grow the table.
Note that this implementation is not synchronized.
If multiple threads access a hash map concurrently, and at least one of
the threads modifies the map structurally, it must be
synchronized externally. (A structural modification is any operation
that adds or deletes one or more mappings; merely changing the value
associated with a key that an instance already contains is not a
structural modification.) This is typically accomplished by
synchronizing on some object that naturally encapsulates the map.
If no such object exists, the map should be "wrapped" using the
Collections.synchronizedMap
method. This is best done at creation time, to prevent accidental
unsynchronized access to the map:
Map m = Collections.synchronizedMap(new HashMap(...));
The iterators returned by all of this class's "collection view methods"
are fail-fast: if the map is structurally modified at any time after
the iterator is created, in any way except through the iterator's own
remove method, the iterator will throw a
ConcurrentModificationException. Thus, in the face of concurrent
modification, the iterator fails quickly and cleanly, rather than risking
arbitrary, non-deterministic behavior at an undetermined time in the
future.
Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.
This class is a member of the Java Collections Framework.
| K | the type of keys maintained by this map |
| V | the type of mapped values |
| version | 1.72, 04/24/06 |
| since | 1.2 |
| See also | hashCode(), java.util.Collection, java.util.Map, java.util.TreeMap, java.util.Hashtable |
| Constructors | |||||||
|---|---|---|---|---|---|---|---|
| public | HashMap(int initialCapacity, float loadFactor) Details
Constructs an empty HashMap with the specified initial
capacity and load factor.
| ||||||
| public | HashMap(int initialCapacity) Details
Constructs an empty HashMap with the specified initial
capacity and the default load factor (0.75).
| ||||||
| public | HashMap() Constructs an empty HashMap with the default initial capacity (16) and the default load factor (0.75). | ||||||
| public | HashMap(Map m) Details
Constructs a new HashMap with the same mappings as the
specified Map. The HashMap is created with
default load factor (0.75) and an initial capacity sufficient to
hold the mappings in the specified Map.
| ||||||
| Methods | |||||||
|---|---|---|---|---|---|---|---|
| public void | clear() Removes all of the mappings from this map. The map will be empty after this call returns. | ||||||
| public Object | clone() Details
Returns a shallow copy of this HashMap instance: the keys and
values themselves are not cloned.
| ||||||
| public boolean | containsKey(Object key) Details
Returns true if this map contains a mapping for the
specified key.
| ||||||
| public boolean | containsValue(Object value) Details
Returns true if this map maps one or more keys to the
specified value.
| ||||||
| public Set | entrySet() Details
Returns a Set view of the mappings contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation, or through the
setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. The set
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Set.remove, removeAll, retainAll and
clear operations. It does not support the
add or addAll operations.
| ||||||
| public Object | get(Object key) Details
Returns the value to which the specified key is mapped,
or null if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
A return value of
| ||||||
| public Set | keySet() 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. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.
| ||||||
| public Object | put(Object key, Object value) Details
Associates the specified value with the specified key in this map.
If the map previously contained a mapping for the key, the old
value is replaced.
| ||||||
| public void | putAll(Map m) Details
Copies all of the mappings from the specified map to this map.
These mappings will replace any mappings that this map had for
any of the keys currently in the specified map.
| ||||||
| public Object | remove(Object key) Details
Removes the mapping for the specified key from this map if present.
| ||||||
| public int | size() Details
Returns the number of key-value mappings in this map.
| ||||||
| public Collection | values() 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. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. 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.
| ||||||
| Properties | |||
|---|---|---|---|
| public boolean | isEmpty() Details
Returns true if this map contains no key-value mappings.
| ||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|