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。このため、次の基本プロパティが共有されます。

• 設定サイズが通常小さく、読み取り専用操作が変更操作よりもずっと多いアプリケーションに最適である。また、トラバーサル中にスレッド間の干渉を防ぐ必要がある
• スレッドセーフである
• 変更操作 (追加、設定、削除など) は、通常、基になる配列全体のコピーが必要になるため、負荷が大きい
• 反復子は、削除操作をサポートしない
• 反復子を使用したトラバーサルは高速であり、他のスレッドからの干渉に遭遇することはない。反復子は、その構築時の変化しない配列スナップショットを使用する

使用例: 次のコードは、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)
指定された Collection の要素すべてを含むセットを作成します。

メソッドの概要

boolean	add(E o) 指定された要素がこのコレクションに格納されていることを保証します (任意のオペレーション)。
boolean	addAll(Collection<? extends E> c) 指定されたコレクションのすべての要素をこのコレクションに追加します (任意のオペレーション)。
void	clear() このコレクションからすべての要素を削除します (任意のオペレーション)。
boolean	contains(Object o) コレクションに指定された要素がある場合に true を返します。
boolean	containsAll(Collection<?> c) このコレクション内に、指定されたコレクションのすべての要素がある場合に true を返します。
boolean	isEmpty() コレクションに要素がない場合に true を返します。
Iterator<E>	iterator() このコレクション中の要素に関係する反復子を返します。
boolean	remove(Object o) 指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから 1 つ削除します (任意のオペレーション)。
boolean	removeAll(Collection<?> c) このセットから、指定されたコレクションに含まれる要素をすべて削除します (任意のオペレーション)。
boolean	retainAll(Collection<?> c) このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します (任意のオペレーション)。
int	size() このコレクション中の要素の数を返します。
Object[]	toArray() このコレクションの要素がすべて格納されている配列を返します。
<T> T[]	toArray(T[] a) このコレクション内のすべての要素を保持する配列を返します。

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

equals, 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)

指定された Collection の要素すべてを含むセットを作成します。

パラメータ:

c - コレクション

メソッドの詳細

size

public int size()

クラス AbstractCollection の記述:

このコレクション中の要素の数を返します。コレクションに Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。

定義:

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

定義:

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

定義:

クラス AbstractCollection<E> 内の size

戻り値:

コレクションの要素数

isEmpty

public boolean isEmpty()

クラス AbstractCollection の記述:

コレクションに要素がない場合に true を返します。

この実装は size() == 0 の結果を返します。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の isEmpty

戻り値:

コレクションに要素がない場合は true

contains

public boolean contains(Object o)

クラス AbstractCollection の記述:

コレクションに指定された要素がある場合に true を返します。すなわち、このコレクションに (o==null ? e==null : o.equals(e)) である要素 e が 1 つ以上ある場合にだけ true を返します。

この実装はコレクションの各要素について、指定された要素と等しいかどうかを順に繰り返し確認します。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の contains

パラメータ:

o - このコレクションにあるかどうかを調べるオブジェクト

戻り値:

コレクションに指定された要素がある場合は true

toArray

public Object[] toArray()

クラス AbstractCollection の記述:

このコレクションの要素がすべて格納されている配列を返します。反復子によって返される要素の順番をコレクションが保証する場合、このメソッドはそれと同じ順番で要素を返します。返される配列は、コレクションによって管理される参照関係を持たない点で安全性が保証されます。つまり、このメソッドは、コレクションの基が Array である場合でも、新しく配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。

この実装は、返される配列を割り当て、コレクションの各要素について繰り返します。つまり、各オブジェクト参照を配列の次の要素に格納するという処理を、第 0 要素から開始します。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の toArray

戻り値:

コレクションのすべての要素が格納されている配列

toArray

public <T> T[] toArray(T[] a)

クラス AbstractCollection の記述:

このコレクション内のすべての要素を保持する配列を返します。返される配列の実行時の型は、指定された配列の型です。コレクションが指定された配列に収まる場合は、その中に返されます。そうでない場合は、指定された配列の実行時の型とコレクションのサイズを持つ新しい配列が割り当てられます。

指定された配列にコレクションが収まり、さらに空きがある場合、すなわち配列にコレクション以上の要素数がある場合には、コレクションの終端の直後にある配列の要素が null に設定されます。コレクションに null 要素がないことが呼び出し側でわかっている場合には、これにより、コレクションの長さを判定できます。

反復子によって要素が返される順序をコレクションが保証する場合、このメソッドは同じ順序で要素を返さなければなりません。

この実装は、配列がコレクションの格納に十分な大きさであるかを確認します。不十分な場合、この実装はリフレクションを使って、適切なサイズおよび型の配列を新しく割り当てます。次に、コレクションに対して、0 から順に配列の連続する要素へ各オブジェクト参照を格納する操作を反復します。配列がコレクションよりも大きい場合、コレクションの終端より後の最初の位置に null が格納されます。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の toArray

パラメータ:

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

戻り値:

コレクションの要素を含む配列

clear

public void clear()

クラス AbstractCollection の記述:

このコレクションからすべての要素を削除します (任意のオペレーション)。この呼び出しが戻ったあとは、例外がスローされない限り、コレクションは空になります。

