net.digitalid.utility.functional.iterators

Class CombiningIterator<ELEMENT>

java.lang.Object

net.digitalid.utility.functional.iterators.ReadOnlyIterator<OUTPUT>

net.digitalid.utility.functional.iterators.SingleIteratorBasedIterator<OUTPUT,INPUT0>

net.digitalid.utility.functional.iterators.DoubleIteratorBasedIterator<ELEMENT,ELEMENT,ELEMENT>

net.digitalid.utility.functional.iterators.CombiningIterator<ELEMENT>

All Implemented Interfaces:

Iterator<ELEMENT>

@Mutable
public class CombiningIterator<ELEMENT>
extends DoubleIteratorBasedIterator<ELEMENT,ELEMENT,ELEMENT>

This class implements a combining iterator that iterates first over the elements of the first iterator and then over the elements of the second iterator.

Field Summary

Fields inherited from class net.digitalid.utility.functional.iterators.DoubleIteratorBasedIterator

secondaryIterator

Fields inherited from class net.digitalid.utility.functional.iterators.SingleIteratorBasedIterator

primaryIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CombiningIterator(@Nonnull Iterator<? extends ELEMENT> primaryIterator, @Nonnull Iterator<? extends ELEMENT> secondaryIterator)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
ELEMENT	next()
static <ELEMENT> @Nonnull CombiningIterator<ELEMENT>	with(@Nonnull Iterator<? extends ELEMENT> primaryIterator, @Nonnull Iterator<? extends ELEMENT> secondaryIterator) Returns a new combining iterator that iterates first over the elements of the first iterator and then over the elements of the second iterator.

Methods inherited from class net.digitalid.utility.functional.iterators.ReadOnlyIterator

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

CombiningIterator

protected CombiningIterator(@Captured @Nonnull
                            @Nonnull Iterator<? extends ELEMENT> primaryIterator,
                            @Captured @Nonnull
                            @Nonnull Iterator<? extends ELEMENT> secondaryIterator)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull CombiningIterator<ELEMENT> with(@Captured @Nonnull
                                                                                              @Nonnull Iterator<? extends ELEMENT> primaryIterator,
                                                                                              @Captured @Nonnull
                                                                                              @Nonnull Iterator<? extends ELEMENT> secondaryIterator)

Returns a new combining iterator that iterates first over the elements of the first iterator and then over the elements of the second iterator.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENT>

Specified by:

hasNext in class ReadOnlyIterator<ELEMENT>

next

@Impure
 @NonCapturable
public ELEMENT next()

Specified by:

next in interface Iterator<ELEMENT>

Specified by:

next in class ReadOnlyIterator<ELEMENT>