java.util

クラス AbstractList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

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

Iterable<E>, Collection<E>, List<E>

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

AbstractSequentialList, ArrayList, Vector

public abstract class AbstractList<E>
extends AbstractCollection<E>
implements List<E>

このクラスは、List インタフェースのスケルトン実装を提供し、配列のような「ランダムアクセス」データストアに連動するこのインタフェースを実装するのに必要な作業量を最小限に抑えます。リンクリストのような順次アクセスデータ記憶域の場合は、このクラスではなく AbstractSequentialList を使用してください。

変更不可能なリストを実装するには、このクラスを拡張して、get(int) メソッドおよび size() メソッドの実装を提供します。

変更可能なリストを実装するには、上記に加えて、set(int, E) メソッドをオーバーライドします。このメソッドをオーバーライドしなかった場合は、UnsupportedOperationException がスローされます。リストが可変長である場合は、add(int, E) メソッドおよび remove(int) メソッドもオーバーライドする必要があります。

Collection インタフェースの仕様で推奨されているように、通常は、引数なしの void コンストラクタ、および引数にコレクションをとるコンストラクタを提供してください。

ほかのコレクションの抽象実装とは異なり、イテレータの実装を提供する必要はありません。イテレータおよびリストイテレータはこのクラスで実装され、ランダムアクセス用のメソッドである get(int)、set(int, E)、add(int, E)、および remove(int) の上位に位置付けられます。

実装の詳細については、このクラスの abstract メソッド以外の各メソッドのドキュメントを参照してください。より効率的な実装ができるコレクションの場合は、これらのメソッドをオーバーライドしてもかまいません。

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

導入されたバージョン:

1.2

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected int	modCount このリストの構造が変更された回数です。

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

コンストラクタ

修飾子	コンストラクタと説明
protected	AbstractList() 唯一のコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	add(E e) 指定された要素をリストの最後に追加します (オプションの操作)。
void	add(int index, E element) リスト内の指定された位置に、指定された要素を挿入します (オプションの操作)。
boolean	addAll(int index, Collection<? extends E> c) 指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します (オプションの操作)。
void	clear() すべての要素をリストから削除します (オプションの操作)。
boolean	equals(Object o) 指定されたオブジェクトがリストと等しいかどうかを比較します。
abstract E	get(int index) リスト内の指定された位置にある要素を返します。
int	hashCode() このリストのハッシュコード値を返します。
int	indexOf(Object o) 指定された要素がリスト内で最初に検出された位置のインデックスを返します。指定された要素がリストにない場合は -1 を返します。
Iterator<E>	iterator() このリスト内の要素を適切な順序で繰り返し処理するイテレータを返します。
int	lastIndexOf(Object o) 指定された要素がリスト内で最後に検出された位置のインデックスを返します。指定された要素がリストにない場合は -1 を返します。
ListIterator<E>	listIterator() このリスト内の要素を適切な順序で繰り返し処理するリストイテレータを返します。
ListIterator<E>	listIterator(int index) リスト内の指定された位置で始まる、リスト内の要素を適切な順序で反復するリストイテレータを返します。
E	remove(int index) リスト内の指定された位置にある要素を削除します (オプションの操作)。
protected void	removeRange(int fromIndex, int toIndex) fromIndex (これを含む) から toIndex (これを含まない) の範囲のインデックスを持つすべての要素をこのリストから削除します。
E	set(int index, E element) リスト内の指定された位置にある要素を、指定された要素に置き換えます (オプションの操作)。
List<E>	subList(int fromIndex, int toIndex) このリストの、指定された fromIndex (これを含む) から toIndex (これを含まない) までの部分のビューを返します。

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

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString

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

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

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

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

フィールドの詳細

modCount

protected transient int modCount

このリストの構造が変更された回数です。構造の変更とは、リストのサイズの変更や、その他の進行中の繰り返し処理が不正な結果をもたらすような変更のことです。

このフィールドは、iterator メソッドおよび listIterator メソッドによって返されるイテレータおよびリストイテレータの実装によって使用されます。このフィールドの値が予期しない形で変化した場合、イテレータやリストイテレータは next、remove、previous、set、または add のオペレーションに応じて ConcurrentModificationException をスローします。これは、繰り返し処理中の並行変更を前にして、未確定動作ではなくフェイルファスト動作を提供します。

