net.markenwerk.commons.iterators

Class NullFreeIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

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

A NullFreeIterator is an Iterator that can be wrapped around a given Iterator and filters out null values.

Calling next() will never return null and calling hasNext() will never return true, unless a value that is not null is available.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
NullFreeIterator(Iterator<? extends Payload> iterator) Creates a new NullFreeIterator.

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

NullFreeIterator

public NullFreeIterator(Iterator<? extends Payload> iterator)
                 throws IllegalArgumentException

Creates a new NullFreeIterator.

Parameters:

iterator - The Iterator to iterate over.

Throws:

IllegalArgumentException - If the given Iterator 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