ConcurrentHashMap.KeySetView (Java Platform SE 8 )

java.lang.Object
- java.util.concurrent.ConcurrentHashMap.KeySetView<K,V>

All Implemented Interfaces:

Serializable ， Iterable <K>， Collection <K>， Set <K>

Enclosing class:

ConcurrentHashMap < K ， V >
```
public static class ConcurrentHashMap.KeySetView<K,V>
extends Object
implements Set<K>, Serializable
```
ConcurrentHashMap视图为一个Set的键，其中可以通过映射到公共值来启用添加。这个类不能直接实例化。见keySet() ， keySet(V) ， newKeySet() ， newKeySet(int) 。

从以下版本开始：

1.8

另请参见：

Serialized Form

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`boolean`	`add(K e)` 通过将键映射到背景映射中的默认映射值（如果已定义），将指定的键添加到此设置视图。
`boolean`	`addAll(Collection<? extends K> c)` 将指定集合中的所有元素添加到此集合中，就像在每个元素上调用 `add(K)`一样。
`void`	`clear()` 从该视图中删除所有的元素，通过从支持此视图的地图中删除所有映射。
`boolean`	`contains(Object o)` 如果此集合包含指定的元素，则返回 `true` 。
`boolean`	`containsAll(Collection<?> c)` 如果此集合包含指定 `集合`中的所有元素，则返回true。
`boolean`	`equals(Object o)` 指示一些其他对象是否等于此。
`void`	`forEach(Consumer<? super K> action)` 对 `Iterable`的每个元素执行给定的操作，直到所有元素都被处理或动作引发异常。
`ConcurrentHashMap<K,V>`	`getMap()` 返回支持此视图的地图。
`V`	`getMappedValue()` 返回添加或默认映射值 `null` ，如果增加不被支持。
`int`	`hashCode()` 返回对象的哈希码值。
`boolean`	`isEmpty()` 如果此集合不包含元素，则返回 `true` 。
`Iterator<K>`	`iterator()` 返回此集合中的元素的迭代器。
`boolean`	`remove(Object o)` 从该地图视图中删除键，方法是从支持地图中删除该键（及其对应的值）。
`boolean`	`removeAll(Collection<?> c)` 删除指定集合中包含的所有此集合的元素（可选操作）。
`boolean`	`retainAll(Collection<?> c)` 仅保留此集合中包含在指定集合中的元素（可选操作）。
`int`	`size()` 返回此集合中的元素数。
`Spliterator<K>`	`spliterator()` 在此集合中的元素上创建一个 `Spliterator` 。
`Object[]`	`toArray()` 返回一个包含此集合中所有元素的数组。
`<T> T[]`	`toArray(T[] a)` 返回包含此集合中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。
`String`	`toString()` 返回此集合的字符串表示形式。

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

Methods inherited from interface java.util.Set
clear, containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

- 方法详细信息
  - getMappedValue
```
public V getMappedValue()
```
    返回添加或默认映射值 null ，如果增加不被支持。
    
    结果
    
    默认为添加映射值，或 null如果不支持
  - contains
```
public boolean contains(Object o)
```
    如果此集合包含指定的元素，则返回true 。更正式地，返回true当且仅当该集合包含至少一个元素e ，使得(o==null ? e==null : o.equals(e)) 。
    
    Specified by:
    
    contains在界面 Collection<K>
    
    Specified by:
    
    contains在界面 Set<K>
    
    参数
    
    o - 要在此集合中存在的元素要进行测试
    
    结果
    
    true如果此集合包含指定的元素
    
    异常
    
    NullPointerException - 如果指定的键为空
  - remove
```
public boolean remove(Object o)
```
    从该地图视图中删除键，方法是从支持地图中删除该键（及其对应的值）。如果键不在地图中，此方法不执行任何操作。
    
    Specified by:
    
    remove在界面 Collection<K>
    
    Specified by:
    
    remove在界面 Set<K>
    
    参数
    
    o - 从背景地图中删除的关键
    
    结果
    
    true如果支持地图包含指定的键
    
    异常
    
    NullPointerException - 如果指定的键为空
  - iterator
```
public Iterator<K> iterator()
```
    返回此集合中的元素的迭代器。
    返回的迭代器是weakly consistent 。
    
    Specified by:
    
    iterator在界面 Iterable<K>
    
    Specified by:
    
    iterator在界面 Collection<K>
    
    Specified by:
    
    iterator在界面 Set<K>
    
    结果
    
    在背景图上的键的迭代器
  - add
```
public boolean add(K e)
```
    通过将键映射到背景映射中的默认映射值（如果已定义），将指定的键添加到此设置视图。
    
    Specified by:
    
    add在接口 Collection<K>
    
    Specified by:
    
    add在界面 Set<K>
    
    参数
    
    e - 要添加的关键字
    
    结果
    
    true如果此设置由于呼叫而更改
    
    异常
    
    NullPointerException - 如果指定的键为空
    
    UnsupportedOperationException - 如果没有提供添加的默认映射值
  - addAll
