JavaTM 2 Platform
Std. Ed. v1.3

java.util
クラス AbstractList

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
すべての実装インタフェース:
Collection, List
直系の既知のサブクラス:
AbstractSequentialList, ArrayList, Vector

public abstract class AbstractList
extends AbstractCollection
implements List

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

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

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

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

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

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

導入されたバージョン:
1.2
関連項目:
Collection, List, AbstractSequentialList, AbstractCollection

フィールドの概要
protected  int modCount
          このリストの「構造が変更された」回数です。
 
コンストラクタの概要
protected AbstractList()
          唯一のコンストラクタです。
 
メソッドの概要
 void add(int index, Object element)
          リスト内の指定された位置に、指定された要素を挿入します (任意のオペレーション)。
 boolean add(Object o)
          指定された要素をリストの末尾に追加します (任意のオペレーション)。
 boolean addAll(int index, Collection c)
          指定されたコレクションのすべての要素を、このリストの指定された位置に挿入します (任意のオペレーション)。
 void clear()
          このコレクションからすべての要素を削除します (任意のオペレーション)。
 boolean equals(Object o)
          指定されたオブジェクトとリストが等しいかどうかを比較します。
abstract  Object get(int index)
          リスト内の指定された位置にある要素を返します。
 int hashCode()
          このリストのハッシュコード値を返します。
 int indexOf(Object o)
          指定された要素がリスト内で最初に検出された位置のインデックスを返します。
 Iterator iterator()
          このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
 int lastIndexOf(Object o)
          指定された要素がリスト内で最後に検出された位置のインデックスを返します。
 ListIterator listIterator()
          このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
 ListIterator listIterator(int index)
          リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子を返します。
 Object remove(int index)
          リスト内の指定された位置にある要素を削除します (任意のオペレーション)。
protected  void removeRange(int fromIndex, int toIndex)
          このリストから、fromIndex で始まり、toIndex の直前で終わるインデックスを持つすべての要素を削除します。
 Object set(int index, Object element)
          リスト内の指定された位置にある要素を、指定された要素に置き換えます (任意のオペレーション)。
 List 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 メソッドによって返される反復子およびリスト反復子の実装によって使用されます。このフィールドの値が予期しない形で変化した場合、反復子やリスト反復子は nextremovepreviousset、または add のオペレーションに応じて ConcurrentModificationException をスローします。これは、繰り返し処理中の同時変更を前にして、未確定動作ではなくフェイルファスト動作を提供します。

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

コンストラクタの詳細

AbstractList

protected AbstractList()
唯一のコンストラクタです。サブクラスのコンストラクタによる呼び出しは、通常は暗黙的な呼び出しです。
メソッドの詳細

add

public boolean add(Object o)
指定された要素をリストの末尾に追加します (任意のオペレーション)。

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

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

定義:
インタフェース List 内の add
オーバーライド:
クラス AbstractCollection 内の add
パラメータ:
o - リストに追加される要素
戻り値:
true (Collection.add の一般規約に従う)
例外:
UnsupportedOperationException - セットが add メソッドをサポートしていない場合
ClassCastException - 指定された要素のクラスが原因で、セットに要素を追加できない場合
IllegalArgumentException - この要素の特性が原因で、このコレクションに要素を追加できなかった場合

get

public abstract Object get(int index)
リスト内の指定された位置にある要素を返します。
定義:
インタフェース List 内の get
パラメータ:
index - 返される要素のインデックス
戻り値:
リスト内の指定された位置にある要素
例外:
IndexOutOfBoundsException - 指定されたインデックスが範囲外の場合 (index < 0 || index >= size())

set

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

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

定義:
インタフェース List 内の set
パラメータ:
index - 置換される要素のインデックス
element - 指定された位置に格納される要素
戻り値:
指定された位置に以前あった要素
例外:
UnsupportedOperationException - リストが set メソッドをサポートしていない場合
ClassCastException - 指定された要素のクラスが原因で、リストに要素を追加できない場合
IllegalArgumentException - この要素の特性が原因で、リストに要素を追加できなかった場合
IndexOutOfBoundsException - 指定されたインデックスが範囲外の場合 (index < 0 || index >= size())

add

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

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

定義:
インタフェース List 内の add
パラメータ:
index - 指定の要素が挿入されるインデックス
element - 挿入される要素
例外:
UnsupportedOperationException - リストが add メソッドをサポートしていない場合
ClassCastException - 指定された要素のクラスが原因で、リストに要素を追加できない場合
IllegalArgumentException - この要素の特性が原因で、リストに要素を追加できなかった場合
IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())

