net.markenwerk.commons.iterators

Class LookAheadIterator<Payload>

java.lang.Object

net.markenwerk.commons.iterators.LookAheadIterator<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<LookAhead<Payload>>, ProtectedIterator<LookAhead<Payload>>

public final class LookAheadIterator<Payload>
extends Object
implements ProtectedIterator<LookAhead<Payload>>

A LookAheadIterator is an Iterator that can be wrapped around a given Iterator and yields a LookAhead container that holds the current and the next payload value of the given Iterator.

Since:

1.1.6

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
LookAheadIterator(Iterator<? extends Payload> iterator) Creates a new LookAheadIterator from the given Iterator and the given Predicate.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
LookAhead<Payload>	next()
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

LookAheadIterator

public LookAheadIterator(Iterator<? extends Payload> iterator)
                  throws IllegalArgumentException

Creates a new LookAheadIterator from the given Iterator and the given Predicate.

Parameters:

iterator - The Iterator, around which the new LookAheadIterator will be wrapped.

Throws:

IllegalArgumentException - If the given Iterator is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<LookAhead<Payload>>

next

public LookAhead<Payload> next()

Specified by:

next in interface Iterator<LookAhead<Payload>>

remove

public void remove()

Specified by:

remove in interface Iterator<LookAhead<Payload>>