- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<K,V>
-
- 参数类型
-
K
- 由该地图维护的键的类型 -
V
- 映射值的类型
- All Implemented Interfaces:
-
Serializable
,Cloneable
,Map<K,V>
- 已知直接子类:
-
ClipboardContent
,LinkedHashMap
,PrinterStateReasons
public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable
基于哈希表的实现的Map
接口。 该实现提供了所有可选的映射操作,并允许null
值和null
密钥。 (HashMap
类大致相当于Hashtable
,除了它是不同步的,并允许null)。这个类不能保证地图的顺序; 特别是,它不能保证订单在一段时间内保持不变。假定散列函数在桶中正确分散元素,则此实现为基本操作(
get
和put
)提供了恒定时间的性能。 收集视图的迭代需要与HashMap
实例(桶数)加上其大小(键值映射数)的“容量”成正比。 因此,如果迭代性能很重要,不要将初始容量设置得太高(或负载因子太低)是非常重要的。HashMap
一个实例有两个影响其性能的参数: 初始容量和负载因子 。 容量是哈希表中的桶数,初始容量只是创建哈希表时的容量。 负载因子是在容量自动增加之前允许哈希表得到满足的度量。 当哈希表中的条目数超过负载因子和当前容量的乘积时, 重新排列哈希表(即,内部数据结构被重新构建),以使散列表具有大约两倍的桶数。作为一般规则,默认负载因子(.75)提供了时间和空间成本之间的良好折中。 更高的值会降低空间开销,但会增加查找成本(反映在
HashMap
类的大部分操作中,包括get
和put
)。 在设置其初始容量时,应考虑地图中预期的条目数及其负载因子,以便最小化重新组播操作的数量。 如果初始容量大于最大条目数除以负载因子,则不会发生重新排列操作。如果许多映射要存储在
HashMap
实例中,则以足够大的容量创建映射将允许映射的存储效率高于使其根据需要执行自动重新排序以增长表。 请注意,使用相同的hashCode()
许多密钥是降低任何哈希表的性能的一种方法。 为了改善影响,当按键为Comparable
时 ,该类可以使用键之间的比较顺序来帮助打破关系。请注意,此实现不同步。 如果多个线程同时访问哈希映射,并且至少有一个线程在结构上修改了映射,那么它必须在外部进行同步。 (结构修改是添加或删除一个或多个映射的任何操作;仅改变与实例已经包含的密钥相关联的值不是结构修改。)这通常通过对自然地封装映射的一些对象进行同步来实现。 如果没有这样的对象存在,地图应该使用
Collections.synchronizedMap
方法“包装”。 这最好在创建时完成,以防止意外的不同步访问地图:Map m = Collections.synchronizedMap(new HashMap(...));
所有这个类的“集合视图方法”返回的迭代器都是故障快速的 :如果映射在迭代器创建之后的任何时间被结构化地修改,除了通过迭代器自己的
remove
方法之外,迭代器将抛出一个ConcurrentModificationException
。 因此,面对并发修改,迭代器将快速而干净地失败,而不是在未来未确定的时间冒着任意的非确定性行为。请注意,迭代器的故障快速行为无法保证,因为一般来说,在不同步并发修改的情况下,无法做出任何硬性保证。 失败快速迭代器
ConcurrentModificationException
扔出ConcurrentModificationException
。 因此,编写依赖于此异常的程序的正确性将是错误的: 迭代器的故障快速行为应仅用于检测错误。这个类是Java Collections Framework的成员。
- 从以下版本开始:
- 1.2
- 另请参见:
-
Object.hashCode()
,Collection
,Map
,TreeMap
,Hashtable
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
-
方法摘要
所有方法 接口方法 具体的方法 Modifier and Type 方法 描述 void
clear()
从这张地图中删除所有的映射。Object
clone()
返回此HashMap
实例的浅拷贝:键和值本身不被克隆。V
compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
尝试计算指定密钥及其当前映射值的映射(如果没有当前映射,则null
)。V
computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
如果指定的键尚未与值相关联(或映射到null
),则尝试使用给定的映射函数计算其值,并将其输入到此映射中,除非null
。V
computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
如果指定的密钥的值存在且非空,则尝试计算给定密钥及其当前映射值的新映射。boolean
containsKey(Object key)
如果此映射包含指定键的映射,则返回true
。boolean
containsValue(Object value)
如果此映射将一个或多个键映射到指定的值,则返回true
。Set<Map.Entry<K,V>>
entrySet()
返回此地图中包含的映射的Set
视图。void
forEach(BiConsumer<? super K,? super V> action)
对此映射中的每个条目执行给定的操作,直到所有条目都被处理或操作引发异常。V
get(Object key)
返回指定键映射到的值,如果此映射不包含键的映射,则返回null
。V
getOrDefault(Object key, V defaultValue)
返回指定键映射到的值,如果此映射不包含该键的映射,则返回defaultValue
。boolean
isEmpty()
如果此映射不包含键值映射,则返回true
。Set<K>
keySet()
返回此地图中包含的键的Set
视图。V
merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
如果指定的键尚未与值相关联或与null相关联,则将其与给定的非空值相关联。V
put(K key, V value)
将指定的值与此映射中的指定键相关联。void
putAll(Map<? extends K,? extends V> m)
将指定地图的所有映射复制到此地图。V
putIfAbsent(K key, V value)
如果指定的键尚未与值相关联(或映射到null
)将其与给定值相关联并返回null
,否则返回当前值。V
remove(Object key)
从该地图中删除指定键的映射(如果存在)。boolean
remove(Object key, Object value)
仅当指定的密钥当前映射到指定的值时删除该条目。V
replace(K key, V value)
只有当目标映射到某个值时,才能替换指定键的条目。boolean
replace(K key, V oldValue, V newValue)
仅当当前映射到指定的值时,才能替换指定键的条目。void
replaceAll(BiFunction<? super K,? super V,? extends V> function)
将每个条目的值替换为对该条目调用给定函数的结果,直到所有条目都被处理或该函数抛出异常。int
size()
返回此地图中键值映射的数量。Collection<V>
values()
返回此地图中包含的值的Collection
视图。-
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
-
-
-
构造方法详细信息
-
HashMap
public HashMap(int initialCapacity, float loadFactor)
构造一个空的HashMap
具有指定的初始容量和负载因子。- 参数
-
initialCapacity
- 初始容量 -
loadFactor
- 负载因子 - 异常
-
IllegalArgumentException
- 如果初始容量为负值或负载系数为正数
-
HashMap
public HashMap(int initialCapacity)
构造一个空的HashMap
具有指定的初始容量和默认负载因子(0.75)。- 参数
-
initialCapacity
- 初始容量。 - 异常
-
IllegalArgumentException
- 如果初始容量为负。
-
HashMap
public HashMap()
构造一个空的HashMap
,默认初始容量(16)和默认负载因子(0.75)。
-
HashMap
public HashMap(Map<? extends K,? extends V> m)
构造一个新的HashMap
具有与指定的Map
相同的映射。HashMap
以默认负载因子(0.75)创建,初始容量足以容纳指定的Map
的映射。- 参数
-
m
- 其映射将放置在此映射中的映射 - 异常
-
NullPointerException
- 如果指定的地图为空
-
-
方法详细信息
-
size
public int size()
返回此地图中键值映射的数量。
-
isEmpty
public boolean isEmpty()
如果此映射不包含键值映射,则返回true
。
-
get
public V get(Object key)
返回指定键映射到的值,如果此映射不包含该键的映射,则返回null
。更正式地,如果此映射包含从密钥映射
k
到值v
使得(key==null ? k==null : key.equals(k))
,则此方法返回v
; 否则返回null
。 (最多可以有一个这样的映射。)返回值为
null
并不一定表示该映射不包含该键的映射; 地图也可能明确地将密钥映射到null
。 可以使用containsKey
操作来区分这两种情况。- Specified by:
-
get
在接口Map<K,V>
- 重写:
-
get
AbstractMap<K,V>
- 参数
-
key
- 要返回其关联值的键 - 结果
-
指定键映射到的值,如果此映射不包含键的映射,
null
- 另请参见:
-
put(Object, Object)
-
containsKey
public boolean containsKey(Object key)
如果此映射包含指定键的映射,则返回true
。- Specified by:
-
containsKey
在接口Map<K,V>
- 重写:
-
containsKey
在AbstractMap<K,V>
- 参数
-
key
- 要在此地图中存在的密钥要进行测试 - 结果
-
true
如果此映射包含指定键的映射。
-
putAll
public void putAll(Map<? extends K,? extends V> m)
将指定地图的所有映射复制到此地图。 这些映射将替换此映射对当前在指定映射中的任何键的任何映射。- Specified by:
-
putAll
在接口Map<K,V>
- 重写:
-
putAll
在AbstractMap<K,V>
- 参数
-
m
- 要存储在此地图中的映射 - 异常
-
NullPointerException
- 如果指定的地图为空
-
clear
public void clear()
从这张地图中删除所有的映射。 此呼叫返回后,地图将为空。
-
containsValue
public boolean containsValue(Object value)
如果此映射将一个或多个键映射到指定的值,则返回true
。- Specified by:
-
containsValue
在接口Map<K,V>
- 重写:
-
containsValue
在AbstractMap<K,V>
- 参数
-
value
- 要在此地图中存在的值要进行测试 - 结果
-
true
如果该地图将一个或多个键映射到指定的值
-
keySet
public Set<K> keySet()
返回此地图中包含的键的Set
视图。 该集合由地图支持,因此对地图的更改将反映在集合中,反之亦然。 如果在集合中的迭代正在进行中修改映射(除了通过迭代器自己的remove
操作),迭代的结果是未定义的。 该组支持元件移除,即从映射中相应的映射,经由Iterator.remove
,Set.remove
,removeAll
,retainAll
,和clear
操作。 它不支持add
或addAll
操作。
-
values
public Collection<V> values()
返回此地图中包含的值的Collection
视图。 集合由地图支持,因此对地图的更改将反映在集合中,反之亦然。 如果在集合中的迭代正在进行中修改映射(除了通过迭代器自己的remove
操作),迭代的结果是未定义的。 该collection支持元素移除,即从映射中相应的映射,经由Iterator.remove
,Collection.remove
,removeAll
,retainAll
和clear
操作。 它不支持add
或addAll
操作。
-
entrySet
public Set<Map.Entry<K,V>> entrySet()
返回此地图中包含的映射的Set
视图。 该集合由地图支持,因此对地图的更改将反映在集合中,反之亦然。 如果在集合中的迭代正在进行时修改映射(除了通过迭代器自己的remove
操作,或者通过迭代器返回的映射条目上的setValue
操作),迭代的结果是未定义的。 该组支持元件移除,即从映射中相应的映射,经由Iterator.remove
,Set.remove
,removeAll
,retainAll
和clear
操作。 它不支持add
或addAll
操作。
-
getOrDefault
public V getOrDefault(Object key, V defaultValue)
描述从接口Map
复制返回指定键映射到的值,如果此映射不包含键的映射,则返回defaultValue
。- Specified by:
-
getOrDefault
在接口Map<K,V>
- 参数
-
key
- 要返回其关联值的键 -
defaultValue
- 键的默认映射 - 结果
-
指定键映射到的值,如果此映射不包含该键的映射,
defaultValue
-
putIfAbsent
public V putIfAbsent(K key, V value)
说明从接口Map
复制如果指定的键尚未与某个值相关联(或映射到null
),null
其与给定值相关联并返回null
,否则返回当前值。- Specified by:
-
putIfAbsent
在接口Map<K,V>
- 参数
-
key
- 指定值与之关联的键 -
value
- 与指定键相关联的值 - 结果
-
与指定键相关联的上一个值,如果没有键的映射,
null
。 (Anull
返回也可以指示映射以前关联的是null
,如果实现支持空值)。
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
如果指定的键尚未与值相关联(或映射到null
),则尝试使用给定的映射函数计算其值,并将其输入到此映射中,除非null
。如果映射函数返回
null
,则不记录映射。 如果映射函数本身引发(未检查)异常,则重新抛出异常,并且不记录映射。 最常见的用法是构造一个用作初始映射值或记忆结果的新对象,如:map.computeIfAbsent(key, k -> new Value(f(k)));
或者实现一个多值地图,
Map<K,Collection<V>>
,每个键支持多个值:map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);
映射函数在计算过程中不应该修改该映射。
如果在计算过程中检测到映射函数修改了该映射,则该方法将尽力而为地抛出
ConcurrentModificationException
。- Specified by:
-
computeIfAbsent
在接口Map<K,V>
- 参数
-
key
- 指定值与之关联的键 -
mappingFunction
- 计算值的映射函数 - 结果
- 与指定键相关联的当前(现有或计算)值,如果计算值为空,则为null
- 异常
-
ConcurrentModificationException
- 如果检测到映射函数修改了此映射
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
如果指定的密钥的值存在且非空,则尝试计算给定密钥及其当前映射值的新映射。如果重映射函数返回
null
,则映射将被删除。 如果重映射函数本身引发(未检查)异常,则重新引导异常,并且当前映射保持不变。重映射功能在计算过程中不应修改此映射。
如果检测到重新映射功能在计算过程中修改了该映射,则该方法将尽力而为地抛出
ConcurrentModificationException
。- Specified by:
-
computeIfPresent
在接口Map<K,V>
- 参数
-
key
- 指定值与之关联的键 -
remappingFunction
- 用于计算值的重映射函数 - 结果
- 与指定键相关的新值,如果没有则为null
- 异常
-
ConcurrentModificationException
- 如果检测到重映射功能修改了该地图
-
compute
public V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
尝试计算指定密钥及其当前映射值的映射(如果没有当前映射,则null
)。 例如,要为值映射创建或附加String
msg:map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))
merge()
通常更简单地用于这些目的。)如果重映射函数返回
null
,则映射将被删除(如果最初不存在则保持不存在)。 如果重映射函数本身引发(未检查)异常,则重新引导异常,并且当前映射保持不变。重映射功能在计算过程中不应修改此映射。
如果检测到重新映射功能在计算过程中修改了该映射,则该方法将尽力而为地抛出
ConcurrentModificationException
。- Specified by:
-
compute
在接口Map<K,V>
- 参数
-
key
- 要与指定值相关联的键 -
remappingFunction
- 计算值的重映射函数 - 结果
- 与指定键相关的新值,如果没有则为null
- 异常
-
ConcurrentModificationException
- 如果检测到重映射功能修改了该地图
-
merge
public V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
如果指定的键尚未与值相关联或与null相关联,则将其与给定的非空值相关联。 否则,将关联值替换为给定重映射函数的结果,如果结果为null
,则将其null
。 当组合键的多个映射值时,该方法可能是有用的。 例如,要创建或附加String msg
到值映射:map.merge(key, msg, String::concat)
如果重映射函数返回
null
,则映射将被删除。 如果重映射函数本身引发(未检查)异常,则重新引导异常,并且当前映射保持不变。重映射功能在计算过程中不应修改此映射。
如果检测到重新映射功能在计算过程中修改了该映射,这种方法将尽力而为地抛出一个
ConcurrentModificationException
。- Specified by:
-
merge
在接口Map<K,V>
- 参数
-
key
- 与结果值相关联的键 -
value
- 要与与密钥相关联的现有值合并的非空值,或者如果没有现有值或与值相关联的空值与密钥相关联 -
remappingFunction
- 如果存在重新计算值的重映射功能 - 结果
- 与指定键相关联的新值,如果没有值与该键相关联,则返回null
- 异常
-
ConcurrentModificationException
- 如果检测到重映射功能修改了该地图
-
forEach
public void forEach(BiConsumer<? super K,? super V> action)
描述从接口Map
复制对此映射中的每个条目执行给定的操作,直到所有条目都被处理或操作引发异常。 除非实现类另有指定,否则按照进入设置迭代的顺序执行操作(如果指定了迭代顺序)。操作引发的异常被转发给调用者。
-
replaceAll
public void replaceAll(BiFunction<? super K,? super V,? extends V> function)
描述从接口Map
复制将每个条目的值替换为对该条目调用给定函数的结果,直到所有条目都被处理或该函数抛出异常。 函数抛出的异常被转发给调用方。- Specified by:
-
replaceAll
在接口Map<K,V>
- 参数
-
function
- 应用于每个条目的功能
-
-