このフィールドをサブクラスで使用するのはオプションです。サブクラスでフェイルファストイテレータおよびリストイテレータを提供する必要がある場合には、単純に、サブクラスの add(int, E) メソッドおよび remove(int) メソッド (および、サブクラスがオーバーライドするメソッドのうちで、リストの構造的な変更をするメソッド) の内部で、このフィールドをインクリメントします。add(int, E) または remove(int) に対する 1 回の呼び出しでは、フィールドに 1 だけ加える必要があります。そうしないと、イテレータ (およびリストイテレータ) が誤って ConcurrentModificationExceptions をスローすることになります。実装でフェイルファストイテレータを提供しない場合は、このフィールドを無視してもかまいません。

コンストラクタの詳細

AbstractList

protected AbstractList()

唯一のコンストラクタです。サブクラスのコンストラクタによる呼び出し用で、通常は暗黙的に呼び出されます。

メソッドの詳細

add

public boolean add(E e)

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

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

この実装では add(size(), e) を呼び出します。

この実装は、add(int, E) がオーバーライドされないかぎり UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

add、クラス: AbstractCollection<E>

パラメータ:

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

戻り値:

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

例外:

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

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

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

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

get

public abstract E get(int index)

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

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

set

public E set(int index,
    E element)

リスト内の指定された位置にある要素を、指定された要素に置き換えます (オプションの操作)。

この実装は、常に UnsupportedOperationException をスローします。

定義:

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

パラメータ:

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

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

戻り値:

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

例外:

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

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

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

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

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

add

public void add(int index,
       E element)

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

この実装は、常に UnsupportedOperationException をスローします。

定義:

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

パラメータ:

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

element - 挿入される要素

例外:

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

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

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

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

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

remove

public E remove(int index)

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

この実装は、常に UnsupportedOperationException をスローします。

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

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

indexOf

public int indexOf(Object o)

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

この実装は、listIterator() を使って、最初にリストイテレータを取得します。次に、指定された要素が見つかるか、あるいはリストの末尾に達するまで、リストの内容を次々に調べます。

定義:

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

パラメータ:

o - 検索する要素

戻り値:

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

例外:

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

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

lastIndexOf

public int lastIndexOf(Object o)

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

この実装は、listIterator(size()) を使って、最初にリストの末尾を指すリストイテレータを取得します。次に、指定された要素が見つかるか、あるいはリストの先頭に達するまで、リスト内容を逆方向に次々調べます。

定義:

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

パラメータ:

o - 検索する要素

戻り値:

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

例外:

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

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

clear

public void clear()

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

この実装では removeRange(0, size()) を呼び出します。

この実装は、remove(int index) または removeRange(int fromIndex, int toIndex) がオーバーライドされないかぎり UnsupportedOperationException をスローします。

定義:

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

定義:

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

オーバーライド:

clear、クラス: AbstractCollection<E>

例外:

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

addAll

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

指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します (オプションの操作)。その位置とそれ以降に要素がある場合は、それらを右に移動して、各要素のインデックスに 1 を加えます。新しい要素は、指定されたコレクションのイテレータによって返される順序でリストに挿入されます。オペレーションの進行中に、指定されたコレクションが変更された場合の、このオペレーションの動作は定義されていません。つまり、指定されたコレクションがこのリストで、しかも空ではない場合に起こります。

この実装は、指定されたコレクションのイテレータを取得し、イテレータから取得した要素をこのリストの適切な位置に 1 つずつ挿入する操作を繰り返します。挿入には add(int, E) メソッドを使用します。多くの場合、実装では、このメソッドをオーバーライドしたほうが効率的です。

この実装は、add(int, E) がオーバーライドされないかぎり UnsupportedOperationException をスローします。

定義:

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

パラメータ:

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

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

戻り値:

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

例外:

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

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

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

IllegalArgumentException - 指定されたコレクションの要素のあるプロパティーが原因で、このリストにその要素を追加できない場合

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

iterator

public Iterator<E> iterator()

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

この実装は、イテレータインタフェースの簡単な実装を返します。この処理では、基になるリストの size()、get(int)、および remove(int) といった各メソッドを利用します。

このメソッドで返されるイテレータは、リストの remove(int) メソッドがオーバーライドされないかぎり、remove メソッドを呼び出すと UnsupportedOperationException をスローします。

