net.markenwerk.commons.iterables

Class InfixedIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

An InfixedIterable is an Iterable that can be wrapped around a given Iterable and generates Iterators that yield a given infix between every object yielded by an Iterator that is generated by the given Iterable.

Calling iterator() creates an instance of InfixedIterator.

Since:

1.1.6

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

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

InfixedIterable

public InfixedIterable(Iterable<? extends Payload> iterable,
                       Payload infix)
                throws IllegalArgumentException

Creates a new InfixedIterable from the given Iterable.

Parameters:

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

infix - The infix to be yielded.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public InfixedIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>