Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.util.HashMap

java.lang.Object
    |
    +----java.util.AbstractMap
            |
            +----java.util.HashMap

public class HashMap
extends AbstractMap
implements Map, Cloneable, Serializable
Hash table based implementation of the Map interface. This implementation provides all of the optional Map operations, and permits null values and the null key. (HashMap is roughly equivalent to Hashtable, except that it is unsynchronized and permits nulls.) This class makes no guarantees as to the order of the Map; in particular, it does not guarantee that the order will remain constant over time.

This implementation provides constant-time performance for the basic operations (get and put), assuming the the hash function disperses the elements properly among the buckets. Iteration over Collection views requires time proportional to the "capacity" of the HashMap (the number of buckets) plus its size (the number of key-value mappings). Thus, it's very important not to set the intial capacity too high (or the load factor too low) if iteration performance is important.

An instance of HashMap has two parameters that affect its efficiency: its capacity and its load factor. The load factor should be between 0.0 and 1.0. When the number of mappings in the HashMap exceeds the product of the load factor and the current capacity, the capacity is increased by calling the rehash method. Larger load factors use memory more efficiently, at the expense of larger expected time per lookup.

If many mappings are to be stored in a HashMap, 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 HashMap concurrently, and at least one of the threads modifies the HashMap 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 is already contained in the Table is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the HashMap. If no such object exists, the HashMap should be "wrapped" using the Collections.synchronizedSet method. This is best done at creation time, to prevent accidental unsynchronized access to the HashMap:

	Map m = Collections.synchronizedMap(new HashMap(...));
 

The Iterators returned by the iterator methods of the Collections returned by all of HashMap's "collection view methods" are fail-fast: if the HashMap is structurally modified at any time after the Iterator is created, in any way except through the Iterator's own remove or add methods, 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.

Since:
JDK1.2
See Also:
hashCode(), Collection, Map, TreeMap, Hashtable

Constructor Summary
 HashMap(int initialCapacity, float loadFactor)
Constructs a new, empty HashMap with the specified initial capacity and the specified load factor.
 HashMap(int initialCapacity)
Constructs a new, empty HashMap with the specified initial capacity and default load factor.
 HashMap()
Constructs a new, empty HashMap with a default capacity and load factor.
 HashMap(Map t)
Constructs a new HashMap with the same mappings as the given Map.
 

Method Summary
void  clear()
Removes all mappings from this HashMap.
Object  clone()
Returns a shallow copy of this HashMap.
boolean  containsKey(Object key)
Returns true if this HashMap contains a mapping for the specified key.
boolean  containsValue(Object value)
Returns true if this HashMap maps one or more keys to the specified value.
Set  entries()
Returns a Collection view of the mappings contained in this HashMap.
Object  get(Object key)
Returns the value to which this HashMap maps the specified key.
boolean  isEmpty()
Returns true if this Map contains no key-value mappings.
Set  keySet()
Returns a Set view of the keys contained in this HashMap.
Object  put(Object key, Object value)
Associates the specified value with the specified key in this HashMap.
void  putAll(Map t)
Copies all of the mappings from the specified Map to this HashMap These mappings will replace any mappings that this HashMap had for any of the keys currently in the specified Map.
Object  remove(Object key)
Removes the mapping for this key from this HashMap if present.
int  size()
Returns the number of key-value mappings in this Map.
Collection  values()
Returns a Collection view of the values contained in this HashMap.
 
Methods inherited from class java.util.AbstractMap
 clear, containsKey, containsValue, entries, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HashMap

public HashMap(int initialCapacity,
               float loadFactor)
Constructs a new, empty HashMap with the specified initial capacity and the specified load factor.
Parameters:
initialCapacity - the initial capacity of the HashMap.
loadFactor - a number between 0.0 and 1.0.
Throws:
IllegalArgumentException - if the initial capacity is less than or equal to zero, or if the load factor is less than or equal to zero.

HashMap

public HashMap(int initialCapacity)
Constructs a new, empty HashMap with the specified initial capacity and default load factor.
Parameters:
initialCapacity - the initial capacity of the HashMap.

