java.util
インタフェース List<E>

すべてのスーパーインタフェース:

Collection<E>, Iterable<E>

既知の実装クラスの一覧:

AbstractList, AbstractSequentialList, ArrayList, AttributeList, CopyOnWriteArrayList, LinkedList, RoleList, RoleUnresolvedList, Stack, Vector

public interface List<E>
extends Collection<E>

順序付けられたコレクションです。「シーケンス」とも呼ばれます。このインタフェースのユーザは、リスト内のどこに各要素が挿入されるかを精密に制御できます。ユーザは整数値のインデックス (リスト内の位置) によって要素にアクセスしたり、リスト内の要素を検索したりすることができます。

セットとは異なり、通常、リストは重複する要素を許可します。つまり、リストは、通常 e1.equals(e2) となるような、e1 と e2 の要素のペアを許可します。また、null 要素を許可する場合には、通常は複数の null 要素を許可します。ユーザが重複する値を挿入しようとしたときに実行時の例外をスローすることにより、重複する値を禁止するリストを実装する場合もありますが、このように使われることはほとんどありません。

List インタフェースは、iterator、add、remove、equals、および hashCode の各メソッドの規約に対して、Collection インタフェースで指定されているものに加えてさらに条項を追加します。他の継承メソッドの宣言も便宜上ここに含まれます。

List インタフェースは、位置を指定して (インデックスで) リストの要素にアクセスするための 4 つのメソッドを提供します。Java 配列と同様に、List のインデックスは 0 から始まります。一部の実装 (LinkedList クラスなど) では、これらのオペレーションの実行にはインデックス値に比例した時間がかかる場合があります。このため、呼び出し側がこうした実装について知らない場合は、リストにインデックスを付けるよりも、リスト内の要素の繰り返し処理を行なってください。

List インタフェースは、Iterator インタフェースが提供する通常のオペレーションに加えて、要素の挿入、置換、および双方向アクセスを可能にする、ListIterator という特殊な反復子を提供します。リスト内の指定した位置から開始するリスト反復子を取得するためのメソッドが提供されています。

List インタフェースは、指定したオブジェクトを検索するための 2 つのメソッドを提供します。パフォーマンスの観点からは、これらのメソッドは注意して使用する必要があります。多くの実装でこれらのメソッドは、時間のかかる線形探索を実行します。

リスト内の任意の位置に複数の要素を効率的に挿入および削除するために、List インタフェースは 2 つのメソッドを提供します。

注: リストにリスト自体を要素として格納することも可能ですが、十分注意してください。そのようなリストでは equals メソッドおよび hashCode メソッドの動作は保証されません。

リストの実装には、格納できる要素に制限があるものもあります。たとえば、null 要素を禁止する実装や、null 要素の型に制限がある実装もあります。不適当な要素を追加しようとすると、通常 NullPointerException または ClassCastException のようなチェックされない例外がスローされます。不適当な要素を照会しようとすると、例外がスローされる場合もあれば、false がただ返される場合もあります。前の動作を禁止する実装もあれば、あとの動作を禁止する実装もあります。もう少し一般的に言うと、リストへの挿入がされない不適当な要素を処理しようとすると、例外がスローされる場合もあれば、処理が有効になる場合もあります。このインタフェースに関するそうした例外は、「任意」の仕様としてマークされます。

このインタフェースは、Java Collections Framework のメンバです。

導入されたバージョン:

1.2

関連項目:

Collection, Set, ArrayList, LinkedList, Vector, Arrays.asList(Object[]), Collections.nCopies(int, Object), Collections.EMPTY_LIST, AbstractList, AbstractSequentialList

メソッドの概要

boolean	add(E o) 指定された要素をリストの最後に追加します (任意のオペレーション)。
void	add(int index, E element) リスト内の指定された位置に、指定された要素を挿入します (任意のオペレーション)。
boolean	addAll(Collection<? extends E> c) 指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でリストの最後に追加します (任意のオペレーション)。
boolean	addAll(int index, Collection<? extends E> c) 指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します (任意のオペレーション)。
void	clear() すべての要素をリストから削除します (任意のオペレーション)。
boolean	contains(Object o) リストに指定された要素が含まれている場合に true を返します。
boolean	containsAll(Collection<?> c) 指定されたコレクションのすべての要素がリストに含まれている場合に true を返します。
boolean	equals(Object o) 指定されたオブジェクトがリストと等しいかどうかを比較します。
E	get(int index) リスト内の指定された位置にある要素を返します。
int	hashCode() リストのハッシュコード値を返します。
int	indexOf(Object o) 指定された要素がリスト内で最初に検出された位置のインデックスを返します。
boolean	isEmpty() リストに要素がない場合に true を返します。
Iterator<E>	iterator() このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
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) リスト内のすべて要素を適切な順序で格納している配列を返します。

