JavaTM Platform
Standard Ed. 6

java.util.concurrent
类 CopyOnWriteArraySet<E>

java.lang.Object
  继承者 java.util.AbstractCollection<E>
      继承者 java.util.AbstractSet<E>
          继承者 java.util.concurrent.CopyOnWriteArraySet<E>
类型参数:
E - 此 collection 中所保存元素的类型
所有已实现的接口:
Serializable, Iterable<E>, Collection<E>, Set<E>

public class CopyOnWriteArraySet<E>
extends AbstractSet<E>
implements Serializable

对其所有操作使用内部 CopyOnWriteArrayListSet。因此,它共享以下相同的基本属性:

示例用法。 以下代码使用一个写时复制(copy-on-write)的 set,以维护在状态更新时执行某项操作的一组 Handler 对象。

 class Handler { void handle(); ... }

 class X {
    private final CopyOnWriteArraySet<Handler> handlers = new CopyOnWriteArraySet<Handler>();
    public void addHandler(Handler h) { handlers.add(h); }

    private long internalState;
    private synchronized void changeState() { internalState = ...; }

    public void update() {
       changeState();
       for (Handler handler : handlers)
           handler.handle();
    }
 }
 

此类是 Java Collections Framework 的成员。

从以下版本开始:
1.5
另请参见:
CopyOnWriteArrayList, 序列化表格

构造方法摘要
CopyOnWriteArraySet()
          创建一个空 set。
CopyOnWriteArraySet(Collection<? extends E> c)
          创建一个包含指定 collection 所有元素的 set。
 
方法摘要
 boolean add(E e)
          如果指定元素并不存在于此 set 中,则添加它。
 boolean addAll(Collection<? extends E> c)
          如果此 set 中没有指定 collection 中的所有元素,则将它们都添加到此 set 中。
 void clear()
          移除此 set 中的所有元素。
 boolean contains(Object o)
          如果此 set 包含指定元素,则返回 true
 boolean containsAll(Collection<?> c)
          如果此 set 包含指定 collection 的所有元素,则返回 true
 boolean equals(Object o)
          比较指定对象与此 set 的相等性。
 boolean isEmpty()
          如果此 set 不包含任何元素,则返回 true
 Iterator<E> iterator()
          返回按照元素添加顺序在此 set 中包含的元素上进行迭代的迭代器。
 boolean remove(Object o)
          如果指定元素存在于此 set 中,则将其移除。
 boolean removeAll(Collection<?> c)
          移除此 set 中包含在指定 collection 中的所有元素。
 boolean retainAll(Collection<?> c)
          仅保留此 set 中那些包含在指定 collection 中的元素。
 int size()
          返回此 set 中的元素数目。
 Object[] toArray()
          返回一个包含此 set 所有元素的数组。
<T> T[]
toArray(T[] a)
          返回一个包含此 set 所有元素的数组;返回数组的运行时类型是指定数组的类型。
 
从类 java.util.AbstractSet 继承的方法
hashCode
 
从类 java.util.AbstractCollection 继承的方法
toString
 
从类 java.lang.Object 继承的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

构造方法详细信息

CopyOnWriteArraySet

public CopyOnWriteArraySet()
创建一个空 set。


CopyOnWriteArraySet

public CopyOnWriteArraySet(Collection<? extends E> c)
创建一个包含指定 collection 所有元素的 set。

参数:
c - 最初包含元素的 collection
抛出:
NullPointerException - 如果指定 collection 为 null
方法详细信息

size

public int size()
返回此 set 中的元素数目。

指定者:
接口 Collection<E> 中的 size
指定者:
接口 Set<E> 中的 size
指定者:
AbstractCollection<E> 中的 size
返回:
此 set 中的元素数

isEmpty

public boolean isEmpty()
如果此 set 不包含任何元素,则返回 true

指定者:
接口 Collection<E> 中的 isEmpty
指定者:
接口 Set<E> 中的 isEmpty
覆盖:
AbstractCollection<E> 中的 isEmpty
返回:
如果此 set 不包含任何元素,则返回 true

contains

public boolean contains(Object o)
如果此 set 包含指定元素,则返回 true。更确切地讲,当且仅当此 set 包含满足 (o==null ? e==null : o.equals(e)) 的元素 e 时,返回 true

指定者:
接口 Collection<E> 中的 contains
指定者:
接口 Set<E> 中的 contains
覆盖:
AbstractCollection<E> 中的 contains
参数:
o - 将测试其是否存在于此 set 中的元素
返回:
如果此 set 包含指定元素,则返回 true

toArray

public Object[] toArray()
返回一个包含此 set 所有元素的数组。如果此 set 对其迭代器返回的元素的顺序做出了某些保证,那么此方法必须以相同的顺序返回这些元素。

不维护对返回数组的任何引用,因而它将是“安全的”。(换句话说,即使 set 受到数组的支持,此方法也必须分配一个新的数组)。因此,调用这可以随意修改返回的数组。

此方法充当基于数组的 API 与基于 collection 的 API 之间的桥梁。

指定者:
接口 Collection<E> 中的 toArray
指定者:
接口 Set<E> 中的 toArray
覆盖:
AbstractCollection<E> 中的 toArray
返回:
包含此 set 所有元素的数组

toArray

public <T> T[] toArray(T[] a)
返回一个包含此 set 所有元素的数组;返回数组的运行时类型是指定数组的类型。如果指定的数组能容纳该 set,则将 set 返回此处。否则,将分配一个具有指定数组的运行时类型和此 set 大小的新数组。

如果指定的数组能容纳 set,并有剩余的空间(即数组的元素比 set 多),那么会将接 set 尾部的元素设置为 null。( 当调用者知道此 set 不包含任何 null 元素时,才可使用此方法来确定此 set 的长度。)

如果此 set 对其迭代器返回的元素顺序做出了某些保证,那么此方法必须以相同的顺序返回这些元素。

toArray() 方法一样,此方法充当基于数组 的 API 与基于 collection 的 API 之间的桥梁。更进一步说,此方法允许对输出数组的运行时类型进行精确控制,在某些情况下,可以用来节省分配开销。

假定 x 是只包含字符串的一个已知 set。以下代码用来将该 set 转储到一个新分配的 String 数组:

     String[] y = x.toArray(new String[0]);
注意,toArray(new Object[0])toArray() 在功能上是相同的。

指定者:
接口 Collection<E> 中的 toArray
指定者:
接口 Set<E> 中的 toArray
覆盖:
AbstractCollection<E> 中的 toArray
参数:
存储此 - set 元素的数组(如果该数组足够大);否则为此分配一个具有相同运行时类型的新数组
返回:
包含此 set 所有元素的数组
抛出:
ArrayStoreException - 如果指定数组的运行时类型不是此 set 每个元素的运行时类型的超类型
NullPointerException - 如果指定数组为 null

clear

public void clear()
移除此 set 中的所有元素。在此调用返回之后,set 将为空。

指定者:
接口 Collection<E> 中的 clear
指定者:
接口 Set<E> 中的 clear
覆盖:
AbstractCollection<E> 中的 clear

remove

public boolean remove(Object o)
如果指定元素存在于此 set 中,则将其移除。更确切地讲,如果此 set 中包含满足 (o==null ? e==null : o.equals(e)) 的元素 e,则移除它。如果此 set 包含指定元素(或者此 set 由于调用而发生更改),则返回 true。(调用返回后,则此 set 便不再包含这样的元素。)

指定者:
接口 Collection<E> 中的 remove
指定者:
接口 Set<E> 中的 remove
覆盖:
AbstractCollection<E> 中的 remove
参数:
o - 要从此 set 移除的对象(如果存在)
返回:
如果此 set 包含指定元素,则返回 true

add

public boolean add(E e)
如果指定元素并不存在于此 set 中,则添加它。更确切地讲,如果此 set 不包含满足 (e==null ? e2==null : e.equals(e2)) 的元素 e2,则将指定元素 e 添加到此 set 中。如果此 set 已经包含这样的元素,则该调用不改变此 set 并返回 false

指定者:
接口 Collection<E> 中的 add
指定者:
接口 Set<E> 中的 add
覆盖:
AbstractCollection<E> 中的 add
参数:
e - 要添加到此 set 的元素
返回:
如果此 set 并未包含指定元素,则返回 true

containsAll

public boolean containsAll(Collection<?> c)
如果此 set 包含指定 collection 的所有元素,则返回 true。如果指定的 collection 也是一个 set,那么当该 collection 是此 set 的子集 时,此方法返回 true

