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

java.lang.Object
  java.util.concurrent.CopyOnWriteArrayList<E>

型パラメータ:

E - コレクション内に存在する要素の型

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

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess

public class CopyOnWriteArrayList<E>
extends Object
implements List<E>, RandomAccess, Cloneable, Serializable

基になる配列の新しいコピーを作成することにより、すべての推移的操作 (add、set など) が実装される ArrayList のスレッドセーフな変数です。

通常、これは非常に効率が悪いのですが、トラバーサル操作が変更を数の点で大幅に上回る場合には、代替手段よりも効率が良い場合があります。また、これは、トラバーサルを同期できない場合や、同期することを望まないが、並行スレッド間の干渉を排除する必要がある場合に有用です。「スナップショット」スタイルの反復子メソッドは、反復子の作成時点での配列状態への参照を使用します。この配列が、反復子の有効期間内に変更されることは決してないため、干渉は不可能であり、反復子は ConcurrentModificationException をスローしないことが保証されます。.反復子は、反復子の作成以降のリストへの追加、削除、または変更を反映しません。反復子自身に対する要素変更操作 (remove、set、および add) は、サポートされません。これらのメソッドは、UnsupportedOperationException をスローします。

null を含むすべての要素が許容されます。

メモリー整合性効果:ほかの並行処理コレクションと同様、オブジェクトを CopyOnWriteArrayList に配置する前のスレッド内のアクションは、別のスレッド内の CopyOnWriteArrayList からその要素にアクセスまたは削除した後のアクションよりも happen-beforeです。

このクラスは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.5

関連項目:

直列化された形式

コンストラクタの概要

CopyOnWriteArrayList()
空のリストを作成します。

CopyOnWriteArrayList(Collection<? extends E> c)
指定されたコレクションの要素が含まれているリストを、要素がコレクションの反復子によって返される順序で作成します。

CopyOnWriteArrayList(E[] toCopyIn)
指定された配列のコピーを保持するリストを作成します。

メソッドの概要

boolean	add(E e) リストの最後に、指定された要素を追加します。
void	add(int index, E element) リスト内の指定された位置に指定された要素を挿入します。
boolean	addAll(Collection<? extends E> c) 指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でリストの最後に追加します。
boolean	addAll(int index, Collection<? extends E> c) 指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します。
int	addAllAbsent(Collection<? extends E> c) このリストに含まれていない、指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でこのリストの最後に追加します。
boolean	addIfAbsent(E e) 要素が存在しない場合、要素を追加します。
void	clear() リストからすべての要素を削除します。
Object	clone() このリストのシャローコピーを返します。
boolean	contains(Object o) リストに指定の要素がある場合に true を返します。
boolean	containsAll(Collection<?> c) 指定されたコレクションのすべての要素がリストに含まれている場合に true を返します。
boolean	equals(Object o) 指定されたオブジェクトがリストと等しいかどうかを比較します。
E	get(int index) リスト内の指定された位置にある要素を返します。
int	hashCode() このリストのハッシュコード値を返します。
int	indexOf(E e, int index) 指定された要素をリスト内で index から検索して最初に検出された位置のインデックスを返します。
int	indexOf(Object o) 指定された要素がリスト内で最初に検出された位置のインデックスを返します。
boolean	isEmpty() リストに要素がない場合に true を返します。
Iterator<E>	iterator() このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
int	lastIndexOf(E e, int index) 指定された要素をリスト内で index から後向きに検索して最後に検出された位置のインデックスを返します。
int	lastIndexOf(Object o) 指定された要素がリスト内で最後に検出された位置のインデックスを返します。
ListIterator<E>	listIterator() このリスト内の要素を適切な順序で繰り返し処理するリスト反復子を返します。
ListIterator<E>	listIterator(int index) リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子を返します。
E	remove(int index) リストの指定された位置にある要素を削除します。
boolean	remove(Object o) 指定された要素がこのリストにあれば、その最初のものをリストから削除します。
boolean	removeAll(Collection<?> c) リストから、指定されたコレクション内に保持されているすべての要素を削除します。
boolean	retainAll(Collection<?> c) 指定されたコレクション内に保持されている、リスト内の要素だけを保持します。
E	set(int index, E element) リストの指定された位置にある要素を、指定された要素で置き換えます。
int	size() リスト内にある要素の数を返します。
List<E>	subList(int fromIndex, int toIndex) このリストの、fromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のビューを返します。
Object[]	toArray() リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。
<T> T[]	toArray(T[] a) リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。
String	toString() このリストの文字列表現を返します。

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

finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

CopyOnWriteArrayList

public CopyOnWriteArrayList()

空のリストを作成します。

CopyOnWriteArrayList

public CopyOnWriteArrayList(Collection<? extends E> c)

指定されたコレクションの要素が含まれているリストを、要素がコレクションの反復子によって返される順序で作成します。

パラメータ:

c - 最初に保持していた要素のコレクション

例外:

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

CopyOnWriteArrayList

public CopyOnWriteArrayList(E[] toCopyIn)

指定された配列のコピーを保持するリストを作成します。

パラメータ:

toCopyIn - 配列 (この配列のコピーは内部配列として使用される)

例外:

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

メソッドの詳細

size

public int size()

リスト内にある要素の数を返します。

定義:

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

定義:

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

戻り値:

リスト内の要素数

isEmpty

public boolean isEmpty()

リストに要素がない場合に true を返します。

定義:

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

定義:

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

戻り値:

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

contains

public boolean contains(Object o)

リストに指定の要素がある場合に true を返します。つまり、リストに、(o==null ? e==null : o.equals(e)) となる要素 e が 1 つ以上含まれている場合にだけ true を返します。

定義:

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

定義:

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

パラメータ:

o - リストにあるかどうかを調べる要素

戻り値:

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

indexOf

public int indexOf(Object o)

指定された要素がリスト内で最初に検出された位置のインデックスを返します。 指定された要素がリストにない場合は -1 を返します。つまり、(o==null ? get(i)==null : o.equals(get(i))) となる、最小のインデックス i を返します。そのようなインデックスが存在しない場合は -1 を返します。

定義:

インタフェース List<E> 内の indexOf

パラメータ:

o - 検索する要素

戻り値:

指定された要素がリスト内で最初に検出された位置のインデックス。その要素がリストにない場合は -1

indexOf

public int indexOf(E e,
                   int index)

指定された要素をリスト内で index から検索して最初に検出された位置のインデックスを返します。要素が見つからない場合は -1 を返します。つまり、(i >= index && (e==null ? get(i)==null : e.equals(get(i)))) を満たす最小のインデックス値 i を返します。このようなインデックスがない場合は、-1 を返します。

パラメータ:

e - 検索する要素

index - 検索開始位置のインデックス

戻り値:

要素がリスト内で最初に現れるインデックス (リストの index またはそれ以降の位置)。要素が見つからない場合は -1

例外:

IndexOutOfBoundsException - 指定されたインデックスが負の場合

lastIndexOf

public int lastIndexOf(Object o)

指定された要素がリスト内で最後に検出された位置のインデックスを返します。 指定された要素がリストにない場合は -1 を返します。つまり、(o==null ? get(i)==null : o.equals(get(i))) となる、最大のインデックス i を返します。そのようなインデックスが存在しない場合は -1 を返します。

定義:

インタフェース List<E> 内の lastIndexOf

パラメータ:

o - 検索する要素

戻り値:

指定された要素がリスト内で最後に検出された位置のインデックス。その要素がリストにない場合は -1

lastIndexOf

public int lastIndexOf(E e,
                       int index)

指定された要素をリスト内で index から後向きに検索して最後に検出された位置のインデックスを返します。要素が見つからない場合は -1 を返します。つまり、(i >= index && (e==null ? get(i)==null : e.equals(get(i)))) を満たす最大のインデックス値 i を返します。このようなインデックスがない場合は、-1 を返します。

パラメータ:

e - 検索する要素

index - 逆方向の検索開始位置のインデックス

戻り値:

要素がリスト内で最後に現れるインデックス (リストの index 以前の位置)。要素が見つからない場合は -1