この実装は、(protected) modCount フィールドの仕様で説明されているように、同時変更を前にして実行時の例外をスローすることもあります。

定義:

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

定義:

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

定義:

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

定義:

iterator、クラス: AbstractCollection<E>

戻り値:

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

listIterator

public ListIterator<E> listIterator()

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

この実装では listIterator(0) が返されます。

定義:

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

戻り値:

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

関連項目:

listIterator(int)

listIterator

public ListIterator<E> listIterator(int index)

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

この実装は、ListIterator インタフェースの簡単な実装を返します。ListIterator インタフェースは、iterator() メソッドによって返される Iterator インタフェースの実装を拡張するものです。ListIterator の実装は、基になるリストの get(int)、set(int, E)、add(int, E)、および remove(int) の各メソッドに依存します。

この実装で返されるリストイテレータは、リストの remove(int)、set(int, E)、および add(int, E) メソッドがオーバーライドされないかぎり、remove、set、および add メソッドに応答して UnsupportedOperationException をスローします。

この実装は、(protected) modCount フィールドの仕様で説明されているように、同時変更を前にして実行時の例外をスローすることもあります。

定義:

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

パラメータ:

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

戻り値:

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

例外:

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

subList

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

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

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

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

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

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

この実装は、AbstractList をサブクラス化するリストを返します。このサブクラスは、専用フィールドに、バッキングリスト内の subList のオフセット、subList のサイズ (存続期間中に変更することも可能)、およびバッキングリストの要求される modCount 値を格納します。サブクラスにはバリアントが 2 つあり、そのうちの 1 つには RandomAccess が実装されています。リストが RandomAccess を実装すると、返されたリストは RandomAccess を実装するサブクラスのインスタンスになります。

サブクラスの set(int, E)、get(int)、add(int, E)、remove(int)、addAll(int, Collection)、および removeRange(int, int) の各メソッドは、インデックスの境界を調べ、オフセットに合わせて調整したあとで、バッキング抽象リストの対応するメソッドにすべて委譲します。addAll(Collection c) メソッドは、単に addAll(size, c) を返すだけです。

listIterator(int) メソッドは、バッキングリストのリストイテレータへの「ラッパーオブジェクト」を返します。この「ラッパーオブジェクト」は、バッキングリストの対応するメソッドで作成されます。iterator メソッドは listIterator() を返すだけであり、同様に、size メソッドはサブクラスの size フィールドを返すだけです。

すべてのメソッドは、最初に、バッキングリストの実際の modCount がその要求された値に等しいかを調べ、そうでない場合は ConcurrentModificationException をスローします。

定義:

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

パラメータ:

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

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

戻り値:

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

例外:

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

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

equals

public boolean equals(Object o)

指定されたオブジェクトがリストと等しいかどうかを比較します。指定されたオブジェクトもリストであり、サイズが同じで、2 つのリストの対応する要素がすべて等しい場合にだけ true を返します。(e1==null ? e2==null : e1.equals(e2)) の場合、2 つの要素 e1 と e2 は等しくなります。つまり 2 つのリストは、同じ要素が同じ順序で含まれている場合に等しいものとして定義されます。

この実装は、最初に、指定されたオブジェクトがこのリストであるかどうかを調べます。このリストである場合、実装は true を返します。そうでない場合は、指定されたオブジェクトがリストかどうかを調べます。リストでなければ false を返します。指定されたオブジェクトがリストの場合は、両方のリストの内容を次々調べて、要素の対応するペアを比較します。比較の結果 false が返されることがあれば、このメソッドも false を返します。どちらかのリストのイテレータの要素が先になくなった場合は、2 つのリストの長さが等しくないので false を返します。そうでない場合は、繰り返しが完了した時点で true を返します。

定義:

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)

removeRange

protected void removeRange(int fromIndex,
               int toIndex)

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

このメソッドは、このリストおよびそのサブリストで clear オペレーションによって呼び出されます。このメソッドをオーバーライドしてリストの実装の特性を最大限に利用するようにすると、このリストおよびそのサブリストに対する clear オペレーションの性能がかなり向上します。

この実装は、fromIndex の前に位置するリストイテレータを取得し、範囲全体が削除されるまで ListIterator.next と ListIterator.remove をこの順序で繰り返し呼び出します。注: ListIterator.remove が 1 次時間を必要とする場合、この実装では 2 次時間が必要です。

パラメータ:

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

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