net.markenwerk.commons.iterables

Class CombinedIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

A CombinedIterable is an Iterable that wraps around some given Iterables and combines them into a single Iterable by iterating over all given Iterables in the order they were given.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CombinedIterable(Iterable<? extends Iterable<? extends Payload>> iterable) Creates a new CombinedIterable.
CombinedIterable(Iterable<? extends Payload>... iterables) Creates a new CombinedIterable.

Method Summary

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

CombinedIterable

public CombinedIterable(Iterable<? extends Payload>... iterables)

Creates a new CombinedIterable.

Parameters:

iterables - The sequence of Iterables to iterate over.

Throws:

IllegalArgumentException - If the given sequence of Iterables is null.

CombinedIterable

public CombinedIterable(Iterable<? extends Iterable<? extends Payload>> iterable)
                 throws IllegalArgumentException

Creates a new CombinedIterable.

Parameters:

iterable - The Iterable of Iterables to iterate over.

Throws:

IllegalArgumentException - If the given Iterable of Iterables is null.

Method Detail

iterator

public CombinedIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>