メソッドの詳細

size

int size()

リスト内の要素数を返します。このリストに Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。

定義:

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

戻り値:

リスト内の要素数

isEmpty

boolean isEmpty()

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

定義:

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

戻り値:

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

contains

boolean contains(Object o)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素の型がこのリストと互換でない場合 (任意のオプション)

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合 (任意のオプション)

iterator

Iterator<E> iterator()

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

定義:

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

定義:

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

戻り値:

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

toArray

Object[] toArray()

リスト内のすべて要素を適切な順序で格納している配列を返します。Collection.toArray メソッドの一般規約に従います。

定義:

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

戻り値:

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

関連項目:

Arrays.asList(Object[])

toArray

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

リスト内のすべて要素を適切な順序で格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。Collection.toArray(Object[]) メソッドの一般規約に従います。

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

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

add

boolean add(E o)

指定された要素をリストの最後に追加します (任意のオペレーション)。

このオペレーションをサポートするリストは、リストに追加できる要素に制限を加える場合があります。特に、リストには null 要素の追加を拒否するものもあれば、追加される要素の型について制限を加えるものもあります。List クラスは、List に追加できる要素について制約があれば、ドキュメントでそれを明確に指定する必要があります。

定義:

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

パラメータ:

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

戻り値:

true (Collection.add メソッドの一般規約に従う)

例外:

UnsupportedOperationException - リストが add メソッドをサポートしていない場合

ClassCastException - 指定された要素のクラスのために、リストに要素を追加できない場合

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合

IllegalArgumentException - この要素の特性が原因で、このリストに追加できない場合

remove

boolean remove(Object o)

リスト内で指定された要素が最初に検出されたとき、その要素を削除します (任意のオペレーション)。リストにその要素がない場合は、変更されません。つまり、(o==null ? get(i)==null : o.equals(get(i))) となる、最小のインデックス値 i を持つ要素を削除します (そのような要素が存在する場合)。

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定された要素の型がこのリストと互換でない場合 (任意のオプション)

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合 (任意のオプション)

UnsupportedOperationException - リストが remove メソッドをサポートしていない場合

containsAll

boolean containsAll(Collection<?> c)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

ClassCastException - 指定されたコレクションの 1 つまたは複数の要素の型が、このリストと互換でない場合 (任意のオプション)

NullPointerException - 指定されたコレクションが 1 つまたは複数の null 要素を含み、このリストが null 要素をサポートしない場合 (任意のオプション)

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

関連項目:

contains(Object)

addAll

boolean addAll(Collection<? extends E> c)

指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でリストの最後に追加します (任意のオペレーション)。指定されたコレクションがオペレーションの進行中に変更された場合、このオペレーションの動作は保証されません。つまり、指定されたコレクションがこのリストで、しかも空ではない場合に起こります。

定義:

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

パラメータ:

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

戻り値:

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

例外:

UnsupportedOperationException - リストが addAll メソッドをサポートしていない場合

ClassCastException - 指定されたコレクション内の要素のクラスが原因で、リストに要素を追加できない場合

NullPointerException - 指定されたコレクション内に 1 つまたは複数の null 要素が含まれず、このリストが null 要素をサポートしない場合。または指定されたコレクションが null の場合

IllegalArgumentException - 指定されたコレクション内の要素の特性が原因で、リストに要素を追加できない場合

関連項目:

add(Object)

addAll

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

指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します (任意のオペレーション)。現在その位置にある要素と後続の要素は右に移動します (インデックス値が増加)。新しい要素は、指定されたコレクションの反復子によって返される順序でリストに挿入されます。指定されたコレクションがオペレーションの進行中に変更された場合、このオペレーションの動作は保証されません。つまり、指定されたコレクションがこのリストで、しかも空ではない場合に起こります。

パラメータ:

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

c - リストに挿入される要素

戻り値:

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

例外:

UnsupportedOperationException - リストが addAll メソッドをサポートしていない場合

ClassCastException - 指定されたコレクションのいずれかの要素のクラスが原因で、リストに要素を追加できない場合

NullPointerException - 指定されたコレクション内に 1 つまたは複数の null 要素が含まれず、このリストが null 要素をサポートしない場合。または指定されたコレクションが null の場合

IllegalArgumentException - 指定されたコレクションのどれかの要素の特性が原因で、リストに要素を追加できない場合

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

removeAll

boolean removeAll(Collection<?> c)

指定されたコレクションに格納されているすべての要素をリストから削除します (任意のオペレーション)。

定義:

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

パラメータ:

c - どの要素がリストから削除されるかを定義するコレクション

戻り値:

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

例外:

UnsupportedOperationException - リストが removeAll メソッドをサポートしていない場合

