EnumMap (Java Platform SE 8 )

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.EnumMap<K,V>

All Implemented Interfaces:

Serializable ， Cloneable ， Map <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(java.util.Map<K, V>)方法“包装”地图。这最好在创建时完成，以防止意外的不同步访问：
```
  Map<EnumKey, V> m
         = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...)); 
```
实现注意事项：所有基本操作都在不间断的时间内执行。他们可能（虽然不能保证）比他们的HashMap同行更快。

这个班是Java Collections Framework的会员。
从以下版本开始：

1.5

另请参见：

EnumSet ， Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

构造方法摘要

构造方法
Constructor and Description
`EnumMap(类<K> keyType)` 使用指定的键类型创建一个空的枚举映射。
`EnumMap(EnumMap<K,? extends V> m)` 创建与指定的枚举映射相同的键类型的枚举映射，最初包含相同的映射（如果有）。
`EnumMap(Map<K,? extends V> m)` 创建从指定地图初始化的枚举映射。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`clear()` 从此地图中删除所有的映射。
`EnumMap<K,V>`	`clone()` 返回此枚举映射的浅拷贝。
`boolean`	`containsKey(Object key)` 如果此映射包含指定键的映射，则返回 `true` 。
`boolean`	`containsValue(Object value)` 如果此映射将一个或多个键映射到指定的值，则返回 `true` 。
`Set<Map.Entry<K,V>>`	`entrySet()` 返回此地图中包含的映射的`Set`视图。
`boolean`	`equals(Object o)` 将指定的对象与此映射进行比较以获得相等性。
`V`	`get(Object key)` 返回到指定键所映射的值，或 `null`如果此映射包含该键的映射。
`int`	`hashCode()` 返回此地图的哈希码值。
`Set<K>`	`keySet()` 返回此地图中包含的键的`Set`视图。
`V`	`put(K key, V value)` 将指定的值与此映射中的指定键相关联。
`void`	`putAll(Map<? extends K,? extends V> m)` 将指定地图的所有映射复制到此地图。
`V`	`remove(Object key)` 从该地图中删除此密钥的映射（如果存在）。
`int`	`size()` 返回此地图中键值映射的数量。
`Collection<V>`	`values()` 返回此地图中包含的值的`Collection`视图。

Methods inherited from class java.util.AbstractMap
isEmpty, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- 构造方法详细信息
  - EnumMap
```
public EnumMap(类<K> keyType)
```
    使用指定的键类型创建一个空的枚举映射。
    
    参数
    
    keyType - 此枚举映射的键类型的类对象
    
    异常
    
    NullPointerException - 如果 keyType为空
  - EnumMap
```
public EnumMap(EnumMap<K,? extends V> m)
```
    创建与指定的枚举映射相同的键类型的枚举映射，最初包含相同的映射（如果有）。
    
    参数
    
    m - 从中初始化此枚举映射的枚举映射
    
    异常
    
    NullPointerException - 如果 m为空
  - EnumMap
```
public EnumMap(Map<K,? extends V> m)
```
    创建从指定地图初始化的枚举映射。如果指定的地图是EnumMap实例，则此构造函数的行为与EnumMap(EnumMap) 相同。否则，指定的映射必须至少包含一个映射（以确定新的枚举映射的密钥类型）。
    
    参数
    
    m - 从中初始化此枚举地图的地图
    
    异常
    
    IllegalArgumentException - 如果 m不是 EnumMap实例，并且不包含映射
    
    NullPointerException - 如果 m为空
- 方法详细信息
  - size
```
public int size()
```
    返回此地图中键值映射的数量。
    
    Specified by:
    
    size在接口 Map<K extends Enum<K>,V>
    
    重写：
    
    size在类别 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    该地图中键值映射的数量
  - containsValue
```
public boolean containsValue(Object value)
```
    如果此映射将一个或多个键映射到指定的值，则返回 true 。
    
    Specified by:
    
    containsValue在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    containsValue在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    value - 要在此地图中存在的值将被测试
    
    结果
    
    true如果该地图将一个或多个键映射到此值
  - containsKey
```
public boolean containsKey(Object key)
```
    如果此映射包含指定键的映射，则返回 true 。
    
    Specified by:
    
    containsKey在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    containsKey在 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    key - 要在此地图中存在的密钥要进行测试
    
    结果
    
    true如果此映射包含指定键的映射
  - get
