Package org.dmfs.jems2.iterable

Class LeftZipped<Left,Right,Result>

java.lang.Object

org.dmfs.jems2.iterable.LeftZipped<Left,Right,Result>

All Implemented Interfaces:

Iterable<Result>

public final class LeftZipped<Left,Right,Result>
extends Object
implements Iterable<Result>

/** An Iterable combining the elements of two given Iterables using a BiFunction.

In contrast to Zipped, this always returns as many results as the left Iterable. The given BiFunction receives an Optional as the second argument, which is absent in case the right Iterable has run out of elements.

If the right Iterable has more elements than the left one, the excess elements are not iterated.

Constructor Summary

Constructors

Constructor	Description
LeftZipped(Iterable<? extends Left> left, Iterable<? extends Right> right, BiFunction<? super Left,? super Optional<? extends Right>,? extends Result> zipFunction)

Method Summary

Modifier and Type	Method	Description
Iterator<Result>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

LeftZipped

public LeftZipped(Iterable<? extends Left> left,
 Iterable<? extends Right> right,
 BiFunction<? super Left,? super Optional<? extends Right>,? extends Result> zipFunction)

Method Details

iterator

public Iterator<Result> iterator()

Specified by:

iterator in interface Iterable<Left>