この実装はコレクションに対して、Iterator.remove オペレーションを使用して各要素を削除する操作を繰り返します。ほとんどの実装では、このメソッドをオーバーライドした方がより効率的です。

このコレクションの iterator メソッドで返される反復子が remove メソッドを実装せず、このコレクションが空でない場合、この実装は UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の clear

iterator

public Iterator<E> iterator()

クラス AbstractCollection の記述:

このコレクション中の要素に関係する反復子を返します。

定義:

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

定義:

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

定義:

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

定義:

クラス AbstractCollection<E> 内の iterator

戻り値:

このコレクション中の要素に関係する反復子を返す

remove

public boolean remove(Object o)

クラス AbstractCollection の記述:

指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから 1 つ削除します (任意のオペレーション)。より厳密に言えば、(o==null ? e==null : o.equals(e)) を満たす要素 e がコレクションに 1 つ以上あれば、e を 1 つ削除します。指定された要素がコレクションに含まれていた場合、すなわち、呼び出しの結果コレクションが変更された場合に true を返します。

この実装は、コレクションの内容を次々調べ、指定された要素を探します。要素があれば、反復子の remove メソッドを使ってコレクションから要素を削除します。

このコレクションの iterator メソッドが返す反復子が remove メソッドを実装せず、指定されたオブジェクトがこのコレクション内にある場合、この実装は UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の remove

パラメータ:

o - コレクションから削除される要素 (その要素がある場合)

戻り値:

コレクションに指定された要素がある場合は true

add

public boolean add(E o)

クラス AbstractCollection の記述:

指定された要素がこのコレクションに格納されていることを保証します (任意のオペレーション)。呼び出しの結果コレクションが変更された場合に true を返します。このコレクションが要素の重複を許可せず、指定された要素がすでに含まれている場合は false を返します。このオペレーションをサポートするコレクションでは、コレクションに追加できる要素に制限を加えることができます。たとえば、コレクションによっては、null 要素の追加が許可されないことや、追加される要素の型を制限することがあります。追加される要素に関して制限がある場合は、その Collection クラスのドキュメントに明示すべきでしょう。

この実装は、常に UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の add

パラメータ:

o - コレクションにあるかどうかを調べる要素

戻り値:

この呼び出しの結果、コレクションが変更された場合は true

containsAll

public boolean containsAll(Collection<?> c)

クラス AbstractCollection の記述:

このコレクション内に、指定されたコレクションのすべての要素がある場合に true を返します。

この実装は指定されたコレクションの内容を次々調べ、反復子によって返された各要素について、このコレクションに含まれるかどうかを順番に確認します。すべての要素がこのコレクションにある場合は true を返し、そうでない場合は false を返します。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の containsAll

パラメータ:

c - このコレクションにあるかどうかを調べるコレクション

戻り値:

指定されたコレクションのすべての要素がこのコレクション内にある場合は true

関連項目:

AbstractCollection.contains(Object)

addAll

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

クラス AbstractCollection の記述:

指定されたコレクションのすべての要素をこのコレクションに追加します (任意のオペレーション)。オペレーションの進行中に、指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。したがって、指定されたコレクションがこのコレクション自身であり、このコレクションが空ではない場合、この呼び出しの動作は定義されていません。

この実装は、指定されたコレクションに対して反復を行い、反復子が返すオブジェクトをこのコレクションに順に追加していく操作を繰り返します。

指定されたコレクションが空でない場合は、add メソッドがオーバーライドされない限り、この実装は UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の addAll

パラメータ:

c - 要素がこのコレクションに追加されるコレクション

戻り値:

この呼び出しの結果、このコレクションが変更された場合は true

関連項目:

AbstractCollection.add(Object)

removeAll

public boolean removeAll(Collection<?> c)

クラス AbstractSet の記述:

このセットから、指定されたコレクションに含まれる要素をすべて削除します (任意のオペレーション)。

この実装は、size メソッドを呼び出して、このセットおよび指定されたコレクションのどちらが小さいかを判別します。このセットに要素があまりない場合、実装でこのセットを繰り返し、各要素が反復子で返されることを確認して、指定されたコレクションに含まれることを確認します。要素が含まれる場合は、反復子の remove メソッドを使ってこのセットから削除されます。指定されたコレクションでは要素が少ない場合、指定されたコレクションで実装を繰り返し、このセットの remove メソッドを用いて、反復子が返した各要素をこのセットから削除します。

iterator メソッドで返された反復子が remove メソッドを実装していない場合、この実装は UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractSet<E> 内の removeAll

パラメータ:

c - このセットから削除される要素

戻り値:

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

関連項目:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

クラス AbstractCollection の記述:

このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します (任意のオペレーション)。つまり、指定されたコレクションに格納されていないすべての要素をこのコレクションから削除します。

この実装はこのコレクションの内容を次々調べ、反復子によって返された各要素について、指定されたコレクションに含まれるかどうかを順番に確認します。含まれない要素があれば、反復子の remove メソッドを使ってこのコレクションから削除します。

iterator メソッドで返された反復子が remove メソッドを実装せず、指定されたコレクションに含まれない要素が 1 つでもこのコレクション内にある場合は、この実装は UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

クラス AbstractCollection<E> 内の retainAll

パラメータ:

c - コレクションで保持される要素

戻り値:

この呼び出しの結果、このコレクションが変更された場合は true

関連項目:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)