net.markenwerk.commons.iterators

Class FilteredIterator<Payload>

java.lang.Object

net.markenwerk.commons.iterators.FilteredIterator<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

public final class FilteredIterator<Payload>
extends Object
implements Iterator<Payload>

A FilteredIterator is an Iterator that can be wrapped around a given Iterator and filters out values according to a given Predicate.

Calling next() will never return a value that doesn't satisfy the given Predicate and calling hasNext() will never return true, unless a value that satisfies the given Predicate is available.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
FilteredIterator(Iterator<? extends Payload> iterator, Predicate<? super Payload> predicate) Creates a new FilteredIterator.
FilteredIterator(Iterator<? extends Payload> iterator, Predicate<? super Payload> predicate, boolean invertPredicate) Creates a new FilteredIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Payload	next()
void	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

Constructor Detail

FilteredIterator

public FilteredIterator(Iterator<? extends Payload> iterator,
                        Predicate<? super Payload> predicate)
                 throws IllegalArgumentException

Creates a new FilteredIterator.

Parameters:

iterator - The Iterator to iterate over.

predicate - The Predicate to be used.

Throws:

IllegalArgumentException - If the given Iterator is null or if the given Predicate is null.

FilteredIterator

public FilteredIterator(Iterator<? extends Payload> iterator,
                        Predicate<? super Payload> predicate,
                        boolean invertPredicate)
                 throws IllegalArgumentException

Creates a new FilteredIterator.

Parameters:

iterator - The Iterator to iterate over.

predicate - The Predicate to be used.

invertPredicate - Whether to invert the test result and yield values that don't satisfy the given Predicate.

Throws:

IllegalArgumentException - If the given Iterator is null or if the given Predicate is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Payload>

next

public Payload next()
             throws NoSuchElementException

Specified by:

next in interface Iterator<Payload>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException,
                   UnsupportedOperationException

Specified by:

remove in interface Iterator<Payload>

Throws:

IllegalStateException

UnsupportedOperationException