net.markenwerk.commons.iterables

Class FilteringIterable<Payload>

java.lang.Object

net.markenwerk.commons.iterables.FilteringIterable<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

public final class FilteringIterable<Payload>
extends Object
implements Iterable<Payload>

A FilteringIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that filters out values according to a given Predicate.

Calling iterator() creates an instance of FilteringIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
FilteringIterable(Iterable<? extends Payload> iterable, Predicate<Payload> predicate) Creates a new FilteringIterable from the given Iterable.
FilteringIterable(Iterable<? extends Payload> iterable, Predicate<Payload> predicate, boolean invertPredicate) Creates a new FilteringIterable from the given Iterable.

Method Summary

Modifier and Type	Method and Description
FilteringIterator<Payload>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FilteringIterable

public FilteringIterable(Iterable<? extends Payload> iterable,
                         Predicate<Payload> predicate)
                  throws IllegalArgumentException

Creates a new FilteringIterable from the given Iterable.

Parameters:

iterable - The Iterable, around which the new FilteringIterable will be wrapped.

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

Throws:

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

FilteringIterable

public FilteringIterable(Iterable<? extends Payload> iterable,
                         Predicate<Payload> predicate,
                         boolean invertPredicate)
                  throws IllegalArgumentException

Creates a new FilteringIterable from the given Iterable.

Parameters:

iterable - The Iterable, around which the new FilteringIterable will be wrapped.

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

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

Throws:

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

Method Detail

iterator

public FilteringIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>