ClassCastException - このコレクションの 1 つまたは複数の要素の型が、指定されたリストと互換でない場合 (任意のオプション)

NullPointerException - このリストが 1 つまたは複数の null 要素を含み、指定されたコレクションが null 要素をサポートしない場合 (任意のオプション)

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

関連項目:

remove(Object), contains(Object)

retainAll

boolean retainAll(Collection<?> c)

指定されたコレクションに格納されている要素だけがリスト内に含まれるようにします (任意のオペレーション)。つまり、指定されたコレクションに含まれていない要素をリストからすべて削除します。

定義:

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

パラメータ:

c - セットが保持する要素を定義するコレクション

戻り値:

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

例外:

UnsupportedOperationException - リストが retainAll メソッドをサポートしていない場合

ClassCastException - このコレクションの 1 つまたは複数の要素の型が、指定されたリストと互換でない場合 (任意のオプション)

NullPointerException - このリストが 1 つまたは複数の null 要素を含み、指定されたコレクションが null 要素をサポートしない場合 (任意のオプション)

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

関連項目:

remove(Object), contains(Object)

clear

void clear()

すべての要素をリストから削除します (任意のオペレーション)。この呼び出しからの復帰後、リストは空になります (例外をスローした場合を除く)。

定義:

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

例外:

UnsupportedOperationException - リストが clear メソッドをサポートしていない場合

equals

boolean equals(Object o)

指定されたオブジェクトがリストと等しいかどうかを比較します。指定されたオブジェクトもリストであり、サイズが同じで、2 つのリストの対応する要素がすべて「等しい」場合にだけ true を返します。2 つの要素 e1 および e2 は、(e1==null ? e2==null : e1.equals(e2)) の場合に等しいと見なされます。つまり 2 つのリストは、同じ要素が同じ順序で含まれている場合に等しいものとして定義されます。この定義により、List インタフェースの実装が異なっても、equals メソッドが正しく動作することが保証されます。

定義:

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

オーバーライド:

クラス Object 内の equals

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode(), Hashtable

hashCode

int hashCode()

リストのハッシュコード値を返します。リストのハッシュコードは、次の計算の結果として定義されます。

  hashCode = 1;
  Iterator i = list.iterator();
  while (i.hasNext()) {
      Object obj = i.next();
      hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
  }
 

これにより、Object.hashCode の一般規約によって要求されるように、任意の 2 つのリスト list1 と list2 で、list1.equals(list2) であれば、list1.hashCode()==list2.hashCode() となることが保証されます。

定義:

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

オーバーライド:

クラス Object 内の hashCode

戻り値:

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

関連項目:

Object.hashCode(), Object.equals(Object), equals(Object)

get

E get(int index)

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

パラメータ:

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

戻り値:

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

例外:

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

set

E set(int index,
      E element)

リスト内の指定された位置にある要素を、指定された要素に置き換えます (任意のオペレーション)。

パラメータ:

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

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

戻り値:

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

例外:

UnsupportedOperationException - リストが set メソッドをサポートしていない場合

ClassCastException - 指定された要素のクラスのために、リストに要素を追加できない場合

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合

IllegalArgumentException - この要素の一部の特性のために、リストに要素を追加できない場合

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

add

void add(int index,
         E element)

リスト内の指定された位置に、指定された要素を挿入します (任意のオペレーション)。現在その位置にある要素と後続の要素は右に移動します (インデックス値に 1 を加算)。

パラメータ:

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

element - 挿入される要素

例外:

UnsupportedOperationException - リストが add メソッドをサポートしていない場合

ClassCastException - 指定された要素のクラスのために、リストに要素を追加できない場合

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合

IllegalArgumentException - この要素の一部の特性のために、リストに要素を追加できない場合

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

remove

E remove(int index)

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

パラメータ:

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

戻り値:

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

例外:

UnsupportedOperationException - リストが remove メソッドをサポートしていない場合

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

indexOf

int indexOf(Object o)

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

パラメータ:

o - 検索する要素

戻り値:

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

例外:

ClassCastException - 指定された要素の型がこのリストと互換でない場合 (任意のオプション)

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合 (任意のオプション)

lastIndexOf

int lastIndexOf(Object o)

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

パラメータ:

o - 検索する要素

戻り値:

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

例外:

ClassCastException - 指定された要素の型がこのリストと互換でない場合 (任意のオプション)

NullPointerException - 指定された要素が null で、このリストが null 要素をサポートしない場合 (任意のオプション)

listIterator

ListIterator<E> listIterator()

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

戻り値:

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

listIterator

ListIterator<E> listIterator(int index)

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

パラメータ:

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

戻り値:

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

例外:

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

subList

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

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

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

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

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

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

パラメータ:

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

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

戻り値:

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

例外:

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