net.markenwerk.commons.iterators

Class AbstractIndexedIterator<Payload>

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.AbstractProtectedBidirectionalIterator<Payload>

net.markenwerk.commons.iterators.AbstractIndexedIterator<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, BidirectionalIterator<Payload>, ProtectedBidirectionalIterator<Payload>, ProtectedIterator<Payload>

Direct Known Subclasses:

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

public abstract class AbstractIndexedIterator<Payload>
extends AbstractProtectedBidirectionalIterator<Payload>

An AbstractIndexedIterator is an abstract base implementation for ProtectedBidirectionalIterator implementations that holds the current index and implements the index-related methods.

Since:

3.1.1

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIndexedIterator(int startIndex, int maxIndex) Creates a new AbstractIndexedIterator.

Method Summary

Modifier and Type	Method and Description
protected abstract Payload	get(int index) Returns the payload value at the given index.
boolean	hasNext()
boolean	hasPrevious() Returns whether this BidirectionalIterator has a previous element.
Payload	next()
Payload	previous() Returns the previous element.

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

AbstractIndexedIterator

protected AbstractIndexedIterator(int startIndex,
                                  int maxIndex)
                           throws IllegalArgumentException

Creates a new AbstractIndexedIterator.

Parameters:

startIndex - The start index to be used.

maxIndex - The maximum index.

Throws:

IllegalArgumentException - If the given start index is negative or if the given maximum index is smaller than the start index.

Method Detail

hasNext

public final boolean hasNext()

next

public final Payload next()
                   throws NoSuchElementException

Throws:

NoSuchElementException

hasPrevious

public final boolean hasPrevious()

Description copied from interface: BidirectionalIterator

Returns whether this BidirectionalIterator has a previous element.

Returns:

Whether this BidirectionalIterator has a previous element.

previous

public final Payload previous()
                       throws NoSuchElementException

Description copied from interface: BidirectionalIterator

Returns the previous element.

Returns:

The previous element in the iteration.

Throws:

NoSuchElementException - If this BidirectionalIterator has no previous element.

get

protected abstract Payload get(int index)

Returns the payload value at the given index.

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.