java.util.concurrent
クラス CopyOnWriteArraySet<E>

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()

このセット中の要素の数を返します。

定義:

インタフェース Collection<E> 内の size

定義:

インタフェース Set<E> 内の size

定義:

クラス AbstractCollection<E> 内の size

戻り値:

セットの要素数

isEmpty

public boolean isEmpty()

セットが要素を 1 つも保持していない場合に true を返します。

定義:

インタフェース Collection<E> 内の isEmpty

定義:

インタフェース Set<E> 内の isEmpty

オーバーライド:

クラス AbstractCollection<E> 内の isEmpty

戻り値:

セットが要素を 1 つも保持していない場合は true

contains

public boolean contains(Object o)

セットが、指定された要素を保持している場合に true を返します。つまり、セットに、(o==null ? e==null : o.equals(e)) となる要素 e が含まれている場合にだけ true を返します。

定義:

インタフェース Collection<E> 内の contains

定義:

インタフェース Set<E> 内の contains

オーバーライド:

クラス AbstractCollection<E> 内の contains

パラメータ:

o - セットにあるかどうかを調べる要素

戻り値:

セットが、指定された要素を保持している場合は true

toArray

public Object[] toArray()

セット内のすべての要素が格納されている配列を返します。反復子によって要素が返される順序をセットが保証する場合、このメソッドは同じ順序で要素を返さなければいけません。

返される配列への参照をセットが維持しないという点で、この配列は安全です。つまり、このメソッドは、セットが配列に連動している場合でも新しい配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。

メソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。

定義:

インタフェース Collection<E> 内の toArray

定義:

インタフェース Set<E> 内の toArray

オーバーライド:

クラス AbstractCollection<E> 内の toArray

戻り値:

セット内のすべての要素を保持している配列

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() と同一です。

定義:

インタフェース Collection<E> 内の toArray

定義:

インタフェース Set<E> 内の toArray

オーバーライド:

クラス AbstractCollection<E> 内の toArray

パラメータ:

a - セットの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる

戻り値:

セット内のすべての要素を保持している配列

例外:

ArrayStoreException - 指定された配列の実行時の型が、このセット内のすべての要素の実行時の型のスーパータイプでない場合

NullPointerException - 指定された配列が null である場合

clear

public void clear()

すべての要素をセットから削除します。この呼び出しが戻ると、セットは空になります。

定義:

インタフェース Collection<E> 内の clear

定義:

インタフェース Set<E> 内の clear

オーバーライド:

クラス AbstractCollection<E> 内の clear

remove

public boolean remove(Object o)

指定された要素がこのセットに存在する場合に、要素をセットから削除します。つまり、このセットに (o==null ? e==null : o.equals(e)) となる要素 e が含まれている場合に、その要素を削除します。この要素がセット内にあった場合 (セットが呼び出しの結果として変更された場合) は、true を返します。呼び出しが復帰したあとは、このセットはその要素を持っていません。

定義:

インタフェース Collection<E> 内の remove

定義:

インタフェース Set<E> 内の remove

オーバーライド:

クラス AbstractCollection<E> 内の remove

パラメータ:

o - セットに存在すれば削除されるオブジェクト

戻り値:

セットが、指定された要素を保持していた場合は true

add

public boolean add(E e)

指定された要素がセットの要素として存在しない場合に、その要素をセットに追加します。つまり、セット内に、(e==null ? e2==null : e.equals(e2)) に該当する要素 e2 がなかった場合は、指定された要素 e をセットに追加します。セット内にすでにこの要素がある場合、呼び出しはセットを変更せずに false を返します。

定義:

インタフェース Collection<E> 内の add

定義:

インタフェース Set<E> 内の add

オーバーライド:

クラス AbstractCollection<E> 内の add

パラメータ:

e - セットに追加される要素

戻り値:

セットが指定された要素を保持していなかった場合は true

containsAll

public boolean containsAll(Collection<?> c)

指定されたコレクションのすべての要素がセット内にある場合に true を返します。指定されたコレクションもセットである場合、指定されたセットがこのセットの「サブセット」であれば、このメソッドは true を返します。

定義:

インタフェース Collection<E> 内の containsAll

定義:

インタフェース Set<E> 内の containsAll

オーバーライド:

クラス AbstractCollection<E> 内の containsAll

パラメータ:

c - このセットに含まれているかどうかを調べるコレクション

