Module io.github.mmm.base

Package io.github.mmm.base.collection

Class AbstractIterator<E>

java.lang.Object

io.github.mmm.base.collection.AbstractIterator<E>

Type Parameters:

E - type of the elements to iterate.

All Implemented Interfaces:

Iterator<E>

public abstract class AbstractIterator<E>
extends Object
implements Iterator<E>

Abstract base implementation of Iterator as reusable pattern to simplify implementations of Iterator. Please carefully consider the following constraints before use:

• This Iterator cannot iterate null elements.
• Implementations extending AbstractIterator have to call findFirst() at the end of their constructor.
• Finally, you only to do implement findNext().

Constructor Summary

Constructors

Constructor	Description
AbstractIterator()

Method Summary

Modifier and Type	Method	Description
protected final void	findFirst()	Has to be called from the constructor after initialization of fields to find the first element.
protected abstract E	findNext()
final boolean	hasNext()
final E	next()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Details

AbstractIterator

public AbstractIterator()

Method Details

findFirst

protected final void findFirst()

Has to be called from the constructor after initialization of fields to find the first element.

findNext

protected abstract E findNext()

Returns:

the next element or null if done.

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface Iterator<E>

next

public final E next()

Specified by:

next in interface Iterator<E>

toString

public String toString()

Overrides:

toString in class Object