net.digitalid.utility.functional.iterators

Class FlatteningIterator<OUTPUT,INPUT>

java.lang.Object

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

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

net.digitalid.utility.functional.iterators.FlatteningIterator<OUTPUT,INPUT>

All Implemented Interfaces:

Iterator<OUTPUT>

@Mutable
public class FlatteningIterator<OUTPUT,INPUT>
extends SingleIteratorBasedIterator<OUTPUT,INPUT>

This class implements a flattening iterator that iterates over the elements of the given iterator with all collections up to the given level flattened.

Field Summary

Fields

Modifier and Type	Field and Description
protected @NonNegative int	level

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

primaryIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlatteningIterator(@Nonnull Iterator<? extends INPUT> primaryIterator, @NonNegative int level)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
OUTPUT	next()
static <OUTPUT,INPUT> @Nonnull FlatteningIterator<OUTPUT,INPUT>	with(@Nonnull Iterator<? extends INPUT> iterator, @NonNegative int level) Returns a new flattening iterator that iterates over the elements of the given iterator with all collections up to the given level flattened.

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

level

@NonNegative
protected final @NonNegative int level

Constructor Detail

FlatteningIterator

protected FlatteningIterator(@Captured @Nonnull
                             @Nonnull Iterator<? extends INPUT> primaryIterator,
                             @NonNegative
                             @NonNegative int level)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <OUTPUT,INPUT> @Nonnull FlatteningIterator<OUTPUT,INPUT> with(@Captured @Nonnull
                                                                                                         @Nonnull Iterator<? extends INPUT> iterator,
                                                                                                         @NonNegative
                                                                                                         @NonNegative int level)

Returns a new flattening iterator that iterates over the elements of the given iterator with all collections up to the given level flattened.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<OUTPUT>

Specified by:

hasNext in class ReadOnlyIterator<OUTPUT>

next

@Impure
 @NonCapturable
public OUTPUT next()

Specified by:

next in interface Iterator<OUTPUT>

Specified by:

next in class ReadOnlyIterator<OUTPUT>