```
public V get(Object key)
```
    返回到指定键所映射的值，或null如果此映射包含该键的映射。
    更正式地说，如果这个地图包含从一个键k到一个值v ，这样(key == k) ，那么这个方法返回v ; 否则返回null 。（最多可以有一个这样的映射。）
    
    返回值null并不一定表示该映射不包含该键的映射; 地图也可能明确地将密钥映射到null 。可以使用containsKey操作来区分这两种情况。
    
    Specified by:
    
    get在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    get在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    key - 要返回其关联值的键
    
    结果
    
    指定键映射到的值，如果此映射不包含键的映射， null
  - put
```
public V put(K key,
             V value)
```
    将指定的值与此映射中的指定键相关联。如果地图先前包含该键的映射，则替换旧值。
    
    Specified by:
    
    put在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    put在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    key - 指定值与之关联的关键字
    
    value - 与指定键相关联的值
    
    结果
    
    与指定键相关联的上一个值，如果没有键的映射， 则为null 。（A null返回也可以指示以前关联的地图null与指定的键。）
    
    异常
    
    NullPointerException - 如果指定的键为空
  - remove
```
public V remove(Object key)
```
    从该地图中删除此密钥的映射（如果存在）。
    
    Specified by:
    
    remove在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    remove在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    key - 映射将从地图中删除的密钥
    
    结果
    
    与指定键相关联的上一个值，如果没有键的条目， 则为null 。（A null返回也可以指示以前关联的地图null与指定的键。）
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    将指定地图的所有映射复制到此地图。这些映射将替换此映射对当前在指定映射中的任何键的任何映射。
    
    Specified by:
    
    putAll在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    putAll在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    m - 要存储在此地图中的映射
    
    异常
    
    NullPointerException - 指定的地图为空，或指定地图中的一个或多个键为空
  - clear
```
public void clear()
```
    从此地图中删除所有的映射。
    
    Specified by:
    
    clear在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    clear在类别 AbstractMap<K extends Enum<K>,V>
  - keySet
```
public Set<K> keySet()
```
    返回此地图中包含的键的Set视图。返回的集合遵守Map.keySet()中概述的总体合同。集合的迭代器将以自然顺序返回键（枚举常量的声明顺序）。
    
    Specified by:
    
    keySet在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    keySet在类别 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    该枚举地图中包含的键的集合视图
  - values
```
public Collection<V> values()
```
    返回此地图中包含的值的Collection视图。返回的集合遵守中描述的一般合同Map.values() 。集合的迭代器将按照它们对应的键在map中显示的顺序返回值，这是它们的自然顺序（枚举常量被声明的顺序）。
    
    Specified by:
    
    values在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    values在类别 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    该地图中包含的值的集合视图
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    返回此地图中包含的映射的Set视图。返回的集合遵守Map.keySet()中概述的总体合同。集合的迭代器将按照它们的键在映射中显示的顺序返回映射，这是它们的自然顺序（枚举常量被声明的顺序）。
    
    Specified by:
    
    entrySet在界面 Map<K extends Enum<K>,V>
    
    Specified by:
    
    entrySet在 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    该枚举地图中包含的映射的集合视图
  - equals
```
public boolean equals(Object o)
```
    将指定的对象与此映射进行比较以获得相等性。返回true如果给定的对象也是一个地图，并且两个地图代表与Map.equals(Object)合同中规定的相同的映射。
    
    Specified by:
    
    equals在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    equals在类别 AbstractMap<K extends Enum<K>,V>
    
    参数
    
    o - 要与此映射相等的对象进行比较
    
    结果
    
    true如果指定的对象等于此映射
    
    另请参见：
    
    Object.hashCode() ， HashMap
  - hashCode
```
public int hashCode()
```
    返回此地图的哈希码值。地图的哈希码被定义为地图中每个条目的哈希码的总和。
    
    Specified by:
    
    hashCode在界面 Map<K extends Enum<K>,V>
    
    重写：
    
    hashCode在类别 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    该地图的哈希码值
    
    另请参见：
    
    Map.Entry.hashCode() ， Object.equals(Object) ， Set.equals(Object)
  - clone
```
public EnumMap<K,V> clone()
```
    返回此枚举映射的浅拷贝。（值本身不被克隆。
    
    重写：
    
    clone在类别 AbstractMap<K extends Enum<K>,V>
    
    结果
    
    这个枚举地图的浅色副本
    
    另请参见：
    
    Cloneable

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class EnumMap<K extends Enum<K>,V>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

构造方法摘要

方法摘要

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

构造方法详细信息

EnumMap

EnumMap

EnumMap

方法详细信息

size

containsValue

containsKey

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

clone