net.markenwerk.commons.iterators

Class FilteringIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

public class FilteringIterator<Payload>
extends Object
implements Iterator<Payload>

A FilteringIterator 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
FilteringIterator(Iterator<Payload> iterator, net.markenwerk.commons.interfaces.Predicate<Payload> predicate) Creates a new FilteringIterator from the given Iterator and the given Predicate.

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

FilteringIterator

public FilteringIterator(Iterator<Payload> iterator,
                         net.markenwerk.commons.interfaces.Predicate<Payload> predicate)

Creates a new FilteringIterator from the given Iterator and the given Predicate.

Parameters:

iterator - The Iterator, around which the new NullFreeIterator will be wrapped.

predicate - The Predicate to test every value yielded by the given Iterator with.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Payload>

next

public Payload next()

Specified by:

next in interface Iterator<Payload>

remove

public void remove()

Specified by:

remove in interface Iterator<Payload>