remove

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

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

定義:
インタフェース List 内の remove
パラメータ:
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() を使って、最初にリスト反復子を取得します。次に、指定された要素が見つかるか、あるいはリストの末尾に達するまで、リストの内容を次々調べます。

定義:
インタフェース List 内の indexOf
パラメータ:
o - 検索する要素
戻り値:
リスト内で指定された要素が最初に検出された位置のインデックス。リストにこの要素がない場合は -1

lastIndexOf

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

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

定義:
インタフェース List 内の lastIndexOf
パラメータ:
o - 検索する要素
戻り値:
リスト内で指定された要素が最後に検出された位置のインデックス。リストにこの要素がない場合は -1

clear

public void clear()
このコレクションからすべての要素を削除します (任意のオペレーション)。この呼び出しが戻ったあとは、例外がスローされない限り、コレクションは空になります。

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

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

定義:
インタフェース List 内の clear
オーバーライド:
クラス AbstractCollection 内の clear
例外:
UnsupportedOperationException - このコレクションが clear メソッドをサポートしていない場合

addAll

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

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

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

定義:
インタフェース List 内の addAll
パラメータ:
index - 指定されたコレクションから最初の要素を挿入する位置のインデックス
c - リストに挿入される要素
戻り値:
この呼び出しの結果、このリストが変更された場合は true
例外:
UnsupportedOperationException - リストが addAll メソッドをサポートしていない場合
ClassCastException - 指定されたコレクションの要素のクラスが原因で、このリストに追加できなかった場合
IllegalArgumentException - 指定されたコレクションにある要素の特性が原因で、リストに追加できなかった場合
IndexOutOfBoundsException - インデックスが範囲外の場合 (index < 0 || index > size())

iterator

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

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

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

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

定義:
インタフェース List 内の iterator
オーバーライド:
クラス AbstractCollection 内の iterator
戻り値:
リスト内の要素を適切な順序で繰り返し処理する反復子
関連項目:
modCount

listIterator

public ListIterator listIterator()
このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。この実装は listIterator(0) を返します。
定義:
インタフェース List 内の listIterator
戻り値:
このリスト内の要素を適切な順序で繰り返し処理する反復子
関連項目:
listIterator(int)

listIterator

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

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

この実装で返されるリスト反復子は、その removeset、および add の各メソッド呼び出しに対して UnsupportedOperationException をスローすることに注意してください。リストの remove(int)set(int, Object)、および add(int, Object) の各メソッドをそれぞれオーバーライドしない限り、この例外がスローされます。

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

定義:
インタフェース List 内の listIterator
パラメータ:
index - next メソッドの呼び出しによってリスト反復子から返される最初の要素のインデックス
戻り値:
リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子
例外:
IndexOutOfBoundsException - 指定されたインデックスが範囲外の場合 (index < 0 || index > size())
関連項目:
modCount

subList

public List subList(int fromIndex,
                    int toIndex)
このリストの、fromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のビューを返します。fromIndextoIndex が等しい場合は、空のリストが返されます。返されるリストはこのリストに対応しています。そのため、返されるリスト内での変更はこのリストに反映され、このリスト内での変更は返されるリストに反映されます。返されるリストは、このリストによってサポートされている、任意のリスト操作をすべてサポートします。

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

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

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

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

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

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

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

定義:
インタフェース List 内の subList
パラメータ:
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 を返します。

定義:
インタフェース List 内の equals
オーバーライド:
クラス Object 内の equals
パラメータ:
o - リストと等しいかどうかを比較するオブジェクト
戻り値:
指定されたオブジェクトがリストと等しい場合は true

hashCode

public int hashCode()
このリストのハッシュコード値を返します。

この実装では、List.hashCode メソッドのドキュメントでリストハッシュ関数を定義するのに使われているコードをそのまま使っています。

定義:
インタフェース List 内の hashCode
オーバーライド:
クラス Object 内の hashCode
戻り値:
リストのハッシュコード値

removeRange

protected void removeRange(int fromIndex,
                           int toIndex)
このリストから、fromIndex で始まり、toIndex の直前で終わるインデックスを持つすべての要素を削除します。後続の要素は左に移動します (インデックス値が減少)。この呼び出しは、ArrayList を (toIndex - fromIndex) の要素数だけ短縮します。toIndex==fromIndex の場合、このオペレーションには何も影響はありません。

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

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

パラメータ:
fromIndex - 削除する最初の要素のインデックス
toIndex - 削除する最後の要素の直後のインデックス

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.