|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.iterators.ReverseListIterator<E>
public class ReverseListIterator<E>
Iterates backwards through a List, starting with the last element and continuing to the first. This is useful for looping around a list in reverse order without needing to actually reverse the list.
The first call to next()
will return the last element
from the list, and so on. The hasNext()
method works
in concert with the next()
method as expected.
However, the nextIndex()
method returns the correct
index in the list, thus it starts high and reduces as the iteration
continues. The previous methods work similarly.
Constructor Summary | |
---|---|
ReverseListIterator(List<E> list)
Constructor that wraps a list. |
Method Summary | |
---|---|
void |
add(E obj)
Adds a new element to the list between the next and previous elements. |
boolean |
hasNext()
Checks whether there is another element. |
boolean |
hasPrevious()
Checks whether there is a previous element. |
E |
next()
Gets the next element. |
int |
nextIndex()
Gets the index of the next element. |
E |
previous()
Gets the previous element. |
int |
previousIndex()
Gets the index of the previous element. |
void |
remove()
Removes the last returned element. |
void |
reset()
Resets the iterator back to the start (which is the end of the list as this is a reversed iterator) |
void |
set(E obj)
Replaces the last returned element. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReverseListIterator(List<E> list)
list
- the list to create a reversed iterator for
NullPointerException
- if the list is nullMethod Detail |
---|
public boolean hasNext()
hasNext
in interface Iterator<E>
hasNext
in interface ListIterator<E>
public E next()
next
in interface Iterator<E>
next
in interface ListIterator<E>
public int nextIndex()
nextIndex
in interface ListIterator<E>
public boolean hasPrevious()
hasPrevious
in interface ListIterator<E>
hasPrevious
in interface OrderedIterator<E>
public E previous()
previous
in interface ListIterator<E>
previous
in interface OrderedIterator<E>
public int previousIndex()
previousIndex
in interface ListIterator<E>
public void remove()
remove
in interface Iterator<E>
remove
in interface ListIterator<E>
UnsupportedOperationException
- if the list is unmodifiable
IllegalStateException
- if there is no element to removepublic void set(E obj)
set
in interface ListIterator<E>
obj
- the object to set
UnsupportedOperationException
- if the list is unmodifiable
IllegalStateException
- if the iterator is not in a valid state for setpublic void add(E obj)
add
in interface ListIterator<E>
obj
- the object to add
UnsupportedOperationException
- if the list is unmodifiable
IllegalStateException
- if the iterator is not in a valid state for setpublic void reset()
reset
in interface ResettableIterator<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |