java.util

インタフェース ListIterator<E>

すべてのスーパーインタフェース:

Iterator<E>

public interface ListIterator<E>
extends Iterator<E>

リスト用のイテレータ。プログラマがいずれかの方向にリストをトラバースしたり、イテレーション時にリストを変更したり、イテレータのリスト内での現在の位置を取得したりできます。ListIterator には現在の要素がありません。そのカーソル位置は常に、previous() の呼び出しによって返される要素と、next() の呼び出しによって返される要素との間にあります。長さ n のリストのイテレータには、次のキャレット (^) で示すように、n+1 個のカーソル位置があり得ます。

                      Element(0)   Element(1)   Element(2)   ... Element(n-1)
 カーソルの位置:    ^            ^            ^            ^                  ^
 

remove() メソッドと set(Object) メソッドは、カーソル位置によっては定義されていません。これらのメソッドは、next() または previous() の呼び出しによって返された最後の要素を処理するように定義されています。

このインタフェースは、Java Collections Framework のメンバーです。

導入されたバージョン:

1.2

関連項目:

Collection, List, Iterator, Enumeration, List.listIterator()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	add(E e) 指定された要素をリストに挿入します (オプションの操作)。
boolean	hasNext() リストを順方向にトラバースしたときに、このリストイテレータがさらに要素を持っている場合に true を返します。
boolean	hasPrevious() リストを逆方向にトラバースしたときに、このリストイテレータがさらに要素を持っている場合に true を返します。
E	next() リスト内の次の要素を返し、カーソル位置を前に進めます。
int	nextIndex() 次に next() を呼び出したときに返されることになる要素のインデックスを返します。
E	previous() リスト内の前の要素を返し、カーソル位置を逆方向に移動します。
int	previousIndex() 次に previous() を呼び出したときに返されることになる要素のインデックスを返します。
void	remove() next() または previous() によって返された最後の要素をリストから削除します (オプションの操作)。
void	set(E e) next() または previous() から最後に返された要素を指定された要素で置き換えます (オプションの操作)。

メソッドの詳細

hasNext

boolean hasNext()

リストを順方向にトラバースしたときに、このリストイテレータがさらに要素を持っている場合に true を返します。つまり、next() が例外をスローするのではなく要素を返す場合は、true を返します。

定義:

hasNext、インタフェース: Iterator<E>

戻り値:

リストを順方向にたどったときに、リストイテレータがさらに要素を持っている場合は true

next

E next()

リスト内の次の要素を返し、カーソル位置を前に進めます。このメソッドは、リストを反復するために繰り返し呼び出される場合と、前後に移動するために previous() の呼び出しと組み合わされる場合があります。next と previous の呼び出しを交互に行うと、繰り返し同じ要素が返されます。

定義:

next、インタフェース: Iterator<E>

戻り値:

リストの次の要素

例外:

NoSuchElementException - 反復処理で次の要素がない場合

hasPrevious

boolean hasPrevious()

リストを逆方向にトラバースしたときに、このリストイテレータがさらに要素を持っている場合に true を返します。つまり、previous() が例外をスローするのではなく要素を返す場合は、true を返します。

戻り値:

リストを逆方向にたどったときに、リストイテレータがさらに要素を持っている場合は true

previous

E previous()

リスト内の前の要素を返し、カーソル位置を逆方向に移動します。このメソッドは、リストを逆方向に反復するために繰り返し呼び出される場合と、前後に移動するために next() の呼び出しと組み合わされる場合があります。next と previous の呼び出しを交互に行うと、繰り返し同じ要素が返されます。

戻り値:

リストの前の要素

例外:

NoSuchElementException - 反復処理で前の要素がない場合

nextIndex

int nextIndex()

次に next() を呼び出したときに返されることになる要素のインデックスを返します。リストイテレータがリストの末尾にある場合はリストのサイズを返します。

戻り値:

次に next を呼び出したときに返されることになる要素のインデックス。リストイテレータがリストの最後にある場合はリストのサイズ

previousIndex

int previousIndex()

次に previous() を呼び出したときに返されることになる要素のインデックスを返します。リストイテレータがリストの先頭にある場合は -1 を返します。

戻り値:

次に previous を呼び出したときに返されることになる要素のインデックス。リストイテレータがリストの先頭にある場合は -1

remove

void remove()

next() または previous() によって返された最後の要素をリストから削除します (オプションの操作)。この呼び出しは next または previous の呼び出しごとに 1 回だけ行うことができます。この呼び出しは、前回の next または previous の呼び出し以降に add(E) が呼び出されていない場合にだけ行うことができます。

定義:

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

例外:

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

IllegalStateException - next と previous のどちらも呼び出されていない場合、あるいは next または previous の最後の呼び出し後に remove または add が呼び出された場合

set

void set(E e)

next() または previous() から最後に返された要素を指定された要素で置き換えます (オプションの操作)。この呼び出しは、前回の next または previous の呼び出し以降に remove() と add(E) のどちらも呼び出されていない場合にだけ行うことができます。

パラメータ:

e - next または previous によって返された最後の要素を置き換える要素

例外:

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

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

IllegalArgumentException - 指定された要素のある特性が原因で、このリストにその要素を追加できない場合

IllegalStateException - next と previous のどちらも呼び出されていない場合、あるいは next または previous の最後の呼び出し後に remove または add が呼び出された場合

add

void add(E e)

指定された要素をリストに挿入します (オプションの操作)。要素は、next() によって返される要素があればその要素の直前、および previous() によって返される要素があればその要素の直後に挿入されます。リストに要素がない場合は、新しい要素がリストの唯一の要素になります。新しい要素は、暗黙のカーソルの前に挿入されます。後続の next の呼び出しは影響を受けず、後続の previous の呼び出しは新しい要素を返します。この呼び出しは、nextIndex または previousIndex の呼び出しによって返される値を 1 増やします。

パラメータ:

e - 挿入する要素

例外:

UnsupportedOperationException - add メソッドがこのリストイテレータでサポートされない場合

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

IllegalArgumentException - この要素のある特性が原因で、このリストにその要素を追加できない場合