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>

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

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

Calling iterator() creates an instance of ArrayIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ArrayIterable(Payload[] values) Creates a new ArrayIterable for the given payload array.
ArrayIterable(Payload[] values, Payload replacement) Creates a new ArrayIterable for the given payload array.

Method Summary

Modifier and Type	Method and Description
Iterator<Payload>	iterator()

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[] values)

Creates a new ArrayIterable for the given payload array.

Parameters:

values - The payload array to iterate over.

ArrayIterable

public ArrayIterable(Payload[] values,
                     Payload replacement)

Creates a new ArrayIterable for the given payload array.

Parameters:

values - The payload array to iterate over.

replacement - The value to replace removed values with.

Method Detail

iterator

public Iterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>