org.jscience.computing.graph.iterators
Interface GraphIterator

All Superinterfaces:
java.util.Iterator
All Known Implementing Classes:
AbstractGraphIterator, BreadthFirstIterator, ClosestFirstIterator, CrossComponentIterator, DepthFirstIterator, TopologicalOrderIterator

public interface GraphIterator
extends java.util.Iterator

A graph iterator.

Since:
Jul 31, 2003

Method Summary
 void addTraversalListener(TraversalListener l)
          Adds the specified traversal listener to this iterator.
 boolean isCrossComponentTraversal()
          Test whether this iterator is set to traverse the grpah across connected components.
 boolean isReuseEvents()
          Tests whether the reuseEvents flag is set.
 void remove()
          Unsupported.
 void removeTraversalListener(TraversalListener l)
          Removes the specified traversal listener from this iterator.
 void setReuseEvents(boolean reuseEvents)
          Sets a value the reuseEvents flag.
 
Methods inherited from interface java.util.Iterator
hasNext, next
 

Method Detail

isCrossComponentTraversal

boolean isCrossComponentTraversal()
Test whether this iterator is set to traverse the grpah across connected components.

Returns:
true if traverses across connected components, otherwise false.

setReuseEvents

void setReuseEvents(boolean reuseEvents)
Sets a value the reuseEvents flag. If the reuseEvents flag is set to true this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.

Parameters:
reuseEvents - whether to reuse previously fired event objects instead of creating a new event object for each event.

isReuseEvents

boolean isReuseEvents()
Tests whether the reuseEvents flag is set. If the flag is set to true this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.

Returns:
the value of the reuseEvents flag.

addTraversalListener

void addTraversalListener(TraversalListener l)
Adds the specified traversal listener to this iterator.

Parameters:
l - the traversal listener to be added.

remove

void remove()
Unsupported.

Specified by:
remove in interface java.util.Iterator

removeTraversalListener

void removeTraversalListener(TraversalListener l)
Removes the specified traversal listener from this iterator.

Parameters:
l - the traversal listener to be removed.