net.markenwerk.commons.iterables

Class EnumerationIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>

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

An EnumerationIterable is a Iterable that can be wrapped around a given Producer for Enumerations and generates Iterators that yield all values from a produced Enumeration.

Calling iterator() creates an instance of EnumerationIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
EnumerationIterable(Producer<Enumeration<Payload>> producer) Creates a new EnumerationIterable from the given Producer for Enumerations.

Method Summary

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

EnumerationIterable

public EnumerationIterable(Producer<Enumeration<Payload>> producer)
                    throws IllegalArgumentException

Creates a new EnumerationIterable from the given Producer for Enumerations.

Parameters:

producer - The Producer for Enumerations, around which the new EnumerationIterable will be wrapped.

Throws:

IllegalArgumentException - If the given Producer for Enumerations is null.

Method Detail

iterator

public EnumerationIterator<Payload> iterator()

Specified by:

iterator in interface Iterable<Payload>