EnumMap

java.lang.Object

|---java.util.AbstractMap<K,V&

|---|---java.util.EnumMap<K,V&

public class EnumMap<K extends Enum<K>,V>
extends AbstractMap<K,V>
implements Serializable, Cloneable

用于枚举类型键的专用 Map 实现。 枚举映射中的所有键都必须来自创建映射时显式或隐式指定的单个枚举类型。 枚举映射在内部表示为数组。 这种表示非常紧凑和高效。

枚举映射以其键的自然顺序（声明枚举常量的顺序）维护。这反映在集合视图（keySet()、entrySet() 和 values()）返回的迭代器中。

集合视图返回的迭代器是弱一致的：它们永远不会抛出 ConcurrentModificationException 并且它们可能会或可能不会显示在迭代过程中对映射进行的任何修改的影响。

不允许使用空键。尝试插入空键将引发 NullPointerException。但是，尝试测试是否存在空键或删除空键将正常运行。允许空值。

像大多数集合实现一样，EnumMap 是不同步的。如果多个线程同时访问一个枚举映射，并且至少有一个线程修改了映射，则它应该在外部同步。这通常是通过同步一些自然封装枚举映射的对象来完成的。如果不存在这样的对象，则应使用 Collections#synchronizedMap 方法“包装”地图。这最好在创建时完成，以防止意外的不同步访问：

     Map<EnumKey, V> m
         = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...));

实施说明：所有基本操作都在恒定时间内执行。 它们很可能（尽管不能保证）比它们的 HashMap 对应物更快。

此类是 Java 集合框架的成员。

嵌套类摘要

从类 java.util.AbstractMap 继承的嵌套类/接口
AbstractMap.SimpleEntryK,V, AbstractMap.SimpleImmutableEntryK,V

从接口 java.util.Map 继承的嵌套类/接口
Map.EntryK,V

构造函数摘要

构造函数	描述
EnumMap(ClassK keyType)	创建具有指定键类型的空枚举映射。
EnumMap(EnumMap<K,? extends V> m)	创建一个与指定枚举映射具有相同键类型的枚举映射，最初包含相同的映射（如果有）。
EnumMap(Map<K,? extends V> m)	创建一个从指定映射初始化的枚举映射。

方法总结

修饰符和类型	方法	描述
void	clear()	从此映射中删除所有映射。
EnumMapK,V	clone()	返回此枚举映射的浅表副本。
boolean	containsKey(Object key)	如果此映射包含指定键的映射，则返回 true。
boolean	containsValue(Object value)	如果此映射将一个或多个键映射到指定值，则返回 true。
SetMap.EntryK,V	entrySet()	返回此映射中包含的映射的 Set 视图。
boolean	equals(Object o)	比较指定对象与此映射是否相等。
V	get(Object key)	返回指定键映射到的值，如果此映射不包含该键的映射，则返回 null。
int	hashCode()	返回此映射的哈希码值。
SetK	keySet()	返回此映射中包含的键的 Set 视图。
V	put(K key, V value)	将指定的值与此映射中的指定键相关联。
void	putAll(Map<? extends K,? extends V> m)	将所有映射从指定映射复制到此映射。
V	remove(Object key)	如果存在，则从此映射中删除此键的映射。
int	size()	返回此映射中键值映射的数量。
CollectionV	values()	返回此映射中包含的值的集合视图。

从类 java.util.AbstractMap 继承的方法
isEmpty, toString

从接口 java.util.Map 继承的方法
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

从类 java.lang.Object 继承的方法
finalize, getClass, notify, notifyAll, wait, wait, wait

构造函数详细信息

EnumMap

public EnumMap(ClassK keyType)

创建具有指定键类型的空枚举映射。

参数：

参数名称	参数描述
keyType	此枚举映射的键类型的类对象

Throws:

Throw名称	Throw描述
NullPointerException	如果 keyType 为空

EnumMap

public EnumMap(EnumMap<K,? extends V> m)

创建一个与指定枚举映射具有相同键类型的枚举映射，最初包含相同的映射（如果有）。

参数：

参数名称	参数描述
m	从中初始化此枚举映射的枚举映射

Throws:

Throw名称	Throw描述
NullPointerException	如果 m 为空

EnumMap

public EnumMap(Map<K,? extends V> m)

创建一个从指定映射初始化的枚举映射。 如果指定的映射是 EnumMap 实例，则此构造函数的行为与 EnumMap(java.util.EnumMap) 相同。 否则，指定的映射必须包含至少一个映射（以确定新枚举映射的键类型）。

参数：

参数名称	参数描述
m	从中初始化此枚举映射的映射

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 m 不是 EnumMap 实例并且不包含映射
NullPointerException	如果 m 为空

方法详情

size

public int size()

返回此映射中键值映射的数量。

指定者：

接口 Map<K 中的大小扩展 EnumK,V>

覆盖：

类 AbstractMap<K extends EnumK,V> 中的大小

返回:

此映射中的键值映射的数量

containsValue

public boolean containsValue(Object value)

如果此映射将一个或多个键映射到指定值，则返回 true。

指定者：

接口 Map<K extends EnumK,V> 中的 containsValue

覆盖：

类 AbstractMap<K extends EnumK,V> 中的 containsValue

参数：

参数名称	参数描述
value	要测试其在此映射中的存在的值

返回:

如果此映射将一个或多个键映射到此值，则为 true

containsKey

public boolean containsKey(Object key)

如果此映射包含指定键的映射，则返回 true。

指定者：

接口 Map<K extends EnumK,V> 中的 containsKey

覆盖：

类 AbstractMap<K extends EnumK,V> 中的 containsKey

参数：

参数名称	参数描述
key	要测试其在此映射中的存在的键

返回:

如果此映射包含指定键的映射，则为 true

get

public V get(Object key)

返回指定键映射到的值，如果此映射不包含该键的映射，则返回 null。

更正式地说，如果此映射包含从键 k 到值 v 的映射，使得 (key == k)，则此方法返回 v； 否则返回null。 （最多可以有一个这样的映射。）

返回值为 null 并不一定表示该映射不包含该键的映射； 映射也可能将键显式映射为空。 containsKey 操作可用于区分这两种情况。

指定者：

进入接口 Map<K extends EnumK,V>

覆盖：

进入类 AbstractMap<K extends EnumK,V>

参数：

参数名称	参数描述
key	要返回其关联值的键

返回:

指定键映射到的值，如果此映射不包含该键的映射，则为 null

put

public V put(K key, V value)

将指定的值与此映射中的指定键相关联。 如果映射先前包含此键的映射，则替换旧值。

指定者：

放入接口 Map<K extends EnumK,V>

覆盖：

放入类 AbstractMap<K extends EnumK,V>

参数：

参数名称	参数描述
key	与指定值关联的键
value	要与指定键关联的值

返回:

与指定键关联的先前值，如果没有键映射，则返回 null。 （返回 null 还可以指示映射先前将 null 与指定的键相关联。）

Throws:

Throw名称	Throw描述
NullPointerException	如果指定的键为空

remove

public V remove(Object key)

如果存在，则从此映射中删除此键的映射。

指定者：

在接口 Map<K extends EnumK,V> 中删除

覆盖：

在类 AbstractMap<K extends EnumK,V> 中删除

参数：

参数名称	参数描述
key	要从映射中删除其映射的键

返回:

与指定键关联的先前值，如果没有键条目，则为 null。 （返回 null 还可以指示映射先前将 null 与指定的键相关联。）

putAll

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

将所有映射从指定映射复制到此映射。 这些映射将替换此映射对当前指定映射中的任何键的任何映射。

指定者：

接口 Map<K extends EnumK,V> 中的 putAll

覆盖：

类 AbstractMap<K extends EnumK,V> 中的 putAll

参数：

参数名称	参数描述
m	要存储在此映射中的映射

Throws:

Throw名称	Throw描述
NullPointerException	指定映射为空，或者指定映射中的一个或多个键为空

clear

public void clear()

从此映射中删除所有映射。

指定者：

在接口 Map<K extends EnumK,V> 中清除

覆盖：

清除类 AbstractMap<K extends EnumK,V>

keySet

public SetK keySet()

返回此映射中包含的键的 Set 视图。 返回的集合遵守 Map#keySet() 中概述的一般约定。 集合的迭代器将按其自然顺序（声明枚举常量的顺序）返回键。

指定者：

接口 Map<K extends EnumK,V> 中的 keySet

覆盖：

类 AbstractMap<K extends EnumK,V> 中的 keySet

返回:

此枚举映射中包含的键的集合视图

values

public CollectionV values()

返回此映射中包含的值的集合视图。 返回的集合遵守 Map#values() 中概述的一般合同。 集合的迭代器将按照它们对应的键在 map 中出现的顺序返回值，这是它们的自然顺序（声明枚举常量的顺序）。

指定者：

接口 Map<K extends EnumK,V> 中的值

覆盖：

AbstractMap<K extends EnumK,V> 类中的值

返回:

此映射中包含的值的集合视图

entrySet

public SetMap.EntryK,V entrySet()

返回此映射中包含的映射的 Set 视图。 返回的集合遵守 Map#keySet() 中概述的一般约定。 集合的迭代器将按照它们的键出现在映射中的顺序返回映射，这是它们的自然顺序（声明枚举常量的顺序）。

指定者：

接口 Map<K extends EnumK,V> 中的 entrySet

指定者：

类 AbstractMap<K extends EnumK,V> 中的 entrySet

返回:

此枚举映射中包含的映射的集合视图

equals

public boolean equals(Object o)

比较指定对象与此映射是否相等。 如果给定对象也是一个映射并且两个映射表示相同的映射，则返回 true，如 Map#equals(Object) 协定中所指定的。

指定者：

接口 Map<K extends EnumK,V> 中的等于

覆盖：

类 AbstractMap<K extends EnumK,V> 中的等于

参数：

参数名称	参数描述
o	要与此 map 比较是否相等的对象

返回:

如果指定的对象等于此 map，则为 true

hashCode

public int hashCode()

返回此地图的哈希码值。 映射的哈希码定义为映射中每个条目的哈希码的总和。

指定者：

接口 Map<K extends EnumK,V> 中的 hashCode

覆盖：

AbstractMap<K extends EnumK,V> 类中的 hashCode

返回:

此映射的哈希码值

clone

public EnumMapK,V clone()

返回此枚举映射的浅表副本。值本身没有被克隆。

覆盖：

在类 AbstractMap<K extends EnumK,V> 中克隆

返回:

此枚举映射的浅表副本