java.util
Class HashMap<K,V>

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>

Direct Known Subclasses:

LinkedHashMap

public class HashMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable

HashMap is an implementation of Map. All optional operations are supported, adding and removing. Keys and values can be any objects.

See Also:

Serialized Form

Nested Class Summary

(package private) static class	HashMap.Entry<K,V>
(package private) static class	HashMap.HashMapEntrySet<KT,VT>
(package private) static class	HashMap.HashMapIterator<E,KT,VT>

Field Summary

(package private) int	elementCount
(package private) HashMap.Entry<K,V>[]	elementData
(package private) float	loadFactor
(package private) int	modCount
(package private) int	threshold

Fields inherited from class java.util.AbstractMap

keySet, valuesCollection

Constructor Summary

HashMap()
Constructs a new empty instance of HashMap.

HashMap(int capacity)
Constructs a new instance of HashMap with the specified capacity.

HashMap(int capacity, float loadFactor)
Constructs a new instance of HashMap with the specified capacity and load factor.

HashMap(Map<? extends K,? extends V> map)
Constructs a new instance of HashMap containing the mappings from the specified Map.

Method Summary

void	clear() Removes all mappings from this HashMap, leaving it empty.
Object	clone() Returns a new HashMap with the same mappings and size as this HashMap.
boolean	containsKey(Object key) Searches this HashMap for the specified key.
boolean	containsValue(Object value) Searches this HashMap for the specified value.
(package private) HashMap.Entry<K,V>	createEntry(K key, int index, V value)
(package private) HashMap.Entry<K,V>	createHashedEntry(K key, int index, int hash)
Set<Map.Entry<K,V>>	entrySet() Returns a Set of the mappings contained in this HashMap.
(package private) HashMap.Entry<K,V>	findNonNullKeyEntry(Object key, int index, int keyHash)
(package private) HashMap.Entry<K,V>	findNullKeyEntry()
V	get(Object key) Returns the value of the mapping with the specified key.
boolean	isEmpty() Returns if this HashMap has no elements, a size of zero.
Set<K>	keySet() Returns a Set of the keys contained in this HashMap.
(package private) HashMap.Entry<K,V>[]	newElementArray(int s) Create a new element array
V	put(K key, V value) Maps the specified key to the specified value.
void	putAll(Map<? extends K,? extends V> map) Copies all the mappings in the given map to this map.
(package private) V	putImpl(K key, V value)
(package private) void	rehash()
(package private) void	rehash(int capacity)
V	remove(Object key) Removes a mapping with the specified key from this HashMap.
(package private) HashMap.Entry<K,V>	removeEntry(Object key)
int	size() Returns the number of mappings in this HashMap.
Collection<V>	values() Returns a Collection of the values contained in this HashMap.

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

elementCount

transient int elementCount

elementData

transient HashMap.Entry<K,V>[] elementData

loadFactor

final float loadFactor

threshold

int threshold

modCount

transient int modCount

Constructor Detail

HashMap

public HashMap()

Constructs a new empty instance of HashMap.

HashMap

public HashMap(int capacity)

Constructs a new instance of HashMap with the specified capacity.

Parameters:

capacity - the initial capacity of this HashMap

Throws:

IllegalArgumentException - when the capacity is less than zero

HashMap

public HashMap(int capacity,
               float loadFactor)

Constructs a new instance of HashMap with the specified capacity and load factor.

Parameters:

capacity - the initial capacity

loadFactor - the initial load factor

Throws:

IllegalArgumentException - when the capacity is less than zero or the load factor is less or equal to zero

HashMap

public HashMap(Map<? extends K,? extends V> map)

Constructs a new instance of HashMap containing the mappings from the specified Map.

Parameters:

map - the mappings to add

Method Detail

newElementArray

HashMap.Entry<K,V>[] newElementArray(int s)

Create a new element array

Parameters:

s -

Returns:

Reference to the element array

clear

public void clear()

Removes all mappings from this HashMap, leaving it empty.

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

See Also:

isEmpty(), size()

clone

public Object clone()

Returns a new HashMap with the same mappings and size as this HashMap.

Overrides:

clone in class AbstractMap<K,V>

Returns:

a shallow copy of this HashMap

See Also:

Cloneable

containsKey

public boolean containsKey(Object key)

Searches this HashMap for the specified key.

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

Parameters:

key - the object to search for

Returns:

true if key is a key of this HashMap, false otherwise

containsValue

public boolean containsValue(Object value)

Searches this HashMap for the specified value.

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

Parameters:

value - the object to search for

Returns:

true if value is a value of this HashMap, false otherwise

entrySet

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

Returns a Set of the mappings contained in this HashMap. Each element in the set is a Map.Entry. The set is backed by this HashMap so changes to one are reflected by the other. The set does not support adding.

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

Returns:

a Set of the mappings

get

public V get(Object key)

Returns the value of the mapping with the specified key. If no entry is found null is returned.

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

Parameters:

key - the key

Returns:

the value of the mapping with the specified key, or null if the entry doesn't exist.

findNonNullKeyEntry

final HashMap.Entry<K,V> findNonNullKeyEntry(Object key,
                                             int index,
                                             int keyHash)

findNullKeyEntry

final HashMap.Entry<K,V> findNullKeyEntry()

isEmpty

public boolean isEmpty()

Returns if this HashMap has no elements, a size of zero.

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractMap<K,V>

Returns:

true if this HashMap has no elements, false otherwise

See Also:

size()

keySet

public Set<K> keySet()

Returns a Set of the keys contained in this HashMap. The set is backed by this HashMap so changes to one are reflected by the other. The set does not support adding.

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMap<K,V>

Returns:

a Set of the keys

put

public V put(K key,
             V value)

Maps the specified key to the specified value.

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

Parameters:

key - the key

value - the value

Returns:

the value of any previous mapping with the specified key or null if there was no mapping

putImpl

V putImpl(K key,
          V value)

createEntry

HashMap.Entry<K,V> createEntry(K key,
                               int index,
                               V value)

createHashedEntry

HashMap.Entry<K,V> createHashedEntry(K key,
                                     int index,
                                     int hash)

putAll

public void putAll(Map<? extends K,? extends V> map)

Copies all the mappings in the given map to this map. These mappings will replace all mappings that this map had for any of the keys currently in the given map.

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMap<K,V>

Parameters:

map - the Map to copy mappings from

Throws:

NullPointerException - if the given map is null

rehash

void rehash(int capacity)

rehash

void rehash()

remove

public V remove(Object key)

Removes a mapping with the specified key from this HashMap.

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

Parameters:

key - the key of the mapping to remove

Returns:

the value of the removed mapping or null if key is not a key in this HashMap

removeEntry

HashMap.Entry<K,V> removeEntry(Object key)

size

public int size()

Returns the number of mappings in this HashMap.

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

Returns:

the number of mappings in this HashMap

values

public Collection<V> values()

Returns a Collection of the values contained in this HashMap. The collection is backed by this HashMap so changes to one are reflected by the other. The collection does not support adding.

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMap<K,V>

Returns:

a Collection of the values