joelib.util.iterator
Class RingIterator

java.lang.Object
  joelib.util.iterator.VectorIterator
      joelib.util.iterator.RingIterator

All Implemented Interfaces:

Cloneable, Iterator

public class RingIterator

extends VectorIterator

Gets an iterator over all rings in a molecule.

 RingIterator rit = mol.getRingIterator();
 JOERing ring;
 while(rit.hasNext())
 {
   ring = rit.nextRing();

 }
 

See Also:

VectorIterator, JOEMol.getRingIterator()

Author:

Jörg Kurt Wegner (wegnerj at informatik.uni-tuebingen.de) at the Department of Cognitive Systems

CVS Version:

Revision: 1.8Date: 2004/07/25 20:43:29source code (CVS head)

License:

Licensed under the terms of the GNU General Public License (GPL).

Constructor Summary

RingIterator(Vector v)
Constructor for the RingIterator object

Method Summary

JOERing

nextRing() Description of the Method

Methods inherited from class joelib.util.iterator.VectorIterator

actual, actualIndex, clone, hasNext, insert, next, remove, reset, setActualIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

RingIterator

public RingIterator(Vector v)

Constructor for the RingIterator object

Parameters:

v - Description of the Parameter

Method Detail

nextRing

public JOERing nextRing()

Description of the Method

Returns:

Description of the Return Value