HashMap

public HashMap()
Constructs a new, empty HashMap with a default capacity and load factor.

HashMap

public HashMap(Map t)
Constructs a new HashMap with the same mappings as the given Map. The HashMap is created with a capacity of thrice the number of mappings in the given Map or 11 (whichever is greater), and a default load factor.
Method Detail

size

public int size()
Returns the number of key-value mappings in this Map.
Implements:
size in interface Map
Overrides:
size in class AbstractMap

isEmpty

public boolean isEmpty()
Returns true if this Map contains no key-value mappings.
Implements:
isEmpty in interface Map
Overrides:
isEmpty in class AbstractMap

containsValue

public boolean containsValue(Object value)
Returns true if this HashMap maps one or more keys to the specified value.
Implements:
containsValue in interface Map
Parameters:
value - value whose presence in this Map is to be tested.
Overrides:
containsValue in class AbstractMap

containsKey

public boolean containsKey(Object key)
Returns true if this HashMap contains a mapping for the specified key.
Implements:
containsKey in interface Map
Parameters:
key - key whose presence in this Map is to be tested.
Overrides:
containsKey in class AbstractMap

get

public Object get(Object key)
Returns the value to which this HashMap maps the specified key. Returns null if the HashMap contains no mapping for this key. A return value of null does not necessarily indicate that the HashMap contains no mapping for the key; it's also possible that the HashMap explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
Implements:
get in interface Map
Parameters:
key - key whose associated value is to be returned.
Overrides:
get in class AbstractMap

put

public Object put(Object key,
                  Object value)
Associates the specified value with the specified key in this HashMap. If the HashMap previously contained a mapping for this key, the old value is replaced.
Implements:
put in interface Map
Parameters:
key - key with which the specified value is to be associated.
value - value to be associated with the specified key.
Returns:
previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the HashMap previously associated null with the specified key.
Overrides:
put in class AbstractMap

remove

public Object remove(Object key)
Removes the mapping for this key from this HashMap if present.
Implements:
remove in interface Map
Parameters:
key - key whose mapping is to be removed from the Map.
Returns:
previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the HashMap previously associated null with the specified key.
Overrides:
remove in class AbstractMap

putAll

public void putAll(Map t)
Copies all of the mappings from the specified Map to this HashMap These mappings will replace any mappings that this HashMap had for any of the keys currently in the specified Map.
Implements:
putAll in interface Map
Parameters:
t - Mappings to be stored in this Map.
Overrides:
putAll in class AbstractMap

clear

public void clear()
Removes all mappings from this HashMap.
Implements:
clear in interface Map
Overrides:
clear in class AbstractMap

clone

public Object clone()
Returns a shallow copy of this HashMap. The keys and values themselves are not cloned.
Overrides:
clone in class Object

keySet

public Set keySet()
Returns a Set view of the keys contained in this HashMap. The Set is backed by the HashMap, so changes to the HashMap are reflected in the Set, and vice-versa. The Set supports element removal, which removes the corresponding mapping from the HashMap, via the Iterator.remove, Set.remove, removeAll retainAll, and clear operations. It does not support the add or addAll operations.
Implements:
keySet in interface Map
Overrides:
keySet in class AbstractMap

values

public Collection values()
Returns a Collection view of the values contained in this HashMap. The Collection is backed by the HashMap, so changes to the HashMap are reflected in the Collection, and vice-versa. The Collection supports element removal, which removes the corresponding mapping from the HashMap, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
Implements:
values in interface Map
Overrides:
values in class AbstractMap

entries

public Set entries()
Returns a Collection view of the mappings contained in this HashMap. Each element in the returned collection is a Map.Entry. The Collection is backed by the HashMap, so changes to the HashMap are reflected in the Collection, and vice-versa. The Collection supports element removal, which removes the corresponding mapping from the HashMap, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
Implements:
entries in interface Map
Overrides:
entries in class AbstractMap
See Also:
Map.Entry

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.