de.ipcon.tools

Class IteratorWithAfterIterationCallback<T>

java.lang.Object

de.ipcon.tools.IteratorWithAfterIterationCallback<T>

Type Parameters:

T - the type of element returned by the Iterator

All Implemented Interfaces:

java.lang.AutoCloseable, java.util.Iterator

public class IteratorWithAfterIterationCallback<T>
extends java.lang.Object
implements java.util.Iterator, java.lang.AutoCloseable

An Iterator that wraps another Iterator and provides a callback that is called after an element has been returned.

Constructor Summary

Constructors

Constructor and Description
IteratorWithAfterIterationCallback(java.util.Iterator<T> delegate, java.util.function.Consumer<T> callback) Constructs an IteratorWithAfterIterationCallback object that wraps the given Iterator and calls the passed callback after an object was returned.
IteratorWithAfterIterationCallback(java.util.Iterator<T> delegate, java.util.function.Consumer<T> callback, boolean doThrowOnExecutionErrors) Constructs an IteratorWithAfterIterationCallback object that wraps the given Iterator and calls the passed callback after an object was returned.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this IteratorWithAfterIterationCallback and frees all resources.
boolean	hasNext() Returns true if the iteration has more elements.
T	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IteratorWithAfterIterationCallback

public IteratorWithAfterIterationCallback(java.util.Iterator<T> delegate,
                                          java.util.function.Consumer<T> callback)

Constructs an IteratorWithAfterIterationCallback object that wraps the given Iterator and calls the passed callback after an object was returned. Only a warning will be logged if the callback throws an Exception during execution.

Parameters:

delegate - the Iterator to wrap in this IteratorWithExhaustionCallbacks. Must not be null.

callback - the callback to call after an object was returned

Throws:

java.lang.IllegalArgumentException - if the given Iterator or callback are null

IteratorWithAfterIterationCallback

public IteratorWithAfterIterationCallback(java.util.Iterator<T> delegate,
                                          java.util.function.Consumer<T> callback,
                                          boolean doThrowOnExecutionErrors)

Constructs an IteratorWithAfterIterationCallback object that wraps the given Iterator and calls the passed callback after an object was returned. Additionally, the behavior of the Runnable that is provided as callback can be customized with the doThrowOnExecutionErrors parameter.

Parameters:

delegate - the Iterator to wrap in this IteratorWithExhaustionCallbacks. Must not be null.

callback - the callback to call after an object was returned

doThrowOnExecutionErrors - a boolean (defaults to false) that controls the behavior of any Runnable objects provided as callbacks. If true, an IRuntimeException will be raised if any of the callbacks throws an Exception during execution. If false, only a warning will be logged for any such Exceptions.

Throws:

java.lang.IllegalArgumentException - if the given Iterator or callback are null

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. If this method returns true, then a call to next() will successfully return an element. Additionally, the configured callback will be called on the last returned object.

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if the iteration has more elements

Throws:

IRuntimeException - if doThrowOnExecutionErrors was configured as true and the configured callback throws an Exception during execution

next

public T next()

Specified by:

next in interface java.util.Iterator

remove

public void remove()

Specified by:

remove in interface java.util.Iterator

close

public void close()

Closes this IteratorWithAfterIterationCallback and frees all resources. All consecutive calls to methods other than close will raise an IllegalStateException. Additionally, the configured callback will be called on the last returned object.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

IRuntimeException - if doThrowOnExecutionErrors was configured as true and the configured callback throws an Exception during execution