net.markenwerk.commons.iterators

Class OptionalIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, ProtectedIterator<Payload>

public final class OptionalIterator<Payload>
extends Object
implements ProtectedIterator<Payload>

An OptionalIterator is a Iterator that behaves like an ObjectIterator for a given payload object, or like an empty Iterator, if the given payload object is null.

Since:

1.1.5

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
OptionalIterator(Payload value) Creates a new OptionalIterator that iterates over the given payload object.

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

OptionalIterator

public OptionalIterator(Payload value)

Creates a new OptionalIterator that iterates over the given payload object.

Parameters:

value - The payload object to iterate over.

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>