Module  java.base
软件包  java.util.concurrent

Class CopyOnWriteArraySet<E>

  • 参数类型
    E - 该集合中保存的元素的类型
    All Implemented Interfaces:
    Serializable ， Iterable<E> ， Collection<E> ， Set<E> 

    public class CopyOnWriteArraySet<E>
extends AbstractSet<E>
implements Serializable
    A Set 对其所有操作使用内部CopyOnWriteArrayList 。 因此，它具有相同的基本属性：
    • 它最适合于集合大小通常保持较小，只读操作大大超过突变操作的应用程序，并且您需要防止遍历期间线程之间的干扰。
    • 它是线程安全的。
    • 可变操作（ add ， set ， remove等）是昂贵的，因为它们通常意味着复制整个底层数组。
    • 迭代器不支持突变remove操作。
    • 遍历遍历迭代器是快速的，不能遇到来自其他线程的干扰。 迭代器构建时迭代器依赖于数组的不变快照。

    样品用法。 以下代码草图使用写时复制集来维护在状态更新时执行某些操作的一组Handler对象。 

       class Handler { void handle(); ... } class X { private final CopyOnWriteArraySet<Handler> handlers = new CopyOnWriteArraySet<>(); 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 ， Serialized Form

    • 构造方法详细信息

      • CopyOnWriteArraySet

        public CopyOnWriteArraySet​()
        创建一个空集。

      • CopyOnWriteArraySet

        public CopyOnWriteArraySet​(Collection<? extends E> c)
        创建一个包含指定集合的所有元素的集合。
        参数
        c - 最初包含的元素的集合
        异常
        NullPointerException - 如果指定的集合为空

    • 方法详细信息

      • contains

        public boolean contains​(Object o)
        如果此集合包含指定的元素，则返回true 。 更正式地说，返回true当且仅当此set包含的元素e这样Objects.equals(o, e) 。
        Specified by:
        contains在接口 Collection<E>
        Specified by:
        contains在接口 Set<E>
        重写：
        contains在 AbstractCollection<E>
        参数
        o - 要在此集合中存在的元素要进行测试
        结果
        true如果此集合包含指定的元素

      • toArray

        public Object[] toArray​()
        返回一个包含此集合中所有元素的数组。 如果此集合对其迭代器返回的元素的顺序做出任何保证，则此方法必须以相同的顺序返回元素。

        返回的数组将是“安全的”，因为该集合不保留对它的引用。 （换句话说，这个方法必须分配一个新的数组，即使这个数组是由数组支持的）。 因此，调用者可以自由地修改返回的数组。

        此方法充当基于阵列和基于集合的API之间的桥梁。

        Specified by:
        toArray在接口 Collection<E>
        Specified by:
        toArray在接口 Set<E>
        重写：
        toArray在 AbstractCollection<E>
        结果
        一个包含此集合中所有元素的数组

      • toArray

        public <T> T[] toArray​(T[] a)
        返回一个包含此集合中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。 如果集合适合指定的数组，则返回其中。 否则，将为指定数组的运行时类型和此集合的大小分配一个新数组。

        如果这个集合适合指定的数组，有空余的空间（即，该数组的元素多于此集合），紧接在该集合结束后的数组中的元素将设置为null 。 （这仅在调用者知道此集合不包含任何空元素时才可用于确定此集合的长度。）

        如果此集合对其迭代器返回的元素的顺序做出任何保证，则此方法必须以相同的顺序返回元素。

        像toArray()方法一样，此方法充当基于数组和基于集合的API之间的桥梁。 此外，该方法允许精确地控制输出阵列的运行时类型，并且在某些情况下可以用于节省分配成本。

        假设x是一个已知只包含字符串的集合。 以下代码可用于将集合转储为新分配的String数组： 

          String[] y = x.toArray(new String[0]);
        请注意， toArray(new Object[0])功能与toArray()相同。
        Specified by:
        toArray在接口 Collection<E>
        Specified by:
        toArray在接口 Set<E>
        重写：
        toArray在 AbstractCollection<E>
        参数类型
        T - 包含集合的数组的运行时类型
        参数
        a - 要存储此集合的元素的阵列，如果它足够大; 否则，为此目的分配相同运行时类型的新数组。
        结果
        一个包含此集合中所有元素的数组
        异常
        ArrayStoreException - 如果指定数组的运行时类型不是此集合中每个元素的运行时类型的超类型
        NullPointerException - 如果指定的数组为空

      • remove

        public boolean remove​(Object o)
        如果存在，则从该集合中删除指定的元素。 更正式地，删除元素e ，使得Objects.equals(o, e) ，如果这个集合包含这样的元素。 如果此集合包含元素（或等效地，如果此集合作为调用的结果而更改），则返回true 。 （一旦调用返回，此集合将不包含该元素。）
        Specified by:
        remove在接口 Collection<E>
        Specified by:
        remove在接口 Set<E>
        重写：
        remove在 AbstractCollection<E>
        参数
        o - 要从该集合中删除的对象（如果存在）
        结果
        true如果这个集合包含指定的元素

      • add

        public boolean add​(E e)
        将指定的元素添加到此集合（如果尚未存在）。 更正式地，将指定的元素e这一套如果集合不包含元素e2这样Objects.equals(e, e2) 。 如果该集合已经包含该元素，则该呼叫将保持不变，并返回false 。
        Specified by:
        add在接口 Collection<E>
        Specified by:
        add在接口 Set<E>
        重写：
        add在 AbstractCollection<E>
        参数
        e - 要添加到此集合的元素
        结果
        true如果此集合尚未包含指定的元素

      • addAll

        public boolean addAll​(Collection<? extends E> c)
        将指定集合中的所有元素添加到此集合（如果它们尚未存在）。 如果指定的集合也是集合，则addAll操作有效地修改该集合，使其值是两个集合的并集。 如果在操作进行中修改了指定的集合，则此操作的行为是未定义的。
        Specified by:
        addAll在接口 Collection<E>
        Specified by:
        addAll在接口 Set<E>
        重写：
        addAll AbstractCollection<E>
        参数
        c - 包含要添加到此集合的元素的集合
        结果
        true如果此设置由于调用而更改
        异常
        NullPointerException - 如果指定的集合为空
        另请参见：
        add(Object)

      • removeAll

        public boolean removeAll​(Collection<?> c)
        从此集合中删除指定集合中包含的所有元素。 如果指定的集合也是集合，则该操作有效地修改该集合，使其值是两组的非对称集合差异 。
        Specified by:
        removeAll在接口 Collection<E>
        Specified by:
        removeAll在接口 Set<E>
        重写：
        removeAll在 AbstractSet<E>
        参数
        c - 包含要 c集合中删除的元素的集合
        结果
        true如果此设置由于呼叫而更改
        异常
        ClassCastException - 如果此集合的元素的类与指定的集合不兼容（ optional ）
        NullPointerException - 如果此集合包含一个空元素，并且指定的集合不允许空元素（ optional ），或者如果指定的集合为空
        另请参见：
        remove(Object)

      • retainAll

        public boolean retainAll​(Collection<?> c)
        仅保留该集合中包含在指定集合中的元素。 换句话说，从这个集合中删除它不包含在指定集合中的所有元素。 如果指定的集合也是一个集合，则此操作有效地修改该集合，使其值是两组的交集 。
        Specified by:
        retainAll在接口 Collection<E>
        Specified by:
        retainAll在接口 Set<E>
        重写：
        retainAll在 AbstractCollection<E>
        参数
        c - 包含要保留在此集合中的元素的集合
        结果
        true如果此设置由于调用而更改
        异常
        ClassCastException - 如果此集合的元素的类与指定的集合不兼容（ optional ）
        NullPointerException - 如果此集合包含空元素，并且指定的集合不允许空元素（ optional ），或者如果指定的集合为空
        另请参见：
        remove(Object)

      • iterator

        public Iterator<E> iterator​()
        按照添加这些元素的顺序返回此集合中包含的元素的迭代器。

        返回的迭代器在构建迭代器时提供集合的状态的快照。 遍历迭代器时不需要同步。 该迭代器不支持remove方法。

        Specified by:
        iterator接口 Collection<E>
        Specified by:
        iterator在接口 Iterable<E>
        Specified by:
        iterator接口 Set<E>
        Specified by:
        iterator在 AbstractCollection<E>
        结果
        这个集合中的元素的迭代器

      • equals

        public boolean equals​(Object o)
        将指定的对象与此集合进行比较以实现相等。 如果指定的对象与该对象相同，则返回true ，或者如果它也是一个Set，并且由指定集合上的iterator返回的元素与迭代器在此集合上返回的元素相同。 更正式地，如果两个迭代器返回相同数量的元素，并且对于迭代器在指定集合上返回的每个元素e1 ，则这两个迭代器被认为返回相同的元素，则迭代器在该集合上返回的元素为e2 ，使得Objects.equals(e1, e2) 。
        Specified by:
        equals在接口 Collection<E>
        Specified by:
        equals在接口 Set<E>
        重写：
        equals在 AbstractSet<E>
        参数
        o - 要与该集合相等的对象
        结果
        true如果指定的对象等于此集合
        另请参见：
        Object.hashCode() ， HashMap

      • removeIf

        public boolean removeIf​(Predicate<? super E> filter)
        描述从接口Collection复制
        删除满足给定谓词的此集合的所有元素。 在迭代或谓词中抛出的错误或运行时异常被转发给调用者。
        Specified by:
        removeIf在接口 Collection<E>
        参数
        filter - 一个谓词，为要删除的元素返回 true
        结果
        true如果有任何元素被删除
        异常
        NullPointerException - 如果指定的过滤器为空

      • forEach

        public void forEach​(Consumer<? super E> action)
        描述从接口Iterable复制
        对Iterable每个元素执行给定的操作，直到所有元素都被处理或动作引发异常。 如果指定了该顺序，则按迭代的顺序执行操作。 动作抛出的异常被转发给呼叫者。

        如果操作执行修改元素的基础源的副作用，则该方法的行为是未指定的，除非重写类已指定并发修改策略。

        Specified by:
        forEach在接口 Iterable<E>
        参数
        action - 要对每个元素执行的操作
        异常
        NullPointerException - 如果指定的动作为空