net.markenwerk.commons.iterables

Class ArrayIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

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

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

An ArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given payload array.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ArrayIterable(Payload... array) Creates a new ArrayIterable.

Method Summary

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

ArrayIterable

public ArrayIterable(Payload... array)
              throws IllegalArgumentException

Creates a new ArrayIterable.

Parameters:

array - The payload array to iterate over.

Throws:

IllegalArgumentException - If the given payload array is null.

Method Detail

iterator

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