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 からの削除に続くアクションよりも前に発生します。

このクラスは、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 から検索して最初に検出された位置のインデックスを返します。要素が見つからない場合は -1 を返します。
int	indexOf(Object o) 指定された要素がこのリスト内で最初に検出された位置のインデックスを返します。指定された要素がこのリストにない場合は -1 を返します。
boolean	isEmpty() このリストに要素がない場合に true を返します。
Iterator<E>	iterator() このリスト内の要素を適切な順序で反復するイテレータを返します。
int	lastIndexOf(E e, int index) 指定された要素をリスト内で index から後向きに検索して最後に検出された位置のインデックスを返します。要素が見つからない場合は -1 を返します。
int	lastIndexOf(Object o) 指定された要素がこのリスト内で最後に検出された位置のインデックスを返します。指定された要素がこのリストにない場合は -1 を返します。
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()

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

定義:

size、インタフェース: Collection<E>

定義:

size、インタフェース: List<E>

戻り値:

このリスト内の要素数

isEmpty

public boolean isEmpty()

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

定義:

isEmpty、インタフェース: Collection<E>

定義:

isEmpty、インタフェース: List<E>

戻り値:

このリストに要素が含まれていない場合は true

contains

public boolean contains(Object o)

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

定義:

contains、インタフェース: Collection<E>

定義:

contains、インタフェース: List<E>

パラメータ:

o - このリスト内にあるかどうかが判定される要素

戻り値:

指定された要素がこのリスト内にある場合は true

indexOf

public int indexOf(Object o)

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

定義:

indexOf、インタフェース: List<E>

パラメータ:

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 を返します。

定義:

lastIndexOf、インタフェース: List<E>

パラメータ:

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

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

オーバーライド:

clone、クラス: Object

戻り値:

このリストの複製

関連項目:

Cloneable

toArray

public Object[] toArray()

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

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

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

定義:

toArray、インタフェース: Collection<E>

定義:

toArray、インタフェース: List<E>

戻り値:

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

関連項目:

Arrays.asList(Object[])

toArray

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

このリスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 含んでいる配列を返します。返される配列の実行時の型は、指定された配列の型になります。指定された配列にリストが収まる場合は、その配列で返されます。それ以外の場合は、指定された配列の実行時の型とこのリストのサイズを使って新しい配列が割り当てられます。

リストが指定された配列に収まり、その配列にさらに余裕がある場合 (つまり、配列がリストより多くの要素を持つ場合)、その配列内でリストの終端よりあとの要素は null に設定されます。(これは、呼び出し側がこのリストに null 要素が 1 つも含まれていないことがわかっている場合にのみ、このリストの長さを判定するのに役立ちます。)

toArray() メソッドと同じように、このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割り当ての手間を抑えるために使用できます。

x が、文字列だけからなるリストであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられた String の配列内にリストをダンプできます。

     String[] y = x.toArray(new String[0]);

toArray(new Object[0]) は、機能の点で toArray() と同一です。

定義:

toArray、インタフェース: Collection<E>

定義:

toArray、インタフェース: List<E>

パラメータ:

a - 配列が十分な大きさを持つ場合は、このリストの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。

戻り値:

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

例外:

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

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

get

public E get(int index)

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

定義:

get、インタフェース: List<E>

パラメータ:

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

戻り値:

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

例外:

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

set

public E set(int index,
    E element)

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

定義:

set、インタフェース: List<E>

パラメータ:

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

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

戻り値:

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

例外:

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

add

public boolean add(E e)

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

定義:

add、インタフェース: Collection<E>

定義:

add、インタフェース: List<E>

パラメータ:

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

戻り値:

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

add

public void add(int index,
       E element)

このリスト内の指定された位置に指定された要素を挿入します。その位置の現在の要素 (ある場合) とそれ以降の要素を右に移動します (インデックスに 1 を加算)。

定義:

add、インタフェース: List<E>

パラメータ:

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

element - 挿入される要素

