org.jgrapht.traverse

Class CrossComponentIterator<V,E,D>

java.lang.Object

org.jgrapht.traverse.AbstractGraphIterator<V,E>

org.jgrapht.traverse.CrossComponentIterator<V,E,D>

Type Parameters:

V - vertex type

E - edge type

D - type of data associated to seen vertices

All Implemented Interfaces:

java.util.Iterator<V>, GraphIterator<V,E>

Direct Known Subclasses:

BreadthFirstIterator, ClosestFirstIterator, DepthFirstIterator, TopologicalOrderIterator

public abstract class CrossComponentIterator<V,E,D>
extends AbstractGraphIterator<V,E>

Provides a cross-connected-component traversal functionality for iterator subclasses.

Since:

Jan 31, 2004

Constructor Summary

Constructors

Constructor and Description
CrossComponentIterator(Graph<V,E> g, V startVertex) Creates a new iterator for the specified graph.

Method Summary

Modifier and Type	Method and Description
Graph<V,E>	getGraph()
boolean	hasNext()
V	next()

Methods inherited from class org.jgrapht.traverse.AbstractGraphIterator

addTraversalListener, isCrossComponentTraversal, isReuseEvents, remove, removeTraversalListener, setCrossComponentTraversal, setReuseEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

CrossComponentIterator

public CrossComponentIterator(Graph<V,E> g,
                              V startVertex)

Creates a new iterator for the specified graph. Iteration will start at the specified start vertex. If the specified start vertex is null, Iteration will start at an arbitrary graph vertex.

Parameters:

g - the graph to be iterated.

startVertex - the vertex iteration to be started.

Throws:

java.lang.IllegalArgumentException - if g==null or does not contain startVertex

Method Detail

getGraph

public Graph<V,E> getGraph()

Returns:

the graph being traversed

hasNext

public boolean hasNext()

See Also:

Iterator.hasNext()

next

public V next()

See Also:

Iterator.next()