net.digitalid.utility.functional.iterators

Class MappingIterator<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.MappingIterator<OUTPUT,INPUT>

All Implemented Interfaces:

Iterator<OUTPUT>

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

This class implements a mapping iterator that iterates over the elements of the given iterator mapped by the given function.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?>	function

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

primaryIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappingIterator(@Nonnull Iterator<INPUT> primaryIterator, @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?> function)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
OUTPUT	next()
static <OUTPUT,INPUT> @Nonnull MappingIterator<OUTPUT,INPUT>	with(@Nonnull Iterator<INPUT> iterator, @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?> function) Returns a new mapping iterator that iterates over the elements of the given iterator mapped by the given function.

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

function

@Nonnull
protected final @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?> function

Constructor Detail

MappingIterator

protected MappingIterator(@Captured @Nonnull
                          @Nonnull Iterator<INPUT> primaryIterator,
                          @Nonnull
                          @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?> function)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <OUTPUT,INPUT> @Nonnull MappingIterator<OUTPUT,INPUT> with(@Captured @Nonnull
                                                                                                      @Nonnull Iterator<INPUT> iterator,
                                                                                                      @Nonnull
                                                                                                      @Nonnull FailableUnaryFunction<? super INPUT,? extends OUTPUT,?> function)

Returns a new mapping iterator that iterates over the elements of the given iterator mapped by the given function.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<OUTPUT>

Specified by:

hasNext in class ReadOnlyIterator<OUTPUT>

next

@Impure
public OUTPUT next()

Specified by:

next in interface Iterator<OUTPUT>

Specified by:

next in class ReadOnlyIterator<OUTPUT>