|
CDC 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface List
順序付けられたコレクションです。「シーケンス」とも呼ばれます。このインタフェースのユーザーは、リスト内のどこに各要素が挿入されるかを精密に制御できます。ユーザーは整数値のインデックス (リスト内の位置) によって要素にアクセスしたり、リスト内の要素を検索したりすることができます。
セットとは異なり、通常、リストは重複する要素を許可します。つまり、リストは、通常 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 のメンバーです。
Collection
,
Set
,
ArrayList
,
LinkedList
,
Vector
,
Arrays.asList(Object[])
,
Collections.nCopies(int, Object)
,
Collections.EMPTY_LIST
,
AbstractList
,
AbstractSequentialList
メソッドの概要 | |
---|---|
void |
add(int index,
Object element)
リスト内の指定された位置に、指定された要素を挿入します (任意のオペレーション)。 |
boolean |
add(Object o)
指定された要素をリストの最後に追加します (任意のオペレーション)。 |
boolean |
addAll(Collection c)
指定されたコレクション内のすべての要素を、指定されたコレクションの反復子によって返される順序でリストの最後に追加します (任意のオペレーション)。 |
boolean |
addAll(int index,
Collection c)
指定されたコレクション内のすべての要素を、リストの指定された位置に挿入します (任意のオペレーション)。 |
void |
clear()
すべての要素をリストから削除します (任意のオペレーション)。 |
boolean |
contains(Object o)
リストに指定の要素がある場合に true を返します。 |
boolean |
containsAll(Collection c)
指定されたコレクションのすべての要素がリストに含まれている場合に true を返します。 |
boolean |
equals(Object o)
指定されたオブジェクトがリストと等しいかどうかを比較します。 |
Object |
get(int index)
リスト内の指定された位置にある要素を返します。 |
int |
hashCode()
このリストのハッシュコード値を返します。 |
int |
indexOf(Object o)
指定された要素がこのリスト内で最初に検出された位置のインデックスか、リストにこの要素がない場合は -1 を返します。 |
boolean |
isEmpty()
リストに要素がない場合に true を返します。 |
Iterator |
iterator()
このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。 |
int |
lastIndexOf(Object o)
指定された要素がこのリスト内で最後に検出された位置のインデックスか、リストにこの要素がない場合は -1 を返します。 |
ListIterator |
listIterator()
リスト内の要素を適切な順序で繰り返し処理する反復子を返します。 |
ListIterator |
listIterator(int index)
リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子を返します。 |
Object |
remove(int index)
リスト内の指定された位置にある要素を削除します (任意のオペレーション)。 |
boolean |
remove(Object o)
指定された要素のうち、このリスト内で最初に出現したものを削除します (任意のオペレーション)。 |
boolean |
removeAll(Collection c)
指定されたコレクションに格納されているすべての要素をリストから削除します (任意のオペレーション)。 |
boolean |
retainAll(Collection c)
指定されたコレクションに格納されている要素だけがリスト内に含まれるようにします (任意のオペレーション)。 |
Object |
set(int index,
Object element)
リスト内の指定された位置にある要素を、指定された要素に置き換えます (任意のオペレーション)。 |
int |
size()
リスト内にある要素の数を返します。 |
List |
subList(int fromIndex,
int toIndex)
このリストの、fromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のビューを返します。 |
Object[] |
toArray()
このリスト内のすべて要素を適切な順序で格納している配列を返します。 |
Object[] |
toArray(Object[] a)
このリスト内のすべての要素を適切な順序で含む配列を返します。 |
メソッドの詳細 |
---|
int size()
Collection
内の size
boolean isEmpty()
Collection
内の isEmpty
boolean contains(Object o)
Collection
内の contains
o
- リストにあるかどうかを調べる要素
ClassCastException
- 指定された要素の型が、このリストと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合 (省略可能)Iterator iterator()
Collection
内の iterator
Object[] toArray()
Collection
内の toArray
Arrays.asList(Object[])
Object[] toArray(Object[] a)
Collection
内の toArray
a
- このリストの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる
ArrayStoreException
- 指定された配列の実行時の型が、このリスト内の各要素の実行時の型のスーパータイプでない場合
NullPointerException
- 指定された配列が null である場合boolean add(Object o)
このオペレーションをサポートするリストは、リストに追加できる要素に制限を加える場合があります。特に、リストには null 要素の追加を拒否するものもあれば、追加される要素の型について制限を加えるものもあります。List クラスは、List に追加できる要素について制約があれば、ドキュメントでそれを明確に指定する必要があります。
Collection
内の add
o
- リストに追加される要素
UnsupportedOperationException
- このリストが add メソッドをサポートしていない場合
ClassCastException
- 指定された要素のクラスのために、このリストに要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合
IllegalArgumentException
- この要素のある側面が原因で、このリストにこの要素を追加できない場合boolean remove(Object o)
Collection
内の remove
o
- リストから削除される要素 (その要素がある場合)
ClassCastException
- 指定された要素の型が、このリストと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合 (省略可能)
UnsupportedOperationException
- このリストが remove メソッドをサポートしていない場合boolean containsAll(Collection c)
Collection
内の containsAll
c
- このリストにあるかどうかを調べるコレクション
ClassCastException
- 指定されたコレクションの 1 つ以上の要素の型が、このリストと互換性がない場合 (省略可能)
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれていて、このリストが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合contains(Object)
boolean addAll(Collection c)
Collection
内の addAll
c
- 要素がリストに追加されるコレクション
UnsupportedOperationException
- このリストが addAll メソッドをサポートしていない場合
ClassCastException
- 指定されたコレクション内の要素のクラスが原因で、このリストに要素を追加できない場合
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このリストが null 要素をサポートしない場合 (省略可能)。または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクション内の要素の特性が原因で、このリストに要素を追加できない場合add(Object)
boolean addAll(int index, Collection c)
index
- 指定されたコレクションから最初の要素を挿入する位置のインデックスc
- リストに挿入される要素
UnsupportedOperationException
- このリストが addAll メソッドをサポートしていない場合
ClassCastException
- 指定されたコレクションのどれかの要素のクラスが原因で、このリストに要素を追加できない場合
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このリストが null 要素をサポートしない場合 (省略可能)。または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクションのどれかの要素の特性が原因で、このリストに要素を追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())boolean removeAll(Collection c)
Collection
内の removeAll
c
- どの要素がこのリストから削除されるかを定義するコレクション
UnsupportedOperationException
- このリストが removeAll メソッドをサポートしていない場合
ClassCastException
- このリストの 1 つ以上の要素の型が、指定されたコレクションと互換性がない場合 (省略可能)
NullPointerException
- このリストに 1 つ以上の null 要素が含まれていて、指定されたコレクションが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
,
contains(Object)
boolean retainAll(Collection c)
Collection
内の retainAll
c
- セットが保持する要素を定義するコレクション
UnsupportedOperationException
- このリストが retainAll メソッドをサポートしていない場合
ClassCastException
- このリストの 1 つ以上の要素の型が、指定されたコレクションと互換性がない場合 (省略可能)
NullPointerException
- このリストに 1 つ以上の null 要素が含まれていて、指定されたコレクションが null 要素をサポートしない場合 (省略可能)
NullPointerException
- 指定されたコレクションが null である場合remove(Object)
,
contains(Object)
void clear()
Collection
内の clear
UnsupportedOperationException
- このリストが clear メソッドをサポートしていない場合boolean equals(Object o)
Collection
内の equals
Object
内の equals
o
- リストと等しいかどうかを比較するオブジェクト
Object.hashCode()
,
Hashtable
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
内の hashCode
Object
内の hashCode
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
Object get(int index)
index
- 返される要素のインデックス
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index >= size())Object set(int index, Object element)
index
- 置換される要素のインデックスelement
- 指定された位置に格納される要素
UnsupportedOperationException
- このリストが set メソッドをサポートしていない場合
ClassCastException
- 指定された要素のクラスのために、このリストに要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合
IllegalArgumentException
- この要素の一部の特性のために、このリストに要素を追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index >= size())void add(int index, Object element)
index
- 指定の要素が挿入されるインデックスelement
- 挿入される要素
UnsupportedOperationException
- このリストが add メソッドをサポートしていない場合
ClassCastException
- 指定された要素のクラスのために、このリストに要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合
IllegalArgumentException
- この要素の一部の特性のために、このリストに要素を追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())Object remove(int index)
index
- 削除される要素のインデックス
UnsupportedOperationException
- このリストが remove メソッドをサポートしていない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index >= size())int indexOf(Object o)
o
- 検索する要素
ClassCastException
- 指定された要素の型が、このリストと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合 (省略可能)int lastIndexOf(Object o)
o
- 検索する要素
ClassCastException
- 指定された要素の型が、このリストと互換性がない場合 (省略可能)
NullPointerException
- 指定された要素が null で、このリストが null 要素をサポートしない場合 (省略可能)ListIterator listIterator()
ListIterator listIterator(int index)
index
- next メソッドの呼び出しによってリスト反復子から返される最初の要素のインデックス
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())List subList(int fromIndex, int toIndex)
このメソッドは、配列に一般的に見られるような、明示的な範囲操作のための要求を不要にします。リストを必要とする操作はどれも、リスト全体ではなく、subList ビュー上で操作することで、範囲操作として使用できます。たとえば、次の慣用法は、指定された範囲の要素をリストから削除します。
list.subList(from, to).clear();indexOf および lastIndexOf でも、同様の慣用法を作成できます。Collections クラスのアルゴリズムがすべて subList に適用できます。
バッキングリスト (すなわち、このリスト) の構造が、返されたリストを経由せずに変更された場合、このメソッドで返されたリストのセマンティクスは保証されません。構造の変更とは、リストのサイズが変わるような変更や、進行中の繰り返し処理が不正な結果に終わるような変更のことです。
fromIndex
- subList の下端点 (これを含む)toIndex
- subList の上端点 (これを含まない)
IndexOutOfBoundsException
- 端点のインデックス値が不正な場合 (fromIndex < 0 || toIndex > size || fromIndex > toIndex)
|
CDC 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |