net.digitalid.utility.functional.iterators.DoubleIteratorBasedIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utility-functional Show documentation

The newest version!

package net.digitalid.utility.functional.iterators;

import java.util.Iterator;

import javax.annotation.Nonnull;

import net.digitalid.utility.annotations.generics.Specifiable;
import net.digitalid.utility.annotations.ownership.Captured;
import net.digitalid.utility.validation.annotations.type.Mutable;

/**
 * This class implements an iterator which is based on a primary and a secondary iterator.
 */
@Mutable
public abstract class DoubleIteratorBasedIterator<@Specifiable OUTPUT, @Specifiable INPUT0, @Specifiable INPUT1> extends SingleIteratorBasedIterator {
    
    /* -------------------------------------------------- Secondary Iterator -------------------------------------------------- */
    
    /**
     * Stores the secondary iterator on which this iterator is based.
     */
    protected final @Nonnull Iterator secondaryIterator;
    
    /* -------------------------------------------------- Constructors -------------------------------------------------- */
    
    protected DoubleIteratorBasedIterator(@Captured @Nonnull Iterator primaryIterator, @Captured @Nonnull Iterator secondaryIterator) {
        super(primaryIterator);
        
        this.secondaryIterator = secondaryIterator;
    }
    
}