net.markenwerk.commons.iterators

Class NullSaveIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

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

A NullSaveIterator is an Iterator that can be wrapped around a given Iterator and always behaves correctly, even if the given Iterator is null (by behaving like an EmptyIterator).

Calling any of the methods declared by Iterator will be relayed to the given Iterator, if present.

For convenience, it is possible to construct a NullSaveIterator from an Iterable even if the given Iterable is null.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

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

NullSaveIterator

public NullSaveIterator(Iterable<? extends Payload> iterable)

Creates a new NullSaveIterator.

Parameters:

iterable - The Iterable to obtain an Iterator from.

NullSaveIterator

public NullSaveIterator(Iterator<? extends Payload> iterator)

Creates a new NullSaveIterator.

Parameters:

iterator - The Iterator to iterate over.

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