java.util

クラス ArrayList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

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

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

直系の既知のサブクラス:

AttributeList, RoleList, RoleUnresolvedList

public class ArrayList<E>
extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, Serializable

List インタフェースのサイズ変更可能な配列の実装です。リストのオプションの操作をすべて実装し、null を含むすべての要素を許容します。このクラスは、List インタフェースを実装するほか、リストを格納するために内部的に使われる配列のサイズを操作するメソッドを提供します。(このクラスは、同期化されないことを除いて Vector とほぼ同等。)

size、isEmpty、get、set、iterator、および listIterator の処理は、一定の時間で実行されます。add の処理も、一定の償却時間で実行されます。つまり、n 個の要素を追加するには O(n) 時間が必要です。ほとんどの場合、ほかのすべての処理も比例的な時間で実行されます。定数の係数は、LinkedList の実装の場合より小さくなります。

各 ArrayList のインスタンスには、容量があります。容量とは、リストの要素を格納するために使用する配列のサイズです。これは常にリストのサイズ以上の大きさになります。ArrayList に要素を追加すると、その容量は自動的に拡大します。拡大のポリシーについては、要素を追加すると「一定の償却時間コスト」が伴うこと以外は、詳しくは指定されていません。

アプリケーションでは、ensureCapacity を使って ArrayList のインスタンスの容量を拡大してから、多くの要素を追加できます。これにより、増加に対する再割り当てが軽減される場合があります。

この実装は同期化されません。複数のスレッドが並行して ArrayList のインスタンスにアクセスし、1 つ以上のスレッドが構造的にリストを変更する場合には、リストを外部的に同期化する必要があります。構造的な変更とは、1 つ以上の要素を追加または削除したり、基になる配列のサイズを明示的に変更したりする処理のことです。要素の値だけを設定する処理は、構造的な変更ではありません。通常、リストの同期をとるには、リストを自然にカプセル化するオブジェクトで同期をとります。 そのようなオブジェクトが存在しない場合は、Collections.synchronizedList メソッドを使用してリストを「ラップ」する必要があります。これは、リストへの偶発的な非同期アクセスを防ぐために、作成時に行うのが最適です。

   List list = Collections.synchronizedList(new ArrayList(...));

このクラスの iterator および listIterator メソッドによって返されるイテレータは、フェイルファストです。イテレータの作成後に、イテレータ自体の remove または add メソッド以外の方法でリストが構造的に変更されると、イテレータは ConcurrentModificationException をスローします。このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。

通常、非同期の並行変更がある場合、確かな保証を行うことは不可能なので、イテレータのフェイルファストの動作を保証することはできません。フェイルファストイテレータは最善努力原則に基づき、ConcurrentModificationException をスローします。したがって、正確を期すためにこの例外に依存するプログラムを書くことは誤りです。「イテレータのフェイルファストの動作はバグを検出するためにのみ使用すべきです」。

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

導入されたバージョン:

1.2

関連項目:

Collection, List, LinkedList, Vector, 直列化された形式

フィールドのサマリー

クラス java.util.AbstractList から継承されたフィールド

modCount

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

コンストラクタ

コンストラクタと説明
ArrayList() 初期容量 10 で空のリストを作成します。
ArrayList(Collection<? extends E> c) 指定されたコレクションの要素が含まれているリストを、要素がコレクションのイテレータによって返される順序で作成します。
ArrayList(int initialCapacity) 指定された初期容量で空のリストを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	add(E e) リストの最後に、指定された要素を追加します。
void	add(int index, E element) リスト内の指定された位置に指定された要素を挿入します。
boolean	addAll(Collection<? extends E> c) 指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でリストの最後に追加します。
boolean	addAll(int index, Collection<? extends E> c) 指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します。
void	clear() リストからすべての要素を削除します。
Object	clone() この ArrayList インスタンスのシャローコピーを返します。
boolean	contains(Object o) 指定の要素がリストに含まれている場合に true を返します。
void	ensureCapacity(int minCapacity) この ArrayList インスタンスの容量を必要に応じて増やし、少なくとも最小容量引数で指定される要素数を保持できるようにします。
E	get(int index) リスト内の指定された位置にある要素を返します。
int	indexOf(Object o) 指定された要素がリスト内で最初に検出された位置のインデックスを返します。指定された要素がリストにない場合は -1 を返します。
boolean	isEmpty() リストに要素がない場合に true を返します。
Iterator<E>	iterator() このリスト内の要素を適切な順序で繰り返し処理するイテレータを返します。
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) リストから、指定されたコレクション内に保持されているすべての要素を削除します。
protected void	removeRange(int fromIndex, int toIndex) fromIndex (これを含む) から toIndex (これを含まない) の範囲のインデックスを持つすべての要素をこのリストから削除します。
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) リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。
void	trimToSize() この ArrayList インスタンスの容量をリストの現在のサイズにまで減らします。

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

