net.markenwerk.commons.iterators

Interface BidirectionalIterator<Payload>

Type Parameters:

Payload - The payload type.

All Superinterfaces:

Iterator<Payload>

All Known Subinterfaces:

ProtectedBidirectionalIterator<Payload>

All Known Implementing Classes:

AbstractIndexedIterator, AbstractProtectedBidirectionalIterator, ArrayIterator, BooleanArrayIterator, ByteArrayIterator, CharacterArrayIterator, CountDownIterator, CountUpIterator, DoubleArrayIterator, EmptyIterator, FloatArrayIterator, IntegerArrayIterator, LongArrayIterator, NodeListIterator, ObjectIterator, OptionalIterator, PairIterator, ProtectingBidirectionalIterator, ShortArrayIterator, TripleIterator, TupleIterator

public interface BidirectionalIterator<Payload>
extends Iterator<Payload>

A BidirectionalIterator is an Iterator that can move in two directions.

Since:

3.1.1

Author:

Torsten Krause (tk at markenwerk dot net)

Method Summary

Modifier and Type	Method and Description
boolean	hasPrevious() Returns whether this BidirectionalIterator has a previous element.
Payload	previous() Returns the previous element.
void	remove() Removes the last returned (either by Iterator.next() or by previous()) payload value from the underlying data structure.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Method Detail

hasPrevious

boolean hasPrevious()

Returns whether this BidirectionalIterator has a previous element.

Returns:

Whether this BidirectionalIterator has a previous element.

previous

Payload previous()
          throws NoSuchElementException

Returns the previous element.

Returns:

The previous element in the iteration.

Throws:

NoSuchElementException - If this BidirectionalIterator has no previous element.

remove

void remove()
     throws UnsupportedOperationException,
            IllegalStateException

Removes the last returned (either by Iterator.next() or by previous()) payload value from the underlying data structure.

Specified by:

remove in interface Iterator<Payload>

Throws:

UnsupportedOperationException - If this BidirectionalIterator doesn't support element removal.

IllegalStateException - If neither Iterator.next() nor previous() has been called or if remove() has already been called after the last call to Iterator.next() or previous().