cetus.hir

Class BreadthFirstIterator<E extends Traversable>

java.lang.Object

cetus.hir.IRIterator<E>

cetus.hir.BreadthFirstIterator<E>

All Implemented Interfaces:

java.util.Iterator<E>

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

Iterates over Traversable objects in breadth-first order.

Constructor Summary

Constructors

Constructor and Description
BreadthFirstIterator(Traversable init) Creates a new iterator with the specified initial object and the optional list of pruned types.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Unlike the reset method, clear method also clears the pruned types.
java.util.LinkedList	getList(java.lang.Class<? extends Traversable> c) Returns a linked list of objects of Class c in the IR
java.util.Set	getSet(java.lang.Class<? extends Traversable> c) Returns a set of objects of Class c in the IR
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

BreadthFirstIterator

public BreadthFirstIterator(Traversable init)

Creates a new iterator with the specified initial object and the optional list of pruned types.

Parameters:

init - The first object to visit.

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.

getList

public java.util.LinkedList getList(java.lang.Class<? extends Traversable> c)

Returns a linked list of objects of Class c in the IR

Parameters:

c - the object type to be collected.

Returns:

the collected list.

getSet

public java.util.Set getSet(java.lang.Class<? extends Traversable> c)

Returns a set of objects of Class c in the IR

Parameters:

c - the object type to be collected.

Returns:

the collected set.

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.