例外:

IndexOutOfBoundsException - 指定されたインデックスが、このリストの現在のサイズに等しいかそれよりも大きい場合

clone

public Object clone()

このリストのシャローコピーを返します。要素自体はコピーされません。

オーバーライド:

クラス Object 内の clone

戻り値:

このリストの複製

関連項目:

Cloneable

toArray

public Object[] toArray()

リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。

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

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

定義:

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

定義:

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

戻り値:

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

関連項目:

Arrays.asList(Object[])

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

定義:

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

パラメータ:

a - 配列が十分な大きさを持つ場合は、リストの要素が格納される配列。そうでない場合は、要素を格納するために同じ実行時の型の新しい配列が割り当てられる

戻り値:

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

例外:

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

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

get

public E get(int index)

リスト内の指定された位置にある要素を返します。

定義:

インタフェース List<E> 内の get

パラメータ:

index - 返される要素のインデックス

戻り値:

リスト内の指定された位置にある要素

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index >= size())

set

public E set(int index,
             E element)

リストの指定された位置にある要素を、指定された要素で置き換えます。

定義:

インタフェース List<E> 内の set

パラメータ:

index - 置換される要素のインデックス

element - 指定された位置に格納される要素

戻り値:

指定された位置に以前あった要素

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index >= size())

add

public boolean add(E e)

リストの最後に、指定された要素を追加します。

定義:

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

定義:

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

パラメータ:

e - リストに追加される要素

戻り値:

true (Collection.add(E) で指定されているとおり)

add

public void add(int index,
                E element)

リスト内の指定された位置に指定された要素を挿入します。その位置とそれ以降に要素があればそれらを右に移動させ、各要素のインデックスに 1 を加えます。

定義:

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

パラメータ:

index - 指定の要素が挿入される位置のインデックス

element - 挿入される要素

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())

remove

public E remove(int index)

リストの指定された位置にある要素を削除します。後続の要素は左に移動します (インデックス値から 1 を減算)。リストから削除された要素が返されます。

定義:

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

パラメータ:

index - 削除される要素のインデックス

戻り値:

指定された位置に以前あった要素

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index >= size())

remove

public boolean remove(Object o)

指定された要素がこのリストにあれば、その最初のものをリストから削除します。リストにその要素がない場合は、変更されません。つまり、(o==null ? get(i)==null : o.equals(get(i))) となる、最小のインデックス値 i を持つ要素を削除します (そのような要素が存在する場合)。指定された要素がリストに含まれていた場合、つまり、呼び出しの結果としてリストが変更された場合に true を返します。

定義:

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

定義:

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

パラメータ:

o - リストから削除される要素 (その要素が存在する場合)

戻り値:

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

addIfAbsent

public boolean addIfAbsent(E e)

要素が存在しない場合、要素を追加します。

パラメータ:

e - リストに追加される要素 (要素が存在しない場合)

戻り値:

要素が追加された場合は true

containsAll

public boolean containsAll(Collection<?> c)

指定されたコレクションのすべての要素がリストに含まれている場合に true を返します。

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

関連項目:

contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

リストから、指定されたコレクション内に保持されているすべての要素を削除します。これは、内部に一時配列が必要になるため、このクラス内で特に負荷の大きい動作です。

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

remove(Object)

retainAll

public boolean retainAll(Collection<?> c)

指定されたコレクション内に保持されている、リスト内の要素だけを保持します。つまり、指定されたコレクションに格納されていないすべての要素をこのリストから削除します。

定義:

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

remove(Object)

addAllAbsent

public int addAllAbsent(Collection<? extends E> c)

このリストに含まれていない、指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でこのリストの最後に追加します。

パラメータ:

c - 要素がリストに追加されるコレクション

戻り値:

追加される要素の数

例外:

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

関連項目:

addIfAbsent(Object)

clear

public void clear()

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

定義:

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

定義:

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

addAll

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

指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でリストの最後に追加します。

定義:

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

定義:

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

パラメータ:

c - 要素がリストに追加されるコレクション

戻り値:

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

例外:

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

関連項目:

add(Object)

addAll

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

指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します。その位置とそれ以降に要素がある場合は、それらを右に移動して、各要素のインデックスに 1 を加えます。新しい要素は、指定されたコレクションの反復子によって返される順序でリストに挿入されます。

定義:

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

パラメータ:

index - 指定されたコレクションの最初の要素を挿入する位置のインデックス

c - 要素がリストに追加されるコレクション

戻り値:

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

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())

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

関連項目:

add(int,Object)

toString

public String toString()

このリストの文字列表現を返します。文字列表現は、リストの要素の文字列表現をその反復子が返した順に角括弧 ("[]") で囲んで示すリストです。隣接する要素は、文字 ", " (カンマと空白文字) によって区切られます。各要素は、String.valueOf(Object) を実行したかのように文字列に変換されます。

オーバーライド:

クラス Object 内の toString

戻り値:

このリストの文字列表現

equals

public boolean equals(Object o)

指定されたオブジェクトがリストと等しいかどうかを比較します。指定されたオブジェクトがこのオブジェクトと同じオブジェクトである場合、または指定されたオブジェクトが List でもあり、指定されたリストで iterator によって返される要素のシーケンスがこのリストで反復子によって返されるシーケンスと同じである場合、true を返します。この 2 つのシーケンスは、同じ長さを持ち、シーケンス内の同じ位置にある対応する要素が「等しい」場合、同じものと見なされます。2 つの要素 e1 および e2 は、(e1==null ? e2==null :e1.equals(e2)) の場合は等しいと見なされます。

定義:

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

定義:

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

オーバーライド:

クラス Object 内の equals

パラメータ:

o - リストと等しいかどうかを比較するオブジェクト

戻り値:

指定されたオブジェクトがこのリストと等しい場合は true

関連項目:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

このリストのハッシュコード値を返します。

この実装は、List.hashCode() 内の定義を使用します。

定義:

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

定義:

インタフェース List<E> 内の hashCode

オーバーライド:

クラス Object 内の hashCode

戻り値:

リストのハッシュコード値

関連項目:

Object.equals(java.lang.Object), Hashtable

iterator

public Iterator<E> iterator()

このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。

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

定義:

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

定義:

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

定義:

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

戻り値:

リスト内の要素を適切な順序で繰り返し処理する反復子

listIterator

public ListIterator<E> listIterator()

このリスト内の要素を適切な順序で繰り返し処理するリスト反復子を返します。

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

定義:

インタフェース List<E> 内の listIterator

戻り値:

リスト内の要素を適切な順序で繰り返し処理するリスト反復子

listIterator

public ListIterator<E> listIterator(int index)

リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子を返します。指定されたインデックスは、next の最初の呼び出しによって返される最初の要素を示します。previous の最初の呼び出しは、指定されたインデックスから 1 を引いた値のインデックスを持つ要素を返します。

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

定義:

インタフェース List<E> 内の listIterator

パラメータ:

index - リスト反復子から (next メソッド呼び出しによって) 返される最初の要素のインデックス

戻り値:

リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始するリスト反復子

例外:

IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())

subList

public List<E> subList(int fromIndex,
                       int toIndex)

このリストの、fromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のビューを返します。返されるリストはこのリストに連動しているため、返されるリスト内での変更はこのリストに反映され、このリスト内での変更は返されるリストに反映されます。変更操作はサポートされていますが、CopyOnWriteArrayLists ではあまり役立ちません。

バッキングリスト (すなわち、このリスト) の構造が、返されたリストを経由せずに変更された場合、このメソッドで返されたリストのセマンティクスは保証されません。構造の変更とは、リストのサイズが変わるような変更や、進行中の繰り返し処理が不正な結果に終わるような変更のことです。

定義:

インタフェース List<E> 内の subList

パラメータ:

fromIndex - subList の下端点 (これを含む)

toIndex - subList の上端点 (これを含まない)

戻り値:

このリスト内の指定された範囲のビュー

例外:

IndexOutOfBoundsException - 端点のインデックス値が不正である場合 (fromIndex < 0 || toIndex > size || fromIndex > toIndex)