Package org.dmfs.jems2.iterable

Class LeftZipped<Left,​Right,​Result>

  • All Implemented Interfaces:
    java.lang.Iterable<Result>
    public final class LeftZipped<Left,​Right,​Result>
extends java.lang.Object
implements java.lang.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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.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 Detail

      • LeftZipped

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

    • Method Detail

      • iterator

        public java.util.Iterator<Result> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<Left>