net.digitalid.utility.functional.iterators

Class ZippingIterator<INPUT0,INPUT1>

java.lang.Object

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

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

net.digitalid.utility.functional.iterators.DoubleIteratorBasedIterator<Pair<INPUT0,INPUT1>,INPUT0,INPUT1>

net.digitalid.utility.functional.iterators.ZippingIterator<INPUT0,INPUT1>

All Implemented Interfaces:

Iterator<Pair<INPUT0,INPUT1>>

@Mutable
public class ZippingIterator<INPUT0,INPUT1>
extends DoubleIteratorBasedIterator<Pair<INPUT0,INPUT1>,INPUT0,INPUT1>

This class implements a zipping iterator that iterates over the elements of the given iterators in pairs, extending the shorter or truncating the longer iterator depending on the given flag.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	shortest

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	ZippingIterator(@Nonnull Iterator<? extends INPUT0> primaryIterator, @Nonnull Iterator<? extends INPUT1> secondaryIterator, boolean shortest)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
@Nonnull Pair<INPUT0,INPUT1>	next()
static <INPUT0,INPUT1> @Nonnull ZippingIterator<INPUT0,INPUT1>	with(@Nonnull Iterator<? extends INPUT0> primaryIterator, @Nonnull Iterator<? extends INPUT1> secondaryIterator, boolean shortest) Returns a new zipping iterator that iterates over the elements of the given iterators in pairs, extending the shorter or truncating the longer iterator depending on the given flag.

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

Field Detail

shortest

protected final boolean shortest

Constructor Detail

ZippingIterator

protected ZippingIterator(@Captured @Nonnull
                          @Nonnull Iterator<? extends INPUT0> primaryIterator,
                          @Captured @Nonnull
                          @Nonnull Iterator<? extends INPUT1> secondaryIterator,
                          boolean shortest)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <INPUT0,INPUT1> @Nonnull ZippingIterator<INPUT0,INPUT1> with(@Captured @Nonnull
                                                                                                        @Nonnull Iterator<? extends INPUT0> primaryIterator,
                                                                                                        @Captured @Nonnull
                                                                                                        @Nonnull Iterator<? extends INPUT1> secondaryIterator,
                                                                                                        boolean shortest)

Returns a new zipping iterator that iterates over the elements of the given iterators in pairs, extending the shorter or truncating the longer iterator depending on the given flag.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<Pair<INPUT0,INPUT1>>

Specified by:

hasNext in class ReadOnlyIterator<Pair<INPUT0,INPUT1>>

next

@Impure
 @Nonnull
public @Nonnull Pair<INPUT0,INPUT1> next()

Specified by:

next in interface Iterator<Pair<INPUT0,INPUT1>>

Specified by:

next in class ReadOnlyIterator<Pair<INPUT0,INPUT1>>