The Octet Molecular Representation Framework v0.8.2

net.sf.octet.collection
Interface AtomGraphIterator


public interface AtomGraphIterator

An iterator for an AtomGraphCollection. The code fragment below illustrates a typical use:

 
 AtomGraphCollection graphs = ...
 AtomGraphIterator it = graphs.iterateAtomGraphs();
 
 while (it.hasNext())
 {
   AtomGraph graph = it.nextAtomGraph();
 }
 
 

Author:
Richard Apodaca
See Also:
"Iterator Pattern [GoF95]"

Method Summary
 boolean hasNext()
          Returns true if another AtomGraph is available for iteration.
 AtomGraph nextAtomGraph()
          Returns the next AtomGraph.
 

Method Detail

hasNext

public boolean hasNext()
Returns true if another AtomGraph is available for iteration.

Returns:
true if another AtomGraph will be iterated; false otherwise

nextAtomGraph

public AtomGraph nextAtomGraph()
Returns the next AtomGraph.

Returns:
the next AtomGraph
Throws:
NoSuchElementException - if this iterator has no more AtomGraphs

The Octet Molecular Representation Framework v0.8.2