cetus.hir

Class IRIterator<E extends Traversable>

java.lang.Object

cetus.hir.IRIterator<E>

All Implemented Interfaces:

java.util.Iterator<E>

Direct Known Subclasses:

BreadthFirstIterator, DepthFirstIterator, DFIterator, FlatIterator, PostOrderIterator

public abstract class IRIterator<E extends Traversable>
extends java.lang.Object
implements java.util.Iterator<E>

An iterator implementing this interface supports special versions of next.

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	hasNext() Returns true if the iteration has more elements.
abstract E	next() Returns the next element in the iteration.
E	next(java.lang.Class<? extends Traversable> c) Returns the next element in the iteration that is an instance of a certain class.
E	next(java.util.Set s) Returns the next element in the iteration that is an instance of a class in the set.
E	nextExcept(java.util.Set s) Returns the next element in the iteration that is not an instance of a class in the set.
void	remove() This operation is not supported.
abstract void	reset() Moves the iterator back to the beginning of the sequence.

Methods inherited from class java.lang.Object

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

Method Detail

hasNext

public abstract boolean hasNext()

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>

Returns:

true if the iterator has more elements.

next

public abstract E next()

Returns the next element in the iteration.

Specified by:

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

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - if there is no element left.

next

public E next(java.lang.Class<? extends Traversable> c)
                           throws java.util.NoSuchElementException

Returns the next element in the iteration that is an instance of a certain class.

Parameters:

c - The class of which the next element must be a instance.

Returns:

the next element that is of class c.

Throws:

java.util.NoSuchElementException - if there are no elements of class c.

next

public E next(java.util.Set s)
                           throws java.util.NoSuchElementException

Returns the next element in the iteration that is an instance of a class in the set.

Parameters:

s - A set of classes of which the next element must be an instance.

Returns:

the next element that is an instance of a class in s.

Throws:

java.util.NoSuchElementException - if there are no elements of classes in s.

nextExcept

public E nextExcept(java.util.Set s)
                                 throws java.util.NoSuchElementException

Returns the next element in the iteration that is not an instance of a class in the set.

Parameters:

s - A set of classes of which the next element must not be an instance.

Returns:

the next element that is not an instance of a class in s.

Throws:

java.util.NoSuchElementException - if there are no elements that are not of classes in s.

remove

public void remove()

This operation is not supported.

Specified by:

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

reset

public abstract void reset()

Moves the iterator back to the beginning of the sequence.