CopyOnWriteArraySet (Java Platform SE 7)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<E>
  - - java.util.concurrent.CopyOnWriteArraySet<E>

型パラメータ:
E - このコレクション内に保持される要素の型

すべての実装されたインタフェース:

Serializable, Iterable<E>, Collection<E>, Set<E>
```
public class CopyOnWriteArraySet<E>
extends AbstractSet<E>
implements Serializable
```
内部の CopyOnWriteArrayList をすべてのオペレーションで使用する Set です。このため、同じ基本プロパティーが共有されます。
- 設定サイズが通常小さく、読み取り専用操作が変更操作よりもはるかに多いアプリケーションに最適である。また、トラバーサル中にスレッド間の干渉を防ぐ必要がある。
- スレッドセーフである。
- 推移的操作 (add、set、remove など) は、通常、基になる配列全体のコピーが必要になるため、負荷が大きい。
- イテレータは、推移的 remove オペレーションをサポートしていない。
- イテレータを使用したトラバーサルは高速であり、ほかのスレッドからの干渉に遭遇することはない。イテレータは、その構築された時点での変更されない配列スナップショットに依存する。
使用例。 次のコード例では、copy-on-write セットを使用して、状態の更新時に特定のアクションを実行する一連の 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()` 空のセットを作成します。
`CopyOnWriteArraySet(Collection<? extends E> c)` 指定されたコレクションの要素すべてを含むセットを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`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)` 指定されたオブジェクトがセットと同じかどうかを比較します。
`boolean`	`isEmpty()` このセットに要素が 1 つも含まれていない場合に `true` を返します。
`Iterator<E>`	`iterator()` このセットに含まれる各要素についてのイテレータを、これらの要素が追加された順序で返します。
`boolean`	`remove(Object o)` 指定された要素がこのセットに存在する場合に、要素をセットから削除します。
`boolean`	`removeAll(Collection<?> c)` セットから、指定されたコレクション内に保持されているすべての要素を削除します。
`boolean`	`retainAll(Collection<?> c)` 指定されたコレクション内に保持されている、セット内の要素だけを保持します。
`int`	`size()` このセット中の要素の数を返します。
`Object[]`	`toArray()` セット内のすべての要素が格納されている配列を返します。
`<T> T[]`	`toArray(T[] a)` セット内のすべての要素を格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。

クラス java.util.AbstractSet から継承されたメソッド
hashCode

クラス java.util.AbstractCollection から継承されたメソッド
toString

クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - CopyOnWriteArraySet
```
public CopyOnWriteArraySet()
```
    空のセットを作成します。
  - CopyOnWriteArraySet
```
public CopyOnWriteArraySet(Collection<? extends E> c)
```
    指定されたコレクションの要素すべてを含むセットを作成します。
    
    パラメータ:
    c - 初期状態で含む要素のコレクション
    
    例外:
    
    NullPointerException - 指定されたコレクションが null である場合
- メソッドの詳細
  - size
```
public int size()
```
    このセット中の要素の数を返します。
    
    定義:
    
    size、インタフェース: Collection<E>
    
    定義:
    
    size、インタフェース: Set<E>
    
    定義:
    
    size、クラス: AbstractCollection<E>
    
    戻り値:
    セットの要素数
  - isEmpty
```
public boolean isEmpty()
```
    このセットに要素が 1 つも含まれていない場合に true を返します。
    
    定義:
    
    isEmpty、インタフェース: Collection<E>
    
    定義:
    
    isEmpty、インタフェース: Set<E>
    
    オーバーライド:
    
    isEmpty、クラス: AbstractCollection<E>
    
    戻り値:
    このセットに要素が 1 つも含まれていない場合は true
  - contains
```
public boolean contains(Object o)
```
    指定された要素がセットに含まれている場合に true を返します。つまり、このセットに、(o==null ? e==null : o.equals(e)) となる要素 e が含まれている場合にのみ true を返します。
    
    定義:
    
    contains、インタフェース: Collection<E>
    
    定義:
    
    contains、インタフェース: Set<E>
    
    オーバーライド:
    
    contains、クラス: AbstractCollection<E>
    
    パラメータ:
    o - このセット内にあるかどうかが判定される要素
    
    戻り値:
    指定された要素がこのセットに含まれている場合は true
  - toArray
```
public Object[] toArray()
```
    セット内のすべての要素が格納されている配列を返します。イテレータによって要素が返される順序をセットが保証する場合、このメソッドは同じ順序で要素を返さなければいけません。
    返される配列への参照をセットが維持しないという点で、この配列は安全です。つまり、このメソッドは、セットが配列に連動している場合でも新しい配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。
    このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。
    
    定義:
    
    toArray、インタフェース: Collection<E>
    
    定義:
    
    toArray、インタフェース: Set<E>
    
    オーバーライド:
    
    toArray、クラス: AbstractCollection<E>
    
    戻り値:
    セット内のすべての要素を保持している配列
  - toArray
```
public <T> T[] toArray(T[] a)
```
    セット内のすべての要素を格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。セットが指定された配列に収まる場合は、その中に返されます。そうでない場合は、指定された配列の実行時の型とセットのサイズを持つ新しい配列が割り当てられます。
    このセットが指定された配列に収まり、その配列にさらに余裕がある場合 (つまり、配列がセットより多くの要素を持つ場合)、その配列内でセットの終端よりあとの要素は null に設定されます。このセットに null 要素がないことを呼び出し側が知っている場合にだけ、この特性を利用してこのセットの長さを判断できます。
    イテレータによって要素が返される順序をセットが保証する場合、このメソッドは同じ順序で要素を返さなければいけません。
    toArray() メソッドと同じように、このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割り当ての手間を抑えるために使用できます。
    x が、文字列だけからなるセットであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられた String の配列内にセットをダンプできます。
```
     String[] y = x.toArray(new String[0]);