戻り値:

指定されたコレクションのすべての要素がセットに含まれている場合は true

例外:

NullPointerException - 指定されたコレクションが null である場合

関連項目:

contains(Object)

addAll

public boolean addAll(Collection<? extends E> c)

指定されたコレクションのすべての要素について、その要素がこのセット内にない場合、セットに追加します。指定されたコレクションもセットである場合、addAll オペレーションは効率的にセットを変更して、その値が 2 つのセットの「和集合」になるようにします。オペレーションの進行中に、指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。

定義:

インタフェース Collection<E> 内の addAll

定義:

インタフェース Set<E> 内の addAll

オーバーライド:

クラス AbstractCollection<E> 内の addAll

パラメータ:

c - このセットに追加される要素を持つコレクション

戻り値:

この呼び出しの結果、このセットが変更された場合は true

例外:

NullPointerException - 指定されたコレクションが null である場合

関連項目:

add(Object)

removeAll

public boolean removeAll(Collection<?> c)

セットから、指定されたコレクション内に保持されているすべての要素を削除します。指定されたコレクションもセットである場合、このオペレーションは、値が 2 つのセットの「非対称集合差分」になるようにセットを効率的に変更します。

定義:

インタフェース Collection<E> 内の removeAll

定義:

インタフェース Set<E> 内の removeAll

オーバーライド:

クラス AbstractSet<E> 内の removeAll

パラメータ:

c - このセットから削除される要素を含むコレクション

戻り値:

この呼び出しの結果、このセットが変更された場合は true

例外:

ClassCastException - このセットのある要素のクラスが、指定されたコレクションと互換でない場合 (省略可能)

NullPointerException - このセットに null 要素が含まれており、指定されたコレクションが null 要素を許可しない場合 (省略可能)、または指定されたコレクションが null の場合

関連項目:

remove(Object)

retainAll

public boolean retainAll(Collection<?> c)

指定されたコレクション内に保持されている、セット内の要素だけを保持します。つまり、セットから、指定されたコレクション内にない要素をすべて削除します。指定されたコレクションもセットである場合、このオペレーションの結果、セットの値は 2 つのセットの「共通部分」になります。

定義:

インタフェース Collection<E> 内の retainAll

定義:

インタフェース Set<E> 内の retainAll

オーバーライド:

クラス AbstractCollection<E> 内の retainAll

パラメータ:

c - このセットで保持される要素を含むコレクション

戻り値:

この呼び出しの結果、このセットが変更された場合は true

例外:

ClassCastException - このセットのある要素のクラスが、指定されたコレクションと互換でない場合 (省略可能)

NullPointerException - このセットに null 要素が含まれており、指定されたコレクションが null 要素を許可しない場合 (省略可能)、または指定されたコレクションが null の場合

関連項目:

remove(Object)

iterator

public Iterator<E> iterator()

このセットに含まれる各要素についての反復子を、これらの要素が追加された順序で返します。

返される反復子は、反復子の構築時のセット状態のスナップショットを提供します。反復子のトラバーサル中に同期化は必要ありません。反復子は、remove メソッドをサポートしません。

定義:

インタフェース Iterable<E> 内の iterator

定義:

インタフェース Collection<E> 内の iterator

定義:

インタフェース Set<E> 内の iterator

定義:

クラス AbstractCollection<E> 内の iterator

戻り値:

セットの要素の反復子

equals

public boolean equals(Object o)

指定されたオブジェクトがセットと同じかどうかを比較します。指定されたオブジェクトがこのオブジェクトと同じオブジェクトである場合、または指定されたオブジェクトが Set でもあり、指定されたセットで iterator によって返される要素がこのセットで反復子によって返される要素と同じである場合、true を返します。つまり、この 2 つの反復子は、それらが同じ数の要素を返し、指定されたセットについての反復子によって返される各要素 e1 ごとに、このセットについての反復子によって返される (e1==null ? e2==null :e1.equals(e2)) に該当する要素 e2 が存在する場合、同じ要素を返すと見なされます。

定義:

インタフェース Collection<E> 内の equals

定義:

インタフェース Set<E> 内の equals

オーバーライド:

クラス AbstractSet<E> 内の equals

パラメータ:

o - このセットと等しいかどうかが比較されるオブジェクト

戻り値:

指定されたオブジェクトがこのセットと同じ場合は true

関連項目:

Object.hashCode(), Hashtable