ilog.views.util.collections

Class IlvBreadthFirstIterator<E>

java.lang.Object

ilog.views.util.collections.IlvBreadthFirstIterator<E>

All Implemented Interfaces:

Iterator<E>

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

IlvBreadthFirstIterator is an abstract class that provides traversal over a generic tree structure of objects in breadth first order. Concrete subclasses must simply provide an implementation of getChildren that properly accounts for the type of nodes being traversed.

Since:

JViews 8.1

Constructor Summary

Constructors

Constructor and Description
IlvBreadthFirstIterator(E root) Construct a new IlvBreadthFirstIterator that starts traversing the subtree of objects that descends from the specified root.

Method Summary

Modifier and Type	Method and Description
protected abstract Iterator<E>	getChildren(E parent) Return an iterator over the child nodes of the specified parent object.
boolean	hasNext() Return whether the iteration has more elements.
E	next() Return the next element in the iteration.
void	remove() Remove from the underlying collection the last object returned by the iterator.

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

IlvBreadthFirstIterator

public IlvBreadthFirstIterator(E root)

Construct a new IlvBreadthFirstIterator that starts traversing the subtree of objects that descends from the specified root.

Method Detail

getChildren

protected abstract Iterator<E> getChildren(E parent)

Return an iterator over the child nodes of the specified parent object.

hasNext

public boolean hasNext()

Return whether the iteration has more elements. (In other words, return true if next() would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<E>

next

public E next()

Return the next element in the iteration.

Specified by:

next in interface Iterator<E>

Returns:

the next element in the iteration.

Throws:

NoSuchElementException - if the iteration has no more elements.

remove

public void remove()

Remove from the underlying collection the last object returned by the iterator. This method can be called only once per call to next.

The method is optional and currently throws an unconditional UnsupportedOperationException.

Specified by:

remove in interface Iterator<E>