net.markenwerk.commons.iterables

Class NullFreeIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

A NullFreeIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that filters out null values.

Calling iterator() creates an instance of NullFreeIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
NullFreeIterable(Iterable<? extends Payload> iterable) Creates a new NullFreeIterable.

Method Summary

Modifier and Type	Method and Description
NullFreeIterator<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

NullFreeIterable

public NullFreeIterable(Iterable<? extends Payload> iterable)
                 throws IllegalArgumentException

Creates a new NullFreeIterable.

Parameters:

iterable - The Iterable to iterate over.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public NullFreeIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>