指定者:
接口 Collection<E> 中的 containsAll
指定者:
接口 Set<E> 中的 containsAll
覆盖:
AbstractCollection<E> 中的 containsAll
参数:
c - 将被检查是否存在于此 set 的 collection
返回:
如果此 set 包含指定 collection 的所有元素,则返回 true
抛出:
NullPointerException - 如果指定 collection 为 null
另请参见:
contains(Object)

addAll

public boolean addAll(Collection<? extends E> c)
如果此 set 中没有指定 collection 中的所有元素,则将它们都添加到此 set 中。如果指定的 collection 也是一个 set,则 addAll 操作会实际修改此 set,从而它的值是两个 set 的一个并集。如果指定 collection 在操作过程中被修改,则此操作的行为是不确定的。

指定者:
接口 Collection<E> 中的 addAll
指定者:
接口 Set<E> 中的 addAll
覆盖:
AbstractCollection<E> 中的 addAll
参数:
c - 包含将添加到此 set 中的元素的 collection
返回:
如果此 set 由于调用而发生更改,则返回 true
抛出:
NullPointerException - 如果指定 collection 为 null
另请参见:
add(Object)

removeAll

public boolean removeAll(Collection<?> c)
移除此 set 中包含在指定 collection 中的所有元素。如果指定的 collection 也是一个 set,则此操作会实际修改此 set,从而其值是两个 set 的一个不对称差集

指定者:
接口 Collection<E> 中的 removeAll
指定者:
接口 Set<E> 中的 removeAll
覆盖:
AbstractSet<E> 中的 removeAll
参数:
c - 包含将从此 set 中移除的元素的 collection
返回:
如果此 set 由于调用而发生更改,则返回 true
抛出:
ClassCastException - 如果此 set 的元素的类与指定 collection 不兼容(可选)
NullPointerException - 如果此 set 包含一个 null 元素并且指定 collection 不允许使用 null 元素(可选),或者指定 collection 为 null
另请参见:
remove(Object)

retainAll

public boolean retainAll(Collection<?> c)
仅保留此 set 中那些包含在指定 collection 中的元素。换句话说,移除此 set 中所有未包含在指定 collection 中的元素。如果指定的 collection 也是一个 set,则此操作会实际修改此 set,这样其值是两个 set 的一个交集

指定者:
接口 Collection<E> 中的 retainAll
指定者:
接口 Set<E> 中的 retainAll
覆盖:
AbstractCollection<E> 中的 retainAll
参数:
c - 包含保留在此 set 中的元素的 collection
返回:
如果此 set 由于调用而发生更改,则返回 true
抛出:
ClassCastException - 如果此 set 的元素的类与指定 collection 不兼容(可选)
NullPointerException - 如果此 set 包含一个 null 元素并且指定 collection 不允许使用 null 元素(可选),或者指定 collection 为 null
另请参见:
remove(Object)

iterator

public Iterator<E> iterator()
返回按照元素添加顺序在此 set 中包含的元素上进行迭代的迭代器。

在构造迭代器时,返回的迭代器提供该 set 的状态的快照。在遍历迭代器时无需同步。该迭代器 支持 remove 方法。

指定者:
接口 Iterable<E> 中的 iterator
指定者:
接口 Collection<E> 中的 iterator
指定者:
接口 Set<E> 中的 iterator
指定者:
AbstractCollection<E> 中的 iterator
返回:
在此 set 中的元素上进行迭代的迭代器

equals

public boolean equals(Object o)
比较指定对象与此 set 的相等性。如果指定对象与此对象是同一对象,则返回 true,如果它也是一个 Set 并且在指定 set 上迭代的迭代器所返回的元素序列与在此 set 上进行迭代迭代器所返回的元素的序列相同。更确切地讲,如果两个迭代器返回相同的元素数,并且对于在指定 set 上进行迭代的迭代器返回的每个元素 e1 而言,都有一个由在此 set 上进行迭代的迭代器返回的元素 e2,且该元素满足 (e1==null ? e2==null : e1.equals(e2)),则认为两个迭代器将返回相同的元素。

指定者:
接口 Collection<E> 中的 equals
指定者:
接口 Set<E> 中的 equals
覆盖:
AbstractSet<E> 中的 equals
参数:
o - 将与此 set 进行相等性比较的对象
返回:
如果指定的对象与此 set 相等,则返回 true
另请参见:
Object.hashCode(), Hashtable

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策