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>, ProtectedIterable<Payload>

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

An OptionalIterable is a ProtectedIterable that behaves like an ObjectIterable for a given payload object, or like an empty Iterable, 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
OptionalIterable(Payload value) Creates a new OptionalIterable.

Method Summary

Modifier and Type	Method and Description
net.markenwerk.commons.iterators.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(Payload value)

Creates a new OptionalIterable.

Parameters:

value - The object to iterate over.

Method Detail

iterator

public net.markenwerk.commons.iterators.OptionalIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Payload>

Specified by:

iterator in interface ProtectedIterable<Payload>

Returns:

A ProtectedIterator.