net.digitalid.utility.functional.iterators

Class PruningIterator<ELEMENT>

java.lang.Object

net.digitalid.utility.functional.iterators.ReadOnlyIterator<OUTPUT>

net.digitalid.utility.functional.iterators.SingleIteratorBasedIterator<ELEMENT,ELEMENT>

net.digitalid.utility.functional.iterators.PruningIterator<ELEMENT>

All Implemented Interfaces:

Iterator<ELEMENT>

@Mutable
public class PruningIterator<ELEMENT>
extends SingleIteratorBasedIterator<ELEMENT,ELEMENT>

This class implements a pruning iterator that iterates over the elements of the given iterator from the given start index to but not including the given end index. If the end index is Integer.MAX_VALUE, this iterator returns values as long as the given iterator does, which is important for skipping infinite iterables.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Positive int	endIndex
protected @NonNegative int	startIndex

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

primaryIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PruningIterator(@Nonnull Iterator<? extends ELEMENT> primaryIterator, @NonNegative int startIndex, @Positive int endIndex)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
ELEMENT	next()
static <ELEMENT> @Nonnull PruningIterator<ELEMENT>	with(@Nonnull Iterator<? extends ELEMENT> iterator, @NonNegative int startIndex, @Positive int endIndex) Returns a new pruning iterator that iterates over the elements of the given iterator from the given start index to but not including the given end index.

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

startIndex

@NonNegative
protected final @NonNegative int startIndex

endIndex

@Positive
protected final @Positive int endIndex

Constructor Detail

PruningIterator

protected PruningIterator(@Captured @Nonnull
                          @Nonnull Iterator<? extends ELEMENT> primaryIterator,
                          @NonNegative
                          @NonNegative int startIndex,
                          @Positive
                          @Positive int endIndex)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull PruningIterator<ELEMENT> with(@Captured @Nonnull
                                                                                            @Nonnull Iterator<? extends ELEMENT> iterator,
                                                                                            @NonNegative
                                                                                            @NonNegative int startIndex,
                                                                                            @Positive
                                                                                            @Positive int endIndex)

Returns a new pruning iterator that iterates over the elements of the given iterator from the given start index to but not including the given end index.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENT>

Specified by:

hasNext in class ReadOnlyIterator<ELEMENT>

next

@Impure
 @NonCapturable
public ELEMENT next()

Specified by:

next in interface Iterator<ELEMENT>

Specified by:

next in class ReadOnlyIterator<ELEMENT>