manifold.rt.api.util

Class AbstractIterator<T>

java.lang.Object

manifold.rt.api.util.AbstractIterator<T>

All Implemented Interfaces:

java.util.Iterator<T>

public abstract class AbstractIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

A base class to simplify implementing iterators so that implementations only have to implement [computeNext] to implement the iterator, calling [done] when the iteration is complete.

Constructor Summary

Constructors

Constructor and Description
AbstractIterator()

Method Summary

Modifier and Type	Method and Description
protected abstract void	computeNext() Computes the next item in the iterator.
protected void	done() Sets the state to done so that the iteration terminates.
boolean	hasNext()
T	next()
protected void	setNext(T value) Sets the next value in the iteration, called from the [computeNext] function

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, remove

Constructor Detail

AbstractIterator

public AbstractIterator()

Method Detail

computeNext

protected abstract void computeNext()

Computes the next item in the iterator.

This callback method should call one of these two methods:

* [setNext] with the next value of the iteration * [done] to indicate there are no more elements

Failure to call either method will result in the iteration terminating with a failed state

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

setNext

protected void setNext(T value)

Sets the next value in the iteration, called from the [computeNext] function

done

protected void done()

Sets the state to done so that the iteration terminates.