Set (Java Platform SE 8 )

参数类型

E -元素这一套保持型

All Superinterfaces:

Collection ， Iterable

All Known Subinterfaces:

NavigableSet ， SortedSet

所有已知实现类：

AbstractSet， ConcurrentHashMap.KeySetView， ConcurrentSkipListSet， CopyOnWriteArraySet， EnumSet， HashSet， JobStateReasons， LinkedHashSet， TreeSet
```
public interface Set<E>
extends Collection<E>
```
包含没有重复元素的集合。更正式地，集不包含对元素 e1和 e2这样 e1.equals(e2)，最多一个空元素。正如它的名字所暗示的，这个接口模型的数学设置抽象。
Set接口的地方补充规定，除了那些从Collection接口继承，对所有施工合同和对add合同，equals和hashCode方法。为方便起见，也包括其他继承方法的声明。（伴随这些声明的规格已经根据Set接口，但它们不包含任何额外的规定。）

对构造函数的附加约束，也不奇怪，所有的构造函数必须创建一个包含没有重复元素的集合（如上所定义）。

注意：必须非常小心行使如果使用可变对象作为集合元素。一个集合的行为不是一个对象的值是以影响equals比较在对象集合中的指定元素变化。此禁令的一个特殊情况是，它是不允许一组包含本身作为一个元素。

某些设置的实现对它们可能包含的元素有限制。例如，一些实现禁止空元素，并且一些实现对它们的元素的类型有限制。试图插入一个不合适的元素会抛出未检查异常，通常NullPointerException或ClassCastException。试图查询一个不合适的元素的存在可能会抛出一个异常，也可能返回false；有些实现会表现出以前的行为和表现出后者。更普遍的是，试图在一个不合格的操作元素的完成将不会导致一个不合格的元件插入集可能会抛出一个异常，也可能是成功的，在实施期权。这样的异常被标记为“可选”在该接口的规范中。

该接口的 Java Collections Framework成员。

从以下版本开始：

一点二

另请参见：

Collection， List， SortedSet， HashSet， TreeSet， AbstractSet， Collections.singleton(java.lang.Object)， Collections.EMPTY_SET

方法摘要