```
    toArray(new Object[0]) は、機能の点で toArray() と同一です。
    定義:
    
    toArray、インタフェース: Collection<E>
    
    定義:
    
    toArray、インタフェース: Set<E>
    
    オーバーライド:
    
    toArray、クラス: AbstractCollection<E>
    
    パラメータ:
    a - 配列が十分な大きさを持つ場合は、このセットの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。
    
    戻り値:
    セット内のすべての要素を保持している配列
    
    例外:
    
    ArrayStoreException - 指定された配列の実行時の型が、このセット内のすべての要素の実行時の型のスーパータイプでない場合
    
    NullPointerException - 指定された配列が null である場合
  - clear
```
public void clear()
```
    すべての要素をセットから削除します。この呼び出しが戻ると、セットは空になります。
    
    定義:
    
    clear、インタフェース: Collection<E>
    
    定義:
    
    clear、インタフェース: Set<E>
    
    オーバーライド:
    
    clear、クラス: AbstractCollection<E>
  - remove
```
public boolean remove(Object o)
```
    指定された要素がこのセットに存在する場合に、要素をセットから削除します。つまり、このセット内に、(o==null ? e==null : o.equals(e)) となる要素 e が含まれている場合は、そのような要素を削除します。その要素がこのセットに含まれていた場合、つまり、呼び出しの結果としてこのセットが変更された場合は true を返します。呼び出しが復帰したあとは、このセットはその要素を持っていません。
    
    定義:
    
    remove、インタフェース: Collection<E>
    
    定義:
    
    remove、インタフェース: Set<E>
    
    オーバーライド:
    
    remove、クラス: AbstractCollection<E>
    
    パラメータ:
    o - このセットから削除されるオブジェクト (そのオブジェクトが存在する場合)
    
    戻り値:
    セットが、指定された要素を保持していた場合は true
  - add
```
public boolean add(E e)
```
    指定された要素がセットの要素として存在しない場合に、その要素をセットに追加します。つまり、セット内に、(e==null ? e2==null : e.equals(e2)) となる要素 e2 がない場合は、指定された要素 e をこのセットに追加します。このセット内にすでにその要素が含まれている場合、この呼び出しではセットを変更せずに false を返します。
    
    定義:
    
    add、インタフェース: Collection<E>
    
    定義:
    
    add、インタフェース: Set<E>
    
    オーバーライド:
    
    add、クラス: AbstractCollection<E>
    
    パラメータ:
    e - このセットに追加される要素
    
    戻り値:
    このセット内に、指定された要素がなかった場合は true
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    指定されたコレクションのすべての要素がこのセットに含まれている場合に true を返します。指定されたコレクションもセットである場合、指定されたセットがこのセットのサブセットであれば、このメソッドは true を返します。
    
    定義:
    
    containsAll、インタフェース: Collection<E>
    
    定義:
    
    containsAll、インタフェース: Set<E>
    
    オーバーライド:
    
    containsAll、クラス: AbstractCollection<E>
    
    パラメータ:
    c - このセットに含まれているかどうかがチェックされるコレクション
    
    戻り値:
    指定されたコレクションのすべての要素がこのセットに含まれている場合は true
    
    例外:
    
    NullPointerException - 指定されたコレクションが null である場合
    関連項目:
    contains(Object)
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    指定されたコレクションのすべての要素について、その要素がこのセット内にない場合、セットに追加します。指定されたコレクションもセットである場合、addAll オペレーションは、その値が 2 つのセットの和集合になるようにこのセットを効率的に変更します。オペレーションの進行中に、指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。
    
    定義:
    
    addAll、インタフェース: Collection<E>
    
    定義:
    
    addAll、インタフェース: Set<E>
    
    オーバーライド:
    
    addAll、クラス: AbstractCollection<E>
    
    パラメータ:
    c - このセットに追加される要素を含むコレクション
    
    戻り値:
    呼び出しの結果としてこのセットが変更された場合は true
    
    例外:
    
    NullPointerException - 指定されたコレクションが null である場合
    関連項目:
    add(Object)
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    セットから、指定されたコレクション内に保持されているすべての要素を削除します。指定されたコレクションもセットである場合、このオペレーションは、その値が 2 つのセットの非対称集合差分になるようにこのセットを効率的に変更します。
    
    定義:
    
    removeAll、インタフェース: Collection<E>
    
    定義:
    
    removeAll、インタフェース: Set<E>
    
    オーバーライド:
    
    removeAll、クラス: AbstractSet<E>
    
    パラメータ:
    c - このセットから削除される要素を含むコレクション
    
    戻り値:
    呼び出しの結果としてこのセットが変更された場合は true
    
    例外:
    
    ClassCastException - このセットのある要素のクラスが、指定されたコレクションと互換でない場合 (オプション)
    
    NullPointerException - このセットに null 要素が含まれており、指定されたコレクションが null 要素を許可しない場合 (オプション)、または指定されたコレクションが null の場合
    関連項目:
    remove(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    指定されたコレクション内に保持されている、セット内の要素だけを保持します。つまり、セットから、指定されたコレクション内にない要素をすべて削除します。指定されたコレクションもセットである場合、このオペレーションは、その値が 2 つのセットの共通部分になるようにこのセットを効率的に変更します。
    
    定義:
    
    retainAll、インタフェース: Collection<E>
    
    定義:
    
    retainAll、インタフェース: Set<E>
    
    オーバーライド:
    
    retainAll、クラス: AbstractCollection<E>
    
    パラメータ:
    c - このセットで保持される要素を含むコレクション
    
    戻り値:
    呼び出しの結果としてこのセットが変更された場合は true
    
    例外:
    
    ClassCastException - このセットのある要素のクラスが、指定されたコレクションと互換でない場合 (オプション)
    
    NullPointerException - このセットに null 要素が含まれており、指定されたコレクションが null 要素を許可しない場合 (オプション)、または指定されたコレクションが null の場合
    関連項目:
    remove(Object)
  - iterator
```
public Iterator<E> iterator()
```
    このセットに含まれる各要素についてのイテレータを、これらの要素が追加された順序で返します。
    返されるイテレータは、イテレータの構築時のセット状態のスナップショットを提供します。イテレータのトラバーサル中に同期化は必要ありません。イテレータは、remove メソッドをサポートしません。
    
    定義:
    
    iterator、インタフェース: Iterable<E>
    
    定義:
    
    iterator、インタフェース: Collection<E>
    
    定義:
    
    iterator、インタフェース: Set<E>
    
    定義:
    
    iterator、クラス: AbstractCollection<E>
    
    戻り値:
    セットの要素のイテレータ
  - equals
```
public boolean equals(Object o)
```
    指定されたオブジェクトがセットと同じかどうかを比較します。指定されたオブジェクトがこのオブジェクトと同じオブジェクトである場合、またはそれが Set でもあり、指定されたセットで iterator によって返された要素が、このセットでイテレータによって返された要素と同じである場合は true を返します。つまり、この 2 つのイテレータは、同じ数の要素を返し、指定されたセットに対してイテレータによって返された要素 e1 ごとに、このセットでイテレータによって返された (e1==null ? e2==null : e1.equals(e2)) となる要素 e2 が存在する場合に同じ要素を返すと見なされます。
    
    定義:
    
    equals、インタフェース: Collection<E>
    
    定義:
    
    equals、インタフェース: Set<E>
    
    オーバーライド:
    
    equals、クラス: AbstractSet<E>
    
    パラメータ:
    o - このセットと等しいかどうかが比較されるオブジェクト
    
    戻り値:
    指定されたオブジェクトがこのセットに等しい場合は true
    関連項目:
    Object.hashCode()、HashMap

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス CopyOnWriteArraySet<E>

コンストラクタのサマリー

メソッドのサマリー

クラス java.util.AbstractSet から継承されたメソッド

クラス java.util.AbstractCollection から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

CopyOnWriteArraySet

CopyOnWriteArraySet

メソッドの詳細

size

isEmpty

contains

toArray

toArray

clear

remove

add

containsAll

addAll

removeAll

retainAll

iterator

equals