net.markenwerk.commons.iterables

Class LookAheadIterable<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<LookAhead<Payload>>, ProtectedIterable<LookAhead<Payload>>

public final class LookAheadIterable<Payload>
extends Object
implements ProtectedIterable<LookAhead<Payload>>

A LookAheadIterable is a ProtectedIterable that can be wrapped around a given Iterator and generates Iterators that yield a LookAhead container that holds the current and the next payload value of an Iterator that is generated by the given Iterable.

Since:

1.1.6

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
LookAheadIterable(Iterable<? extends Payload> iterable) Creates a new LookAheadIterable.

Method Summary

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

LookAheadIterable

public LookAheadIterable(Iterable<? extends Payload> iterable)
                  throws IllegalArgumentException

Creates a new LookAheadIterable.

Parameters:

iterable - The Iterable to iterate over.

Throws:

IllegalArgumentException - If the given Iterable is null.

Method Detail

iterator

public LookAheadIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<LookAhead<Payload>>

Specified by:

iterator in interface ProtectedIterable<LookAhead<Payload>>

Returns:

A ProtectedIterator.