net.digitalid.utility.functional.iterators

Class FilteringIterator<ELEMENT>

java.lang.Object

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

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

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

All Implemented Interfaces:

Iterator<ELEMENT>

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

This class implements a filtering iterator that iterates over the elements of the given iterator that fulfill the given predicate.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nonnull FailablePredicate<? super ELEMENT,?>	predicate

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

primaryIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilteringIterator(@Nonnull Iterator<? extends ELEMENT> primaryIterator, @Nonnull FailablePredicate<? super ELEMENT,?> predicate)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
ELEMENT	next()
static <ELEMENT> @Nonnull FilteringIterator<ELEMENT>	with(@Nonnull Iterator<? extends ELEMENT> iterator, @Nonnull FailablePredicate<? super ELEMENT,?> predicate) Returns a new filtering iterator that iterates over the elements of the given iterator that fulfill the given predicate.

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

predicate

@Nonnull
protected final @Nonnull FailablePredicate<? super ELEMENT,?> predicate

Constructor Detail

FilteringIterator

protected FilteringIterator(@Captured @Nonnull
                            @Nonnull Iterator<? extends ELEMENT> primaryIterator,
                            @Nonnull
                            @Nonnull FailablePredicate<? super ELEMENT,?> predicate)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull FilteringIterator<ELEMENT> with(@Captured @Nonnull
                                                                                              @Nonnull Iterator<? extends ELEMENT> iterator,
                                                                                              @Nonnull
                                                                                              @Nonnull FailablePredicate<? super ELEMENT,?> predicate)

Returns a new filtering iterator that iterates over the elements of the given iterator that fulfill the given predicate.

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>