net.markenwerk.commons.iterables

Class ObjectIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

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

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

An ObjectIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a single payload object.

Since:

1.1.5

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ObjectIterable(Payload value) Creates a new ObjectIterable.
ObjectIterable(Payload value, boolean ignoreNull) Creates a new ObjectIterable.

Method Summary

Modifier and Type	Method and Description
ObjectIterator<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

ObjectIterable

public ObjectIterable(Payload value)

Creates a new ObjectIterable.

Parameters:

value - The object to iterate over.

ObjectIterable

public ObjectIterable(Payload value,
                      boolean ignoreNull)

Creates a new ObjectIterable.

Parameters:

value - The object to iterate over.

ignoreNull - Whether to ignore null values.

Method Detail

iterator

public ObjectIterator<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.