Package com.saperion.common.lang.iterator

Class ExpandingLeafIterator<T>

java.lang.Object

com.saperion.common.lang.iterator.ExpandingLeafIterator<T>

Type Parameters:

T - type of objects to iterate

All Implemented Interfaces:

Iterator<T>

public final class ExpandingLeafIterator<T>
extends Object
implements Iterator<T>

An ExpandingLeafIterator iterates through the leaf nodes of a virtual two level data structure.

It iterates through the objects of the specified main iterator. For each such main level object a call to the specified IteratorResolver is executed to get an iterator for the optional virtual sub elements. If such an iterator is found, all the sub elements will be iterated through. Only if no such iterator is found the object of the main level will be returned.

ATTENTION: If a sub-level iterator is found but is empty, no elements will be iterated through and the main level object is NOT returned, because there was a valid (but empty) sub level. The main level object is only returned if the IteratorResolver returns null, indicating that there is no sub level for this main object.

Then, the main iterator will step to the next main object and its sub elements and so on.

Iterator.remove() is not supported.

Author:

agz

See Also:

• ExpandingNodeIterator
• ExpandingSubLevelIterator

Constructor Summary

Constructors

Constructor	Description
ExpandingLeafIterator(Iterator<? extends T> iterator, IteratorResolver<T,T> iteratorResolver)	Creates a new ExpandingLeafIterator.

Method Summary

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

Constructor Details

ExpandingLeafIterator

public ExpandingLeafIterator(Iterator<? extends T> iterator,
 IteratorResolver<T,T> iteratorResolver)

Creates a new ExpandingLeafIterator.

The specified iterator and the specified iterator resolver must not be null.

Parameters:

iterator - main level iterator

iteratorResolver - IteratorResolver

See Also:

• class documentation for details

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

remove

public void remove()

Specified by:

remove in interface Iterator<T>

toString

public String toString()

Overrides:

toString in class Object