Package org.jgrapht.traverse
Interface GraphIterator<V,E>
-
- Type Parameters:
V
- the graph vertex typeE
- the graph edge type
- All Superinterfaces:
java.util.Iterator<V>
- All Known Implementing Classes:
AbstractGraphIterator
,BreadthFirstIterator
,ClosestFirstIterator
,CrossComponentIterator
,CycleDetector.ProbeIterator
,DepthFirstIterator
,RandomWalkIterator
,TopologicalOrderIterator
public interface GraphIterator<V,E> extends java.util.Iterator<V>
A graph iterator.- Since:
- Jul 31, 2003
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addTraversalListener(TraversalListener<V,E> 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 thereuseEvents
flag is set.void
remove()
Unsupported.void
removeTraversalListener(TraversalListener<V,E> l)
Removes the specified traversal listener from this iterator.void
setReuseEvents(boolean reuseEvents)
Sets a value thereuseEvents
flag.
-
-
-
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, otherwisefalse
.
-
setReuseEvents
void setReuseEvents(boolean reuseEvents)
Sets a value thereuseEvents
flag. If thereuseEvents
flag is set totrue
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 thereuseEvents
flag is set. If the flag is set totrue
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<V,E> 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 interfacejava.util.Iterator<V>
-
removeTraversalListener
void removeTraversalListener(TraversalListener<V,E> l)
Removes the specified traversal listener from this iterator.- Parameters:
l
- the traversal listener to be removed.
-
-