|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface List<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 のメンバーです。
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)
指定された要素がリスト内で最初に検出された位置のインデックスを返します。 |
|
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()
リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。 |
|
|
toArray(T[] a)
リスト内のすべての要素を適切な順序で (最初の要素から最後の要素へ) 格納している配列を返します。 |
メソッドの詳細 |
---|
int size()
Collection<E>
内の size
boolean isEmpty()
Collection<E>
内の isEmpty
boolean contains(Object o)
Collection<E>
内の contains
o
- リストにあるかどうかを調べる要素
ClassCastException
- 指定された要素の型が、このリストと互換でない場合 (省略可能)
NullPointerException
- 指定された要素が null であり、このリストが null 要素を許可しない場合 (省略可能)Iterator<E> iterator()
Collection<E>
内の iterator
Iterable<E>
内の iterator
Object[] toArray()
返される配列への参照をこのリストが維持しないという点で、この配列は安全です。つまり、このメソッドは、リストが配列に連動している場合でも新しい配列を割り当てます。このため、呼び出し側は、返された配列を自由に変更できます。
メソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。
Collection<E>
内の toArray
Arrays.asList(Object[])
<T> T[] toArray(T[] a)
指定された配列にリストが収まり、その配列にさらに余分な領域がある場合、つまり配列にリストより多くの要素がある場合、配列でリストの末尾に続く要素は null に設定されます。(これは、呼び出し側がリストに null 要素が含まれていないことがわかっている場合には、リストの長さを判定するのに利用できる。)
toArray()
メソッドと同じように、このメソッドは、配列ベースの API とコレクションベースの API の間の橋渡し役として機能します。さらに、このメソッドでは、出力配列の実行時の型を正確に制御できるため、環境によっては割り当ての手間を抑えることができます。
x が、文字列だけからなるリストであることがわかっていると仮定します。次のコードを使うと、新しく割り当てられた String の配列にリストをダンプできます。
String[] y = x.toArray(new String[0]);toArray(new Object[0]) は、機能の点で toArray() と同一です。
Collection<E>
内の toArray
a
- このリストの要素の格納先となる配列 (ただし十分に大きい場合)。それ以外の場合、この目的のために同じ実行時の型の新しい配列が割り当てられる
ArrayStoreException
- 指定された配列の実行時の型が、リスト内の各要素の実行時の型のスーパータイプでない場合
NullPointerException
- 指定された配列が null である場合boolean add(E e)
このオペレーションをサポートするリストは、リストに追加できる要素に制限を加える場合があります。特に、リストには null 要素の追加を拒否するものもあれば、追加される要素の型について制限を加えるものもあります。List クラスは、List に追加できる要素について制約があれば、ドキュメントでそれを明確に指定する必要があります。
Collection<E>
内の add
e
- リストに追加される要素
Collection.add(E)
で指定されているとおり)
UnsupportedOperationException
- add オペレーションがこのリストでサポートされない場合
ClassCastException
- 指定された要素のクラスが原因で、このリストにその要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素を許容しない場合
IllegalArgumentException
- この要素のプロパティーが原因で、このリストに追加できない場合boolean remove(Object o)
Collection<E>
内の remove
o
- リストから削除される要素 (その要素が存在する場合)
ClassCastException
- 指定された要素の型が、このリストと互換でない場合 (省略可能)
NullPointerException
- 指定された要素が null であり、このリストが null 要素を許可しない場合 (省略可能)
UnsupportedOperationException
- remove オペレーションがこのリストでサポートされない場合boolean containsAll(Collection<?> c)
Collection<E>
内の containsAll
c
- このリストにあるかどうかを調べるコレクション
ClassCastException
- 指定されたコレクションの 1 つ以上の要素の型が、このリストと互換でない場合 (省略可能)
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このリストが null 要素を許可しない場合 (省略可能)、または指定されたコレクションが null の場合contains(Object)
boolean addAll(Collection<? extends E> c)
Collection<E>
内の addAll
c
- このリストに追加される要素を含むコレクション
UnsupportedOperationException
- addAll オペレーションがこのリストでサポートされない場合
ClassCastException
- 指定されたコレクションのある要素のクラスが原因で、このリストにそのコレクションを追加できない場合
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このリストが null 要素を許可しない場合、または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクションのある要素のある特性が原因で、このリストにそのコレクションを追加できない場合add(Object)
boolean addAll(int index, Collection<? extends E> c)
index
- 指定されたコレクションの最初の要素を挿入する位置のインデックスc
- 要素がリストに追加されるコレクション
UnsupportedOperationException
- addAll オペレーションがこのリストでサポートされない場合
ClassCastException
- 指定されたコレクションのある要素のクラスが原因で、このリストにそのコレクションを追加できない場合
NullPointerException
- 指定されたコレクションに 1 つ以上の null 要素が含まれており、このリストが null 要素を許可しない場合、または指定されたコレクションが null の場合
IllegalArgumentException
- 指定されたコレクションのある要素のある特性が原因で、このリストにそのコレクションを追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())boolean removeAll(Collection<?> c)
Collection<E>
内の removeAll
c
- このリストから削除される要素を含むコレクション
UnsupportedOperationException
- removeAll オペレーションがこのリストでサポートされない場合
ClassCastException
- このリストのある要素のクラスが、指定されたコレクションと互換でない場合 (省略可能)
NullPointerException
- このリスト内に null 要素が含まれ、指定されたコレクションが null 要素を許可しない場合 (省略可能)。または指定されたコレクションが null の場合remove(Object)
,
contains(Object)
boolean retainAll(Collection<?> c)
Collection<E>
内の retainAll
c
- このリストで保持される要素を含むコレクション
UnsupportedOperationException
- retainAll オペレーションがこのリストでサポートされない場合
ClassCastException
- このリストのある要素のクラスが、指定されたコレクションと互換でない場合 (省略可能)
NullPointerException
- このリスト内に null 要素が含まれ、指定されたコレクションが null 要素を許可しない場合 (省略可能)。または指定されたコレクションが null の場合remove(Object)
,
contains(Object)
void clear()
Collection<E>
内の clear
UnsupportedOperationException
- clear オペレーションがこのリストでサポートされない場合boolean equals(Object o)
Collection<E>
内の equals
Object
内の equals
o
- リストと等しいかどうかを比較するオブジェクト
Object.hashCode()
,
Hashtable
int hashCode()
int hashCode = 1; Iterator<E> i = list.iterator(); while (i.hasNext()) { E 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.equals(Object)
,
equals(Object)
E get(int index)
index
- 返される要素のインデックス
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())E set(int index, E element)
index
- 置換される要素のインデックスelement
- 指定された位置に格納される要素
UnsupportedOperationException
- set オペレーションがこのリストでサポートされない場合
ClassCastException
- 指定された要素のクラスが原因で、このリストにその要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素を許容しない場合
IllegalArgumentException
- 指定された要素のあるプロパティーが原因で、このリストにその要素を追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())void add(int index, E element)
index
- 指定の要素が挿入される位置のインデックスelement
- 挿入される要素
UnsupportedOperationException
- add オペレーションがこのリストでサポートされない場合
ClassCastException
- 指定された要素のクラスが原因で、このリストにその要素を追加できない場合
NullPointerException
- 指定された要素が null で、このリストが null 要素を許容しない場合
IllegalArgumentException
- 指定された要素のあるプロパティーが原因で、このリストにその要素を追加できない場合
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())E 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<E> listIterator()
ListIterator<E> listIterator(int index)
next
の最初の呼び出しによって返される最初の要素を示します。previous
の最初の呼び出しは、指定されたインデックスから 1 を引いた値のインデックスを持つ要素を返します。
index
- リスト反復子から (next メソッド呼び出しによって) 返される最初の要素のインデックス
IndexOutOfBoundsException
- インデックスが範囲外の場合 (index < 0 || index > size())List<E> 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)
|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。