equals, hashCode

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

containsAll, toString

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

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

インタフェース java.util.List から継承されたメソッド

containsAll, equals, hashCode

コンストラクタの詳細

ArrayList

public ArrayList(int initialCapacity)

指定された初期容量で空のリストを作成します。

パラメータ:

initialCapacity - リストの初期容量

例外:

IllegalArgumentException - 指定された初期容量が負の場合

ArrayList

public ArrayList()

初期容量 10 で空のリストを作成します。

ArrayList

public ArrayList(Collection<? extends E> c)

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

パラメータ:

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

例外:

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

メソッドの詳細

trimToSize

public void trimToSize()

この ArrayList インスタンスの容量をリストの現在のサイズにまで減らします。アプリケーションでは、このオペレーションを使用して ArrayList のインスタンスのストレージを最小にすることができます。

ensureCapacity

public void ensureCapacity(int minCapacity)

この ArrayList インスタンスの容量を必要に応じて増やし、少なくとも最小容量引数で指定される要素数を保持できるようにします。

パラメータ:

minCapacity - 目的の最小容量

size

public int size()

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

定義:

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

定義:

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

定義:

size、クラス: AbstractCollection<E>

戻り値:

リスト内の要素数

isEmpty

public boolean isEmpty()

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

定義:

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

定義:

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

オーバーライド:

isEmpty、クラス: AbstractCollection<E>

戻り値:

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

contains

public boolean contains(Object o)

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

定義:

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

定義:

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

オーバーライド:

contains、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

indexOf

public int indexOf(Object o)

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

定義:

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

オーバーライド:

indexOf、クラス: AbstractList<E>

パラメータ:

o - 検索する要素

戻り値:

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

lastIndexOf

public int lastIndexOf(Object o)

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

定義:

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

オーバーライド:

lastIndexOf、クラス: AbstractList<E>

パラメータ:

o - 検索する要素

戻り値:

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

clone

public Object clone()

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

オーバーライド:

clone、クラス: Object

戻り値:

この ArrayList のインスタンスの複製

関連項目:

Cloneable

toArray

public Object[] toArray()

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

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

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

定義:

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

定義:

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

オーバーライド:

toArray、クラス: AbstractCollection<E>

戻り値:

リスト内のすべての要素を適切な順序で格納している配列

関連項目:

Arrays.asList(Object[])

toArray

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

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

指定された配列にリストが収まり、その配列にさらに余分な領域がある場合、つまり配列にリストより多くの要素がある場合、配列でコレクションの末尾に続く要素は null に設定されます。このリストに null 要素がないことを呼び出し側が知っている場合にのみ、この特性を利用してリストの長さを判断できます。

定義:

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

定義:

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

オーバーライド:

toArray、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

リストの要素が格納されている配列

例外:

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

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

get

public E get(int index)

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

定義:

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

定義:

get、クラス: AbstractList<E>

パラメータ:

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

戻り値:

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

例外:

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

set

public E set(int index,
    E element)

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

定義:

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

オーバーライド:

set、クラス: AbstractList<E>

パラメータ:

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

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

戻り値:

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

例外:

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

add

public boolean add(E e)

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

定義:

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

定義:

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

オーバーライド:

add、クラス: AbstractList<E>

パラメータ:

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

戻り値:

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

add

public void add(int index,
       E element)

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

定義:

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

オーバーライド:

add、クラス: AbstractList<E>

パラメータ:

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

element - 挿入される要素

例外:

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

remove

public E remove(int index)

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

定義:

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

オーバーライド:

remove、クラス: AbstractList<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>

オーバーライド:

remove、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

clear

public void clear()

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

定義:

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

定義:

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

オーバーライド:

clear、クラス: AbstractList<E>

addAll

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

指定されたコレクション内のすべての要素を、指定されたコレクションのイテレータによって返される順序でリストの最後に追加します。オペレーションの進行中に、指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。つまり、指定されたコレクションがこのリスト自身であり、リストが空でない場合、この呼び出しの動作は保証されません。

定義:

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

定義:

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

オーバーライド:

addAll、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

関連項目:

AbstractCollection.add(Object)

addAll

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

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

定義:

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

オーバーライド:

addAll、クラス: AbstractList<E>

パラメータ:

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

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

戻り値:

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

例外:

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

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

removeRange

protected void removeRange(int fromIndex,
               int toIndex)

fromIndex (これを含む) から toIndex (これを含まない) の範囲のインデックスを持つすべての要素をこのリストから削除します。後続の要素は左に移動します (インデックス値が減少)。この呼び出しにより、(toIndex - fromIndex) の要素数だけリストが短くなります。toIndex==fromIndex の場合、このオペレーションは何も行いません。

オーバーライド:

removeRange、クラス: AbstractList<E>

パラメータ:

fromIndex - 削除する最初の要素のインデックス

toIndex - 削除する最後の要素の直後のインデックス

例外:

IndexOutOfBoundsException - fromIndex または toIndex が範囲外の場合 (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)

removeAll

public boolean removeAll(Collection<?> c)

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

定義:

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

定義:

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

オーバーライド:

removeAll、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

Collection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

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

定義:

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

定義:

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

オーバーライド:

retainAll、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

Collection.contains(Object)

listIterator

public ListIterator<E> listIterator(int index)

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

返されるリストイテレータは、フェイルファストです。

定義:

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

オーバーライド:

listIterator、クラス: AbstractList<E>

パラメータ:

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

戻り値:

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

例外:

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

listIterator

public ListIterator<E> listIterator()

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

返されるリストイテレータは、フェイルファストです。

定義:

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

オーバーライド:

listIterator、クラス: AbstractList<E>

戻り値:

リスト内の要素を適切な順序で繰り返し処理するリストイテレータ

関連項目:

listIterator(int)

iterator

public Iterator<E> iterator()

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

返されるイテレータは、フェイルファストです。

定義:

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

定義:

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

定義:

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

オーバーライド:

iterator、クラス: AbstractList<E>

戻り値:

リスト内の要素を適切な順序で繰り返し処理するイテレータ

subList

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

このリストの、指定された fromIndex (これを含む) から toIndex (これを含まない) までの部分のビューを返します。fromIndex と toIndex が等しい場合は、空のリストが返されます。そのため、返されるリスト内での非構造的な変更はこのリストに反映され、このリスト内での変更は返されるリストに反映されます。返されるリストは、リストに関連するオプションのオペレーションをすべてサポートします。

このメソッドは、配列に一般的に見られるような、明示的な範囲操作のための要求を不要にします。リストを要求するいかなる操作もリスト全体ではなく、subList ビュー上で操作することで、範囲操作として使用できます。たとえば、次の慣用法は、指定された範囲の要素をリストから削除します。

      list.subList(from, to).clear();
 

indexOf(Object) および lastIndexOf(Object) でも、同様の慣用法を作成できます。Collections クラスのアルゴリズムがすべて subList に適用できます。

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

定義:

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

オーバーライド:

subList、クラス: AbstractList<E>

パラメータ:

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

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

戻り値:

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

例外:

IndexOutOfBoundsException - 端点のインデックス値が範囲外の場合 (fromIndex < 0 || toIndex > size)

IllegalArgumentException - 端点のインデックスの順番が正しくない場合 (fromIndex > toIndex)