ilog.views.util.collections

Class IlvPreorderIterator<E>

java.lang.Object

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

All Implemented Interfaces:

Iterator<E>

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

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

Since:

JViews 5.5

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvPreorderIterator() Constructs a new IlvPreorderIterator without initializing it.
	IlvPreorderIterator(E root) Constructs a new IlvPreorderIterator 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) Returns an iterator over the child nodes of the specified parent object.
boolean	hasNext() Returns whether the iteration has more elements.
protected void	init(E root) Initializes the iterator to traverse the subtree of objects that descends from the specified root.
protected void	initTraversalStack() Deprecated. Beginning with Rogue Wave JViews 7.5, override the init(E) method instead in order to customize iterator initialization.
E	next() Returns the next element in the iteration.
void	remove() Removes 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

IlvPreorderIterator

public IlvPreorderIterator(E root)

Constructs a new IlvPreorderIterator that starts traversing the subtree of objects that descends from the specified root.

Parameters:

root - The root of the subtree that the iterator will traverse, or null to denote an empty tree leading to an empty iterator.

IlvPreorderIterator

protected IlvPreorderIterator()

Constructs a new IlvPreorderIterator without initializing it. This constructor is provided as a convenience for subclasses that must perform specialized initialization. Therefore, if your iterator implementation invokes this constructor, you must explicitly invoke the init(E) method.

Since:

JViews 7.5

Method Detail

init

protected void init(E root)

Initializes the iterator to traverse the subtree of objects that descends from the specified root. This method is invoked by the constructor and can be overridden by subclasses to add additional initialization. Overrides of this method must call super.

Parameters:

root - The root of the subtree that the iterator will traverse, or null to denote an empty tree leading to an empty iterator.

Since:

JViews 7.5

initTraversalStack

@Deprecated
protected void initTraversalStack()

Deprecated. Beginning with Rogue Wave JViews 7.5, override the init(E) method instead in order to customize iterator initialization.

Initializes the iterator traversal stack.

getChildren

protected abstract Iterator<E> getChildren(E parent)

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

Parameters:

parent - The parent object.

Returns:

An iterator over parent's children.

hasNext

public boolean hasNext()

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

Specified by:

hasNext in interface Iterator<E>

Returns:

Whether the iteration has more elements.

next

public E next()

Returns 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()

Removes 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>