net.markenwerk.commons.iterators

Class OptionalIterator<Payload>

java.lang.Object

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

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

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, BidirectionalIterator<Payload>, ProtectedBidirectionalIterator<Payload>, ProtectedIterator<Payload>

public final class OptionalIterator<Payload>
extends AbstractIndexedIterator<Payload>

An OptionalIterator is an AbstractIndexedIterator 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(Optional<Payload> value) Creates a new OptionalIterator.

Method Summary

Modifier and Type	Method and Description
Payload	get(int index) Returns the payload value at the given index.

Methods inherited from class net.markenwerk.commons.iterators.AbstractIndexedIterator

hasNext, hasPrevious, next, previous

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

OptionalIterator

public OptionalIterator(Optional<Payload> value)

Creates a new OptionalIterator.

Parameters:

value - The object to iterate over.

Method Detail

get

public Payload get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Payload>

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.