net.markenwerk.commons.iterators

Class IndexedIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Entry<Integer,Payload>>

public final class IndexedIterator<Payload>
extends Object
implements Iterator<Entry<Integer,Payload>>

An IndexedIterator is an Iterator that can be wrapped around a given Iterator and every value yielded by the given Iterator as an Entry whose key is the index of the yielded element.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
IndexedIterator(Iterator<? extends Payload> iterator) Creates a new IndexedIterator from the given Iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Entry<Integer,Payload>	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IndexedIterator

public IndexedIterator(Iterator<? extends Payload> iterator)
                throws IllegalArgumentException

Creates a new IndexedIterator from the given Iterator.

Parameters:

iterator - The Iterator, around which the new NullFreeIterator will be wrapped.

Throws:

IllegalArgumentException - If the given Iterator is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Entry<Integer,Payload>>

next

public Entry<Integer,Payload> next()
                            throws NoSuchElementException

Specified by:

next in interface Iterator<Entry<Integer,Payload>>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException

Specified by:

remove in interface Iterator<Entry<Integer,Payload>>

Throws:

IllegalStateException