例外:

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

remove

public E remove(int index)

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

定義:

remove、インタフェース: List<E>

パラメータ:

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

戻り値:

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

例外:

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

remove

public boolean remove(Object o)

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

定義:

remove、インタフェース: Collection<E>

定義:

remove、インタフェース: List<E>

パラメータ:

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

戻り値:

指定された要素がこのリストに含まれていた場合は true

addIfAbsent

public boolean addIfAbsent(E e)

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

パラメータ:

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

戻り値:

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

containsAll

public boolean containsAll(Collection<?> c)

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

定義:

containsAll、インタフェース: Collection<E>

定義:

containsAll、インタフェース: List<E>

パラメータ:

c - このリストにあるかどうかがチェックされるコレクション

戻り値:

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

例外:

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

関連項目:

contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

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

定義:

removeAll、インタフェース: Collection<E>

定義:

removeAll、インタフェース: List<E>

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

remove(Object)

retainAll

public boolean retainAll(Collection<?> c)

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

定義:

retainAll、インタフェース: Collection<E>

定義:

retainAll、インタフェース: List<E>

パラメータ:

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

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

定義:

clear、インタフェース: Collection<E>

定義:

clear、インタフェース: List<E>

addAll

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

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

定義:

addAll、インタフェース: Collection<E>

定義:

addAll、インタフェース: List<E>

パラメータ:

c - このリストに追加される要素を含むコレクション

戻り値:

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

例外:

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

関連項目:

add(Object)

addAll

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

指定されたコレクション内のすべての要素を、このリストの指定された位置に挿入します。その位置の現在の要素 (ある場合) とそれ以降の要素を右に移動します (インデックスが増えます)。新しい要素は、指定されたコレクションのイテレータによって返される順序でこのリストに挿入されます。

定義:

addAll、インタフェース: List<E>

パラメータ:

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

c - このリストに追加される要素を含むコレクション

戻り値:

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

例外:

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

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

関連項目:

add(int,Object)

toString

public String toString()

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

オーバーライド:

toString、クラス: Object

戻り値:

このリストの文字列表現

equals

public boolean equals(Object o)

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

定義:

equals、インタフェース: Collection<E>

定義:

equals、インタフェース: List<E>

オーバーライド:

equals、クラス: Object

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

hashCode

public int hashCode()

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

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

定義:

hashCode、インタフェース: Collection<E>

定義:

hashCode、インタフェース: List<E>

オーバーライド:

hashCode、クラス: Object

戻り値:

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

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

iterator

public Iterator<E> iterator()

このリスト内の要素を適切な順序で反復するイテレータを返します。

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

定義:

iterator、インタフェース: Iterable<E>

定義:

iterator、インタフェース: Collection<E>

定義:

iterator、インタフェース: List<E>

戻り値:

リスト内の要素を適切な順序で反復するイテレータ

listIterator

public ListIterator<E> listIterator()

このリスト内の要素を適切な順序で反復するリストイテレータを返します。

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

定義:

listIterator、インタフェース: List<E>

戻り値:

このリスト内の要素を適切な順序で反復するリストイテレータ

listIterator

public ListIterator<E> listIterator(int index)

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

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

定義:

listIterator、インタフェース: List<E>

パラメータ:

index - リストイテレータから (next 呼び出しによって) 返される最初の要素のインデックス

戻り値:

リスト内の指定された位置で始まる、リスト内の要素を適切な順序で反復するリストイテレータ

例外:

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

subList

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

このリストの、fromIndex (これを含む) と toIndex (これを含まない) の間の部分のビューを返します。返されるリストはこのリストに連動しているため、返されるリスト内の変更はこのリストに反映されます。

バッキングリスト (つまり、このリスト) が、返されたリストを経由せずに変更された場合、このメソッドで返されたリストのセマンティクスは未定義になります。

定義:

subList、インタフェース: List<E>

パラメータ:

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

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

戻り値:

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

例外:

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