Package chemaxon.util.iterator

Interface MoleculeIterator

All Superinterfaces:
Iterator<Molecule>
@PublicAPI public interface MoleculeIterator extends Iterator<Molecule>
Molecule iterator.
Since:
Marvin 5.1, 08/01/2008

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    estimateProgress()
    Estimates the iteration progress.
    Throwable
    getThrowable()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Not used.
    boolean
    hasNext()
    Tests whether the iteration has more elements.
    Molecule
    next()
    Gets the next molecule.

    Methods inherited from interface java.util.Iterator

    forEachRemaining, remove

  • Method Details

    • next

      Molecule next()
      Gets the next molecule.
      Specified by:
      next in interface Iterator<Molecule>
      Returns:
      the molecule or null at end of file
      Throws:
      NoSuchElementException - if an error occurred, and the next element cannot be returned

    • hasNext

      boolean hasNext()
      Tests whether the iteration has more elements.
      Specified by:
      hasNext in interface Iterator<Molecule>
      Returns:
      true if the iterator has more elements, false if there are no more elements

    • getThrowable

      @Deprecated(forRemoval=true) @SubjectToRemoval(date=JUL_01_2025) Throwable getThrowable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Not used. next() throws NoSuchElementException in case of error.
      Gets the exception which stopped the iteration. It should be called when hasNext() returns false.
      Returns:
      the exception if the iteration was stopped by an error, null if it stopped normally

    • estimateProgress

      double estimateProgress()
      Estimates the iteration progress.
      Returns:
      number between 0 and 1