Module org.jgrapht.core
Package org.jgrapht.traverse

Interface GraphIterator<V,E>

Type Parameters:
V - the graph vertex type
E - the graph edge type
All Superinterfaces:
Iterator<V>
All Known Implementing Classes:
AbstractGraphIterator, BreadthFirstIterator, ClosestFirstIterator, CrossComponentIterator, DegeneracyOrderingIterator, DepthFirstIterator, LexBreadthFirstIterator, MaximumCardinalityIterator, TopologicalOrderIterator
public interface GraphIterator<V,E> extends Iterator<V>
A graph iterator.
Author:
Barak Naveh

  • Method Details

    • isCrossComponentTraversal

      boolean isCrossComponentTraversal()
      Test whether this iterator is set to traverse the graph across connected components.
      Returns:
      true if traverses across connected components, otherwise false.

    • 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.

    • 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.

    • addTraversalListener

      void addTraversalListener(TraversalListener<V,E> l)
      Adds the specified traversal listener to this iterator.
      Parameters:
      l - the traversal listener to be added.

    • removeTraversalListener

      void removeTraversalListener(TraversalListener<V,E> l)
      Removes the specified traversal listener from this iterator.
      Parameters:
      l - the traversal listener to be removed.

    • remove

      void remove()
      Unsupported.
      Specified by:
      remove in interface Iterator<V>
      Throws:
      UnsupportedOperationException - always since operation is not supported