net.markenwerk.commons.iterables

Class SuffixedIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

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

Calling iterator() creates an instance of SuffixedIterator.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

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

SuffixedIterable

public SuffixedIterable(Iterable<? extends Payload> iterable,
                        Payload... suffixes)
                 throws IllegalArgumentException

Creates a new SuffixedIterable from the given Iterable.

Parameters:

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

suffixes - The suffixes to be yielded.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public SuffixedIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>