java.util

インタフェース List<E>

型パラメータ:

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 e) 指定された要素をこのリストの最後に追加します (オプションの操作)。
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) 指定された要素がこのリスト内で最初に検出された位置のインデックスを返します。指定された要素がこのリストにない場合は -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) このリストから、指定されたコレクションに含まれる要素をすべて削除します (オプションの操作)。
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 を返します。

定義:

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

戻り値:

このリスト内の要素数

isEmpty

boolean isEmpty()

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

定義:

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

戻り値:

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

contains

boolean contains(Object o)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

NullPointerException - 指定された要素が null で、このリストが null 要素を許可しない場合 (任意)

iterator

Iterator<E> iterator()

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

定義:

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

定義:

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

戻り値:

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

toArray

Object[] toArray()

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

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

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

定義:

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

戻り値:

このリスト内のすべての要素を適切な順序で含んでいる配列

関連項目:

Arrays.asList(Object[])

toArray

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

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

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

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

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

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

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

定義:

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

パラメータ:

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

戻り値:

このリストの要素が含まれている配列

例外:

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

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

add

boolean add(E e)

指定された要素をこのリストの最後に追加します (オプションの操作)。

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

UnsupportedOperationException - add オペレーションがこのリストでサポートされない場合

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

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

IllegalArgumentException - この要素のあるプロパティーが原因で、このリストにその要素を追加できない場合

remove

boolean remove(Object o)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

NullPointerException - 指定された要素が null で、このリストが null 要素を許可しない場合 (任意)

UnsupportedOperationException - remove オペレーションがこのリストでサポートされない場合

containsAll

boolean containsAll(Collection<?> c)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

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

関連項目:

contains(Object)

addAll

boolean addAll(Collection<? extends E> c)

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

定義:

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

パラメータ:

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)

このリストから、指定されたコレクションに含まれる要素をすべて削除します (オプションの操作)。

定義:

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

パラメータ:

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

戻り値:

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

例外:

UnsupportedOperationException - removeAll オペレーションがこのリストでサポートされない場合

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

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

関連項目:

remove(Object), contains(Object)

retainAll

boolean retainAll(Collection<?> c)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

UnsupportedOperationException - retainAll オペレーションがこのリストでサポートされない場合

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

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

関連項目:

remove(Object), contains(Object)

clear

void clear()

すべての要素をこのリストから削除します (オプションの操作)。この呼び出しが戻ると、このリストは空になります。

定義:

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

例外:

UnsupportedOperationException - clear オペレーションがこのリストでサポートされない場合

equals

boolean equals(Object o)

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

定義:

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

オーバーライド:

equals、クラス: Object

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

hashCode

int hashCode()

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

  int hashCode = 1;
  for (E e : list)
      hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
 

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

定義:

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

オーバーライド:

hashCode、クラス: Object

戻り値:

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

関連項目:

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)