net.markenwerk.commons.iterables

Class OptionalIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, BidirectionalIterable<Payload>, ProtectedBidirectionalIterable<Payload>

public final class OptionalIterable<Payload>
extends Object
implements ProtectedBidirectionalIterable<Payload>

A OptionalIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given NodeList.

Since:

3.1.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
OptionalIterable(Optional<Payload> optional) Creates a new OptionalIterable.

Method Summary

Modifier and Type	Method and Description
OptionalIterator<Payload>	iterator() Returns a ProtectedIterator.

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

OptionalIterable

public OptionalIterable(Optional<Payload> optional)
                 throws IllegalArgumentException

Creates a new OptionalIterable.

Parameters:

optional - The Optional to iterate over.

Throws:

IllegalArgumentException - If the given Optional is null.

Method Detail

iterator

public OptionalIterator<Payload> iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Payload>

Specified by:

iterator in interface BidirectionalIterable<Payload>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Payload>

Returns:

A ProtectedIterator.