net.markenwerk.commons.iterators

Class RemoveHandlerIterator<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>

public final class RemoveHandlerIterator<Payload>
extends Object
implements Iterator<Payload>

A RemoveHandlerIterator is an Iterator that can be wrapped around a given Iterator and intercepts every call to remove() and calls a given Handler for the current value.

Since:

2.2.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
RemoveHandlerIterator(Iterator<? extends Payload> iterator, Handler<? super Payload> removeHandler) Creates a new RemoveHandlerIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
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

RemoveHandlerIterator

public RemoveHandlerIterator(Iterator<? extends Payload> iterator,
                             Handler<? super Payload> removeHandler)
                      throws IllegalArgumentException

Creates a new RemoveHandlerIterator.

Parameters:

iterator - The Iterator to iterate over.

removeHandler - The Handler to be used.

Throws:

IllegalArgumentException - If the given Iterator is null of if the given Handler is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Payload>

next

public Payload next()
             throws NoSuchElementException

Specified by:

next in interface Iterator<Payload>

Throws:

NoSuchElementException

remove

public void remove()
            throws IllegalStateException

Specified by:

remove in interface Iterator<Payload>

Throws:

IllegalStateException