所有方法接口方法抽象方法 Default Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)` 如果没有当前（可选操作），则将指定的元素添加到该集合中。
`boolean`	`addAll(Collection<? extends E> c)` 如果没有当前（可选操作），将指定集合中的所有元素添加到该集合中。
`void`	`clear()` 从这个集合中移除所有的元素（可选操作）。
`boolean`	`contains(Object o)` 如果这套 `true`返回包含指定的元素。
`boolean`	`containsAll(Collection<?> c)` 如果这套 `true`返回包含指定集合的所有元素。
`boolean`	`equals(Object o)` 将指定的对象与此设置的相等性进行比较。
`int`	`hashCode()` 返回此组的哈希代码值。
`boolean`	`isEmpty()` 返回 `true`如果这个集合不包含元素。
`Iterator<E>`	`iterator()` 返回此集合中元素的迭代器。
`boolean`	`remove(Object o)` 如果当前（可选操作），则从该集合中移除指定的元素。
`boolean`	`removeAll(Collection<?> c)` 从这个集合中移除包含在指定集合中的所有元素（可选操作）。
`boolean`	`retainAll(Collection<?> c)` 仅保留包含在指定集合中的此集合中的元素（可选操作）。
`int`	`size()` 返回该集合中元素个数（其基数）。
`default Spliterator<E>`	`spliterator()` 在这个集合中的元素创建一个 `Spliterator`。
`Object[]`	`toArray()` 返回一个包含此集合中所有元素的数组。
`<T> T[]`	`toArray(T[] a)` 返回包含此集合中的所有元素的数组；返回的数组的运行时类型是指定的数组的运行时类型。

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

Methods inherited from interface java.lang.Iterable
forEach

- 方法详细信息
  - size
```
int size()
```
    返回该集合中元素个数（其基数）。如果这一套包含多 Integer.MAX_VALUE元素，返回 Integer.MAX_VALUE。
    
    Specified by:
    
    size 接口 Collection<E>
    
    结果
    
    在这一集的元素个数（其基数）
  - isEmpty
```
boolean isEmpty()
```
    返回 true如果这个集合不包含元素。
    
    Specified by:
    
    isEmpty 接口 Collection<E>
    
    结果
    
    true如果这个集合不包含元素
  - contains
```
boolean contains(Object o)
```
    如果这套 true返回包含指定的元素。更正式地说，返回 true当且仅当本集包含一个元素 e这样 (o==null ? e==null : o.equals(e))。
    
    Specified by:
    
    contains 接口 Collection<E>
    
    参数
    
    o -这个集合中存在的元素进行测试
    
    结果
    
    如果这套 true包含指定的元素
    
    异常
    
    ClassCastException -如果指定元素的类型与设置不兼容（ optional）
    
    NullPointerException -如果指定元素为null，这套不允许null元素（ optional）
  - iterator
```
Iterator<E> iterator()
```
    返回此集合中元素的迭代器。元素的返回没有特定的顺序（除非这个集合是某些类的一个实例，提供了保证）。
    
    Specified by:
    
    iterator 接口 Collection<E>
    
    Specified by:
    
    iterator 接口 Iterable<E>
    
    结果
    
    在此集合中的元素的迭代器
  - toArray
```
Object[] toArray()
```
    返回一个包含此集合中所有元素的数组。如果此集对迭代器返回的顺序有任何保证，则该方法必须以相同的顺序返回元素。
    返回的数组将是“安全”的，没有引用它是由这个设置。换句话说，这种方法必须分配一个新的数组，即使这个集合是由一个数组的支持。因此，调用方可以自由修改返回的数组。
    
    此方法作为基于数组和基于集合的原料药之间的桥梁。
    
    Specified by:
    
    toArray 接口 Collection<E>
    
    结果
    
    包含此集合中所有元素的数组
  - toArray
```
<T> T[] toArray(T[] a)
```
    返回包含此集合中的所有元素的数组；返回的数组的运行时类型是指定的数组的运行时类型。如果该集符合指定的数组，则返回该数组中的。否则，将在指定数组的运行时类型和该集合的大小分配一个新的数组。
    如果这一套适合指定数组中剩余的空间（即数组有比这个设置更多的元素），在阵列的设置结束后立即的元素设置为null。（这是有用的在确定这套只有长度如果调用者知道这集不包含任何无效的元素。）
    
    如果此集对迭代器返回的顺序有任何保证，则该方法必须以相同的顺序返回元素。
    
    像toArray()方法，该方法作为之间的桥梁，基于阵列和基于集合API。此外，该方法允许对输出数组的运行时类型的精确控制，并在某些情况下，可用于节省分配成本。
    
    假设x是一组已知仅包含字符串。下面的代码可以用来堆集到新分配的数组String：
```
字符串[] y = x.toarray（新弦[ 0 ]）；
```
    注意 toArray(new Object[0])是相同的功能， toArray()。
    Specified by:
    
    toArray 接口 Collection<E>
    
    参数类型
    
    T -数组的运行时类型包含集合
    
    参数
    
    a -在这个集合中的元素被存储数组，如果它足够大；否则，一个新的运行时类型相同的数组分配给这个目的。
    
    结果
    
    包含此集合中所有元素的数组
    
    异常
    
    ArrayStoreException -如果指定数组的运行时类型不是超set中每个元素运行时类型
    
    NullPointerException -如果指定的数组是空的
  - add
```
boolean add(E e)
```
    如果没有当前（可选操作），则将指定的元素添加到该集合中。更正式，添加指定的元素 e这套如果集合不包含元素 e2这样 (e==null ? e2==null : e.equals(e2))。如果这一套已经包含元素，电话离开设定不变，返回 false。在结合与构造函数的限制，这将确保设置不包含重复元素。
    以上的规定并不意味着必须接受所有元素；集可能不添加任何特定的元素，包括null，并抛出一个异常，如说明书中所描述的Collection.add。单独的设置实现应该清楚地记录他们可能包含的元素的任何限制。
    
    Specified by:
    
    add 接口 Collection<E>
    
    参数
    
    e元素被添加到这个组
    
    结果
    
    如果这套 true已经不包含指定的元素
    
    异常
    
    UnsupportedOperationException -如果 add操作set不支持
    
    ClassCastException -如果指定元素类型阻止其加入集
    
    NullPointerException -如果指定元素为null，这套不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入集
  - remove
```
boolean remove(Object o)
```
    如果当前（可选操作），则从该集合中移除指定的元素。更正式地说，删除一个元素 e这样 (o==null ? e==null : o.equals(e))，如果这个集合包含的元素。返回 true如果这组包含的元素（或等价的，如果调用的结果这套改）。（此设置将不包含调用返回的元素。）
    
    Specified by:
    
    remove 接口 Collection<E>
    
    参数
    
    o对象要从组中删除，如果存在
    
    结果
    
    如果这套 true包含指定元素
    
    异常
    
    ClassCastException -如果指定元素的类型与设置不兼容（ optional）
    
    NullPointerException -如果指定元素为null，这套不允许null元素（ optional）
    
    UnsupportedOperationException -如果 remove操作set不支持
  - containsAll
```
boolean containsAll(Collection<?> c)
```
    如果这套 true返回包含指定集合的所有元素。如果指定的集合也是一个set，如果它是一个子集这套方法返回 true。
    
    Specified by:
    
    containsAll 接口 Collection<E>
    
    参数
    
    c采集被检查这套壳
    
    结果
    
    true如果这集包含指定集合的所有元素
    
    异常
    
    ClassCastException -如果指定集合的一个或多个元素的类型与此设置不兼容（ optional）
    
    NullPointerException -如果指定集合包含一个或多个null元素而设置不允许null元素（ optional），或者指定集合为空
    
    另请参见：
    
    contains(Object)
  - addAll
```
boolean addAll(Collection<? extends E> c)
```
    如果没有当前（可选操作），将指定集合中的所有元素添加到该集合中。如果指定的集合也是一个set，这 addAll操作修改set的效果是使它的值为两个集联盟。当操作正在进行中时，此操作的行为是未定义的，如果指定的集合被修改，则该操作将被修改为。
    
    Specified by:
    
    addAll 接口 Collection<E>
    
    参数
    
    c收集含有元素被添加到这个组
    
    结果
    
    true如果调用的结果这一套了
    
    异常
    
    UnsupportedOperationException -如果 addAll操作set不支持
    
    ClassCastException -如果指定集合的元素的类，防止它被添加到这个组
    
    NullPointerException -如果指定集合包含一个或多个null元素而设置不允许null元素，或者指定集合为空
    
    IllegalArgumentException -如果指定集合的一个元素的一些特性阻止其加入集
    
    另请参见：
    
    add(Object)
  - retainAll
```
boolean retainAll(Collection<?> c)
```
    仅保留包含在指定集合中的此集合中的元素（可选操作）。换句话说，从这个集合中移除所有不包含在指定集合中的元素。如果指定的集合也是一个set，这操作修改set的效果是使它的价值是两套交叉。
    
    Specified by:
    
    retainAll 接口 Collection<E>
    
    参数
    
    c收集包含元素被保留在这套
    
    结果
    
    true如果调用的结果这一套了
    
    异常
    
    UnsupportedOperationException -如果 retainAll操作set不支持
    
    ClassCastException -如果这个集合的元素的类与集合不相容（ optional）
    
    NullPointerException -如果这套包含一个null元素而指定集合不允许null元素（ optional），或者指定集合为空
    
    另请参见：
    
    remove(Object)
  - removeAll
```
boolean removeAll(Collection<?> c)
```
    从这个集合中移除包含在指定集合中的所有元素（可选操作）。如果指定的集合也是一个set，这操作修改set的效果是使它的价值是两套对称差集。
    
    Specified by:
    
    removeAll 接口 Collection<E>
    
    参数
    
    c收集包含元素要从集合中移除
    
    结果
    
    true如果调用的结果这一套了
    
    异常
    
    UnsupportedOperationException -如果 removeAll操作set不支持
    
    ClassCastException -如果这个集合的元素的类与集合不相容（ optional）
    
    NullPointerException -如果这套包含一个null元素而指定集合不允许null元素（ optional），或者指定集合为空
    
    另请参见：
    
    remove(Object)， contains(Object)
  - clear
```
void clear()
```
    从这个集合中移除所有的元素（可选操作）。此调用返回后将被清空。
    
    Specified by:
    
    clear 接口 Collection<E>
    
    异常
    
    UnsupportedOperationException -如果 clear方法set不支持
  - equals
```
boolean equals(Object o)
```
    将指定的对象与此设置的相等性进行比较。返回 true指定对象是否是一组，两组有相同的大小，和指定的每一个成员都包含在这套（或等价的，这一集的每一个成员都包含在指定的设置）。这个定义确保了在不同的设置接口的不同实现中的相等的方法工作。
    
    Specified by:
    
    equals 接口 Collection<E>
    
    重写：
    
    equals 方法重写，继承类 Object
    
    参数
    
    o对象进行比较，用这套平等
    
    结果
    
    true指定对象是否等于这套
    
    另请参见：
    
    Object.hashCode()， HashMap
  - hashCode
```
int hashCode()
```
    返回此组的哈希代码值。一个集合的哈希码定义为集合中的元素的哈希码的总和，其中的一个 null元素的哈希码被定义为零。这确保 s1.equals(s2)意味着 s1.hashCode()==s2.hashCode()任何两套 s1和 s2，由 Object.hashCode()一般合同要求。
    
    Specified by:
    
    hashCode 接口 Collection<E>
    
    重写：
    
    hashCode 方法重写，继承类 Object
    
    结果
    
    此集合的哈希代码值
    
    另请参见：
    
    Object.equals(Object)， equals(Object)
  - spliterator
```
default Spliterator<E> spliterator()
```
    在这个集合中的元素创建一个 Spliterator。
    该报告Spliterator.DISTINCT Spliterator。实现应该记录额外的特征值的报告。
    
    Specified by:
    
    spliterator 接口 Collection<E>
    
    Specified by:
    
    spliterator 接口 Iterable<E>
    
    实现要求：
    
    默认的实现创造了从设定的 Iterator后期绑定spliterator。的spliterator继承快速失败性质的集合的迭代器。
    创建Spliterator另外报道Spliterator.SIZED。
    
    Implementation Note:
    
    创建 Spliterator另外报道 Spliterator.SUBSIZED。
    
    结果
    
    在这个集合中的元素个 Spliterator
    
    从以下版本开始：
    
    一点八

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.

Interface Set<E>

方法摘要

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

方法详细信息

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

retainAll

removeAll

clear

equals

hashCode

spliterator