net.digitalid.utility.functional.iterators.RepeatingIterator 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 javax.annotation.Nonnull;

import net.digitalid.utility.annotations.generics.Specifiable;
import net.digitalid.utility.annotations.method.Impure;
import net.digitalid.utility.annotations.method.Pure;
import net.digitalid.utility.annotations.ownership.Capturable;
import net.digitalid.utility.annotations.ownership.Captured;
import net.digitalid.utility.annotations.ownership.NonCapturable;
import net.digitalid.utility.validation.annotations.type.Mutable;

/**
 * This class implements a repeating iterator that repeats the given element infinitely.
 */
@Mutable
public class RepeatingIterator<@Specifiable ELEMENT> extends InfiniteIterator {
    
    /* -------------------------------------------------- Element -------------------------------------------------- */
    
    protected final ELEMENT element;
    
    /* -------------------------------------------------- Constructors -------------------------------------------------- */
    
    protected RepeatingIterator(@Captured ELEMENT element) {
        this.element = element;
    }
    
    /**
     * Returns a new repeating iterator that repeats the given element infinitely.
     */
    @Pure
    public static @Capturable <@Specifiable ELEMENT> @Nonnull RepeatingIterator with(@Captured ELEMENT element) {
        return new RepeatingIterator<>(element);
    }
    
    /* -------------------------------------------------- Methods -------------------------------------------------- */
    
    @Impure
    @Override
    public @NonCapturable ELEMENT next() {
        return element;
    }
    
}