cetus.hir

Class PostOrderIterator<E extends Traversable>

java.lang.Object

cetus.hir.IRIterator<E>

cetus.hir.PostOrderIterator<E>

All Implemented Interfaces:

java.util.Iterator<E>

public class PostOrderIterator<E extends Traversable>
extends IRIterator<E>

Peforms a post-order traversal over a Traversable object. This type of traversal usually requires larger internal storage space than DepthFirstIterator or BreadthFirstIterator does since it needs to store all the visited objects while reaching the first element to be visited which is usually a leaf node.

Constructor Summary

Constructors

Constructor and Description
PostOrderIterator(Traversable root) Creates a new iterator with the specified root object.
PostOrderIterator(Traversable root, java.lang.Class<? extends Traversable>[] pruned_on) Creates a new iterator with the specified root object and the array of classes that needs to be pruned on.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Unlike the reset method, clear method also clears the pruned types.
boolean	hasNext() Returns true if the iteration has more elements.
E	next() Returns the next element in the iteration.
void	pruneOn(java.lang.Class<? extends Traversable> c) Disables traversal from an object having the specified type.
void	reset() Resets the iterator by setting the current position to the root object.

Methods inherited from class cetus.hir.IRIterator

next, next, nextExcept, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PostOrderIterator

public PostOrderIterator(Traversable root)

Creates a new iterator with the specified root object.

Parameters:

root - The root object for the traversal.

PostOrderIterator

public PostOrderIterator(Traversable root,
                 java.lang.Class<? extends Traversable>[] pruned_on)

Creates a new iterator with the specified root object and the array of classes that needs to be pruned on.

Parameters:

root - The root object for the traversal.

pruned_on - The list of object types to be pruned on.

Method Detail

hasNext

public boolean hasNext()

Description copied from class: IRIterator

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

Specified by:

hasNext in interface java.util.Iterator<E extends Traversable>

Specified by:

hasNext in class IRIterator<E extends Traversable>

Returns:

true if the iterator has more elements.

next

public E next()

Description copied from class: IRIterator

Returns the next element in the iteration.

Specified by:

next in interface java.util.Iterator<E extends Traversable>

Specified by:

next in class IRIterator<E extends Traversable>

Returns:

the next element in the iteration.

pruneOn

public void pruneOn(java.lang.Class<? extends Traversable> c)

Disables traversal from an object having the specified type. For example, if traversal reaches an object with type c, it does not visit the children of the object.

Parameters:

c - the object type to be pruned on.

reset

public void reset()

Resets the iterator by setting the current position to the root object. The pruned types are not cleared.

Specified by:

reset in class IRIterator<E extends Traversable>

clear

public void clear()

Unlike the reset method, clear method also clears the pruned types.