E
- このリスト内に存在する要素の型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のメンバーです。
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)
このリストから、指定されたコレクションに含まれる要素をすべて削除します(オプションの操作)。
|
default void |
replaceAll(UnaryOperator<E> operator)
このリストの各要素を、その要素に演算子を適用した結果で置換します。
|
boolean |
retainAll(Collection<?> c)
このリスト内で、指定されたコレクションに含まれている要素だけを保持します(オプションの操作)。
|
E |
set(int index, E element)
このリスト内の指定された位置にある要素を、指定された要素に置き換えます(オプションの操作)。
|
int |
size()
このリスト内にある要素の数を返します。
|
default void |
sort(Comparator<? super E> c)
指定された
Comparator を使用して要素を比較することにより、このリストをソートします。 |
default Spliterator<E> |
spliterator()
このリスト内の要素に対する
Spliterator を作成します。 |
List<E> |
subList(int fromIndex, int toIndex)
このリストの、指定されたfromIndex (これを含む)からtoIndex (これを含まない)までの部分のビューを返します。
|
Object[] |
toArray()
このリスト内のすべての要素を適切な順序で(最初の要素から最後の要素へ)含んでいる配列を返します。
|
<T> T[] |
toArray(T[] a)
このリスト内のすべての要素を適切な順序で(最初の要素から最後の要素へ)含んでいる配列を返します。返される配列の実行時の型は、指定された配列の型になります。
|
parallelStream, removeIf, stream
int size()
size
、インタフェース: Collection<E>
boolean isEmpty()
isEmpty
、インタフェース: Collection<E>
boolean contains(Object o)
contains
、インタフェース: Collection<E>
o
- このリスト内にあるかどうかが判定される要素ClassCastException
- 指定された要素の型が、このリストと互換でない場合(オプション)NullPointerException
- 指定された要素がnullで、このリストがnull要素を許可しない場合(オプション)Object[] toArray()
返される配列は、それへの参照がこのリストで保持されない場合に、安全になります。つまり、このメソッドは、このリストが配列に連動している場合でも、新しい配列を割り当てる必要があります。このため、呼出し側は、返された配列を自由に変更できます。
このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。
toArray
、インタフェース: Collection<E>
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()と同一です。toArray
、インタフェース: Collection<E>
T
- コレクションを含む配列の実行時の型a
- 配列が十分な大きさを持つ場合は、このリストの要素の格納先の配列。配列のサイズが十分でない場合は、同じ実行時の型で新しい配列が格納用として割り当てられる。ArrayStoreException
- 指定された配列の実行時の型が、このリスト内のすべての要素の実行時の型のスーパー・タイプではない場合NullPointerException
- 指定された配列がnullである場合boolean add(E e)
このオペレーションをサポートするリストは、リストに追加できる要素に制限を加える場合があります。たとえば、リストにはnull要素の追加を拒否するものもあれば、追加される要素の型について制限を加えるものもあります。Listクラスは、追加できる要素について制約があれば、ドキュメントでそれを明確に記述するようにしてください。
add
、インタフェース: Collection<E>
e
- このリストに追加される要素Collection.add(E)
で指定されているとおり)UnsupportedOperationException
- addオペレーションがこのリストでサポートされない場合ClassCastException
- 指定された要素のクラスが原因で、このリストにその要素を追加できない場合NullPointerException
- 指定された要素がnullで、このリストがnull要素を許可しない場合IllegalArgumentException
- この要素のあるプロパティが原因で、このリストにその要素を追加できない場合boolean remove(Object o)
remove
、インタフェース: Collection<E>
o
- このリストから削除される要素(その要素が存在する場合)ClassCastException
- 指定された要素の型が、このリストと互換でない場合(オプション)NullPointerException
- 指定された要素がnullで、このリストがnull要素を許可しない場合(オプション)UnsupportedOperationException
- removeオペレーションがこのリストでサポートされない場合boolean containsAll(Collection<?> c)
containsAll
、インタフェース: Collection<E>
c
- このリストにあるかどうかがチェックされるコレクションClassCastException
- 指定されたコレクションの1つ以上の要素の型が、このリストと互換でない場合(オプション)NullPointerException
- 指定されたコレクションに1つ以上のnull要素が含まれており、このリストがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合contains(Object)
boolean addAll(Collection<? extends E> c)
addAll
、インタフェース: Collection<E>
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)
removeAll
、インタフェース: Collection<E>
c
- このリストから削除される要素を含むコレクションUnsupportedOperationException
- removeAllオペレーションがこのリストでサポートされない場合ClassCastException
- このリストのある要素のクラスが、指定されたコレクションと互換でない場合(オプション)NullPointerException
- このリストにnull要素が含まれており、指定されたコレクションがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合remove(Object)
, contains(Object)
boolean retainAll(Collection<?> c)
retainAll
、インタフェース: Collection<E>
c
- このリストで保持される要素を含むコレクションUnsupportedOperationException
- retainAllオペレーションがこのリストでサポートされない場合ClassCastException
- このリストのある要素のクラスが、指定されたコレクションと互換でない場合(オプション)NullPointerException
- このリストにnull要素が含まれており、指定されたコレクションがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合remove(Object)
, contains(Object)
default void replaceAll(UnaryOperator<E> operator)
リスト
では、デフォルト実装は次と同等です。
final ListIterator<E> li = list.listIterator();
while (li.hasNext()) {
li.set(operator.apply(li.next()));
}
このリストのリスト・イテレータがset
操作をサポートしない場合、最初の要素を置き換えるときにUnsupportedOperationException
がスローされます。operator
- 各要素に適用する演算子UnsupportedOperationException
- このリストが変更できない場合。実装は、要素を置換できない場合、または一般的には変更がサポートされていない場合、この例外をスローすることがある。NullPointerException
- 指定された演算子がnull、または演算子の結果がnull値でこのリストがnull要素を許可しない場合(オプション)default void sort(Comparator<? super E> c)
Comparator
を使用して要素を比較することにより、このリストをソートします。リスト
では、デフォルト実装は次と同等です。
Collections.sort(list, c)
c
- リスト要素を比較するために使用されるComparator
。null
値は、要素の自然順序付けが使用されることを示すClassCastException
- リストに、指定されたコンパレータで相互比較できない要素が含まれる場合UnsupportedOperationException
- リストのリスト・イテレータがset
操作をサポートしない場合。IllegalArgumentException
- (オプション)コンパレータがComparator
規約に違反していることが見つかった場合void clear()
clear
、インタフェース: Collection<E>
UnsupportedOperationException
- clearオペレーションがこのリストでサポートされない場合boolean equals(Object o)
equals
、インタフェース: Collection<E>
equals
、クラス: Object
o
- このリストと等しいかどうかを比較するオブジェクトObject.hashCode()
, HashMap
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)
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)default Spliterator<E> spliterator()
Spliterator
を作成します。
Spliterator
は、Spliterator.SIZED
およびSpliterator.ORDERED
を報告します。実装は、追加の特性値の報告をドキュメント化する必要があります。
spliterator
、インタフェース: Collection<E>
spliterator
、インタフェース: Iterable<E>
Iterator
から遅延バインディング・スプリッテレータを作成します。スプリッテレータは、リストのイテレータのフェイルファスト・プロパティを継承します。Spliterator
はさらにSpliterator.SUBSIZED
も報告します。Spliterator
バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.