net.markenwerk.commons.iterators

Class CombinedIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

public final class CombinedIterator<Payload>
extends Object
implements Iterator<Payload>

A CombinedIterator is an Iterator that wraps around a sequence of given Iterators and combines them into a single Iterator by iterating over all given Iterators in the order they were given.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CombinedIterator(Iterable<? extends Iterator<? extends Payload>> iterators) Creates a new CombinedIterator.
CombinedIterator(Iterator<? extends Iterator<? extends Payload>> iterators) Creates a new CombinedIterator.
CombinedIterator(Iterator<? extends Payload>... iterators) Creates a new CombinedIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
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

CombinedIterator

public CombinedIterator(Iterator<? extends Payload>... iterators)
                 throws IllegalArgumentException

Creates a new CombinedIterator.

Parameters:

iterators - The Iterators to iterate over.

Throws:

IllegalArgumentException - If the given sequence of Iterators is null.

CombinedIterator

public CombinedIterator(Iterable<? extends Iterator<? extends Payload>> iterators)
                 throws IllegalArgumentException

Creates a new CombinedIterator.

Parameters:

iterators - The Iterators to iterate over.

Throws:

IllegalArgumentException - If the given Iterable of Iterators is null.

CombinedIterator

public CombinedIterator(Iterator<? extends Iterator<? extends Payload>> iterators)
                 throws IllegalArgumentException

Creates a new CombinedIterator.

Parameters:

iterators - The Iterators to iterate over.

Throws:

IllegalArgumentException - If the given Iterator of Iterators is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Payload>

next

public Payload next()
             throws NoSuchElementException

Specified by:

next in interface Iterator<Payload>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException,
                   UnsupportedOperationException

Specified by:

remove in interface Iterator<Payload>

Throws:

IllegalStateException

UnsupportedOperationException