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>, ProtectedIterable<Payload>

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

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

Since:

1.1.6

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
EnumerationIterable(Provider<? extends Enumeration<? extends Payload>> provider) Creates a new EnumerationIterable.

Method Summary

Modifier and Type	Method and Description
EnumerationIterator<Payload>	iterator() Returns a ProtectedIterator.

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(Provider<? extends Enumeration<? extends Payload>> provider)
                    throws IllegalArgumentException

Creates a new EnumerationIterable.

Parameters:

provider - The Provider for Enumerations to iterate over.

Throws:

IllegalArgumentException - If the given Provider for Enumerations is null.

Method Detail

iterator

public EnumerationIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Payload>

Specified by:

iterator in interface ProtectedIterable<Payload>

Returns:

A ProtectedIterator.