net.markenwerk.commons.iterables

Class PrefixedIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

An PrefixedIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that yield some given prefix values before every object yielded by an Iterator that is generated by the given Iterable.

Calling iterator() creates an instance of PrefixedIterator.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
PrefixedIterable(Iterable<? extends Payload> iterable, Payload... prefixes) Creates a new PrefixedIterable from the given Iterable.

Method Summary

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

PrefixedIterable

public PrefixedIterable(Iterable<? extends Payload> iterable,
                        Payload... prefixes)
                 throws IllegalArgumentException

Creates a new PrefixedIterable from the given Iterable.

Parameters:

iterable - The Iterable, around which the new PrefixedIterable will be wrapped.

prefixes - The prefixes to be yielded.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public PrefixedIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>