```
public boolean addAll(Collection<? extends K> c)
```
    将指定集合中的所有元素添加到此集合中，就像在每个元素上调用 add(K)一样。
    
    Specified by:
    
    addAll在接口 Collection<K>
    
    Specified by:
    
    addAll在界面 Set<K>
    
    参数
    
    c - 要插入到此集合中的元素
    
    结果
    
    true如果此设置由于呼叫而更改
    
    异常
    
    NullPointerException - 如果集合或其任何元素是 null
    
    UnsupportedOperationException - 如果没有提供添加的默认映射值
    
    另请参见：
    
    Set.add(Object)
  - hashCode
```
public int hashCode()
```
    描述从类别： Object复制
    返回对象的哈希码值。支持这种方法有利于哈希表，如HashMap所提供的那样。
    hashCode的总合同是：
    - 只要在执行Java应用程序时多次在同一个对象上调用该方法， hashCode方法必须始终返回相同的整数，前提是修改了对象中equals比较中的信息。该整数不需要从一个应用程序的执行到相同应用程序的另一个执行保持一致。
    - 如果根据equals(Object)方法两个对象相等，则在两个对象中的每个对象上调用hashCode方法必须产生相同的整数结果。
    - 不要求如果两个对象根据Object.equals(java.lang.Object)方法不相等，则在两个对象中的每一个上调用hashCode方法必须产生不同的整数结果。但是，程序员应该意识到，为不等对象生成不同的整数结果可能会提高哈希表的性能。
    尽可能多的合理实用，由类Object定义的hashCode方法确实为不同对象返回不同的整数。（这通常通过将对象的内部地址转换为整数来实现，但Java的编程语言不需要此实现技术。）
    Specified by:
    
    hashCode在接口 Collection<K>
    
    Specified by:
    
    hashCode在界面 Set<K>
    
    重写：
    
    hashCode在类别 Object
    
    结果
    
    该对象的哈希码值。
    
    另请参见：
    
    Object.equals(java.lang.Object) ， System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object o)
```
    描述从类别： Object复制
    指示一些其他对象是否等于此。
    equals方法在非空对象引用上实现等价关系：
    - 自反性 ：对于任何非空的参考值x ， x.equals(x)应该返回true 。
    - 它是对称的 ：对于任何非空引用值x和y ， x.equals(y)应该返回true当且仅当y.equals(x)回报true 。
    - 传递性 ：对于任何非空引用值x ， y和z ，如果x.equals(y)回报true个y.equals(z)回报true ，然后x.equals(z)应该返回true 。
    - 它是一致的 ：对于任何非空引用值x和y ，多次调用x.equals(y)始终返回true或始终返回false ，没有设置中使用的信息equals比较上的对象被修改。
    - 对于任何非空的参考值x ， x.equals(null)应该返回false 。
    该equals类方法Object实现对象上差别可能性最大的相等关系; 也就是说，对于任何非空参考值x和y ，当且仅当x和y引用同一对象（ x == y具有值true ）时，此方法返回true 。
    
    请注意，当覆盖该方法时，通常需要覆盖hashCode方法，以便维护hashCode方法的通用合同，该方法规定相等的对象必须具有相等的哈希码。
    Specified by:
    
    equals在界面 Collection<K>
    
    Specified by:
    
    equals在界面 Set<K>
    
    重写：
    
    equals在类别 Object
    
    参数
    
    o - 与之比较的参考对象。
    
    结果
    
    true如果此对象与obj参数相同; false否则。
    
    另请参见：
    
    Object.hashCode() ， HashMap
  - spliterator
```
public Spliterator<K> spliterator()
```
    说明从界面： Set复制
    
    在此集合中的元素上创建一个Spliterator 。
    Spliterator报告Spliterator.DISTINCT 。实施应记录其他特征值的报告。
    
    Specified by:
    
    spliterator在界面 Iterable<K>
    
    Specified by:
    
    spliterator在界面 Collection<K>
    
    Specified by:
    
    spliterator在界面 Set<K>
    
    结果
    
    一个 Spliterator在这个集合中的元素
  - forEach
```
public void forEach(Consumer<? super K> action)
```
    说明从界面： Iterable复制
    
    对Iterable的每个元素执行给定的操作，直到所有元素都被处理或者动作引发异常。除非实现类另有规定，否则按照迭代的顺序执行操作（如果指定了迭代顺序）。动作抛出的异常被转发给呼叫者。
    
    Specified by:
    
    forEach在接口 Iterable<K>
    
    参数
    
    action - 要为每个元素执行的操作
  - getMap
```
public ConcurrentHashMap<K,V> getMap()
```
    返回支持此视图的地图。
    
    结果
    
    地图支持此视图
  - clear
```
public final void clear()
```
    从该视图中删除所有的元素，通过从支持此视图的地图中删除所有映射。
    
    Specified by:
    
    clear在界面 Collection<E>
  - size
```
public final int size()
```
    说明从界面： Collection复制
    
    返回此集合中的元素数。如果此集合包含超过Integer.MAX_VALUE个元素，则返回Integer.MAX_VALUE 。
    
    Specified by:
    
    size在界面 Collection<E>
    
    结果
    
    此集合中的元素数
  - isEmpty
```
public final boolean isEmpty()
```
    说明从界面： Collection复制
    
    如果此集合不包含元素，则返回 true 。
    
    Specified by:
    
    isEmpty在界面 Collection<E>
    
    结果
    
    true如果此集合不包含元素
  - toArray
```
public final Object[] toArray()
```
    说明从界面： Collection复制
    
    返回一个包含此集合中所有元素的数组。如果此集合对其迭代器返回的元素的顺序做出任何保证，则此方法必须以相同的顺序返回元素。
    返回的数组将是“安全的”，因为该集合不保留对它的引用。（换句话说，这个方法必须分配一个新的数组，即使这个集合是由数组支持的）。因此，调用者可以自由地修改返回的数组。
    
    此方法充当基于阵列和基于集合的API之间的桥梁。
    
    Specified by:
    
    toArray在界面 Collection<E>
    
    结果
    
    一个包含此集合中所有元素的数组
  - toArray
```
public final <T> T[] toArray(T[] a)
```
    说明从界面： Collection复制
    返回包含此集合中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。如果集合适合指定的数组，则返回其中。否则，将为指定数组的运行时类型和此集合的大小分配一个新数组。
    如果此集合适合指定的数组，并具有空余空间（即，该数组的元素多于此集合），则集合结束后的数组中的元素将设置为null 。（仅当调用者知道此集合不包含任何null元素时，此方法才有助于确定此集合的长度。）
    
    如果此集合对其迭代器返回的元素的顺序做出任何保证，则此方法必须以相同的顺序返回元素。
    
    像Collection.toArray()方法一样，此方法充当基于数组和基于集合的API之间的桥梁。此外，该方法允许精确地控制输出阵列的运行时类型，并且在某些情况下可以用于节省分配成本。
    
    假设x是一个已知只包含字符串的集合。下面的代码可用于收集转储到的String一个新分配的数组：
```
  String[] y = x.toArray(new String[0]); 
```
    请注意， toArray(new Object[0])的功能与toArray()相同 。
    Specified by:
    
    toArray在接口 Collection<E>
    
    参数类型
    
    T - 包含集合的数组的运行时类型
    
    参数
    
    a - 要a该集合的元素的数组，如果它足够大; 否则，为此目的分配相同运行时类型的新数组。
    
    结果
    
    一个包含此集合中所有元素的数组
  - toString
```
public final String toString()
```
    返回此集合的字符串表示形式。字符串表示由集合的元素的字符串表示形式组成，按照它们的迭代器返回的顺序，括在方括号（ "[]" ）中。相邻元素由字符", " （逗号和空格）分隔。元素被转换为字符串由String.valueOf(Object) 。
    
    重写：
    
    toString在类别 Object
    
    结果
    
    此集合的字符串表示形式
  - containsAll
```
public final boolean containsAll(Collection<?> c)
```
    说明从界面： Collection复制
    
    如果此集合包含指定 集合中的所有元素，则返回true。
    
    Specified by:
    
    containsAll在界面 Collection<E>
    
    参数
    
    c - 要在此集合中检查遏制的集合
    
    结果
    
    true如果此集合包含指定集合中的所有元素
    
    另请参见：
    
    Collection.contains(Object)
  - removeAll
```
public final boolean removeAll(Collection<?> c)
```
    说明从界面： Collection复制
    
    删除指定集合中包含的所有此集合的元素（可选操作）。此调用返回后，此集合将不包含与指定集合相同的元素。
    
    Specified by:
    
    removeAll在界面 Collection<E>
    
    参数
    
    c - 包含要从此集合中删除的元素的集合
    
    结果
    
    true如果此集合由于调用而更改
    
    另请参见：
    
    Collection.remove(Object) ， Collection.contains(Object)
  - retainAll
```
public final boolean retainAll(Collection<?> c)
```
    描述从接口： Collection复制
    
    仅保留此集合中包含在指定集合中的元素（可选操作）。换句话说，从该集合中删除所有不包含在指定集合中的元素。
    
    Specified by:
    
    retainAll在界面 Collection<E>
    
    参数
    
    c - 包含要保留在此集合中的元素的集合
    
    结果
    
    true如果此集合由于调用而更改
    
    另请参见：
    
    Collection.remove(Object), Collection.contains(Object)

Class ConcurrentHashMap.KeySetView<K,V>

方法摘要

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

方法详细信息

getMappedValue

contains

remove

iterator

add

addAll

hashCode

equals

spliterator

forEach

getMap

clear

size

isEmpty

toArray

toArray

toString

containsAll

removeAll

retainAll