net.markenwerk.commons.iterables

Class ProtectingIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, ProtectedIterable<Payload>

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

A ProtectingIterable is a ProtectedIterable that can be wrapped around a given Iterable and generates that every call to iterator() yields a ProtectedIterator.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ProtectingIterable(Iterable<Payload> iterable) Creates a new ProtectingIterable.

Method Summary

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

ProtectingIterable

public ProtectingIterable(Iterable<Payload> iterable)
                   throws IllegalArgumentException

Creates a new ProtectingIterable.

Parameters:

iterable - The Iterable to iterate over.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public ProtectingIterator<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.