Package chemaxon.struc

Class IteratorFactory.NeighbourIterator<E>

java.lang.Object
chemaxon.struc.IteratorFactory.NeighbourIterator<E>
All Implemented Interfaces:
Iterator<E>
Direct Known Subclasses:
IteratorFactory.AtomNeighbourIterator, IteratorFactory.BondNeighbourIterator
Enclosing class:
IteratorFactory
@Deprecated(forRemoval=true) @SubjectToRemoval(date=JUL_01_2027) public abstract class IteratorFactory.NeighbourIterator<E> extends Object implements Iterator<E>
Deprecated, for removal: This API element is subject to removal in a future version.
The NeighbourIterator class provides an iterator to process the bonds connecting to the specified atom according to the atom and bond related behavior of this factory.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected MolAtom
    atom
    Deprecated, for removal: This API element is subject to removal in a future version.
    The atom whose the neighbours are processed.
    protected int
    currentBond
    Deprecated, for removal: This API element is subject to removal in a future version.
    Current bond pointer of the iterator.
    protected List<MolBond>
    secondaryBonds
    Deprecated, for removal: This API element is subject to removal in a future version.
    Secondary bonds that replace a coordinate bond to the multicenter with coordinate bonds from the metal to the represented atoms (in the MulticenterSgroup of the multicenter).

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    NeighbourIterator(MolAtom atom)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs an iterator to process the bonds connecting to the specified atom.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final MolBond
    getBond(int index)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a bond of a specified index.
    boolean
    hasNext()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Decides whether the iteration has more element.
    protected final int
    nextBondIndex(int index)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the next bond index in the iteration according to the atom and bond related behavior specified in the factory.
    void
    remove()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The remove operation is not supported by this Iterator implementation.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.Iterator

    forEachRemaining, next

  • Field Details

    • atom

      protected MolAtom atom
      Deprecated, for removal: This API element is subject to removal in a future version.
      The atom whose the neighbours are processed.

    • currentBond

      protected int currentBond
      Deprecated, for removal: This API element is subject to removal in a future version.
      Current bond pointer of the iterator.

    • secondaryBonds

      protected List<MolBond> secondaryBonds
      Deprecated, for removal: This API element is subject to removal in a future version.
      Secondary bonds that replace a coordinate bond to the multicenter with coordinate bonds from the metal to the represented atoms (in the MulticenterSgroup of the multicenter). These secondary bonds are not added to the molecule of the factory, so do not use Molecule.indexOf for the secondary bonds! In the future, secondary bonds may be implemented for other types of connections too.

  • Constructor Details

    • NeighbourIterator

      protected NeighbourIterator(MolAtom atom)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs an iterator to process the bonds connecting to the specified atom. The following bonds are excluded:
      • bonds excluded in the bond related behavior of the factory and
      • bonds connecting to atoms that are excluded in the atom related behavior of the factory.
      Parameters:
      atom - the atom whose bonds to be iterated

  • Method Details

    • getBond

      protected final MolBond getBond(int index)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a bond of a specified index.
      Parameters:
      index - the specified index of the bond
      Returns:
      the bond of the specified index

    • hasNext

      public boolean hasNext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Decides whether the iteration has more element.
      Specified by:
      hasNext in interface Iterator<E>
      Returns:
      true if the iteration has more element, false otherwise.

    • nextBondIndex

      protected final int nextBondIndex(int index)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the next bond index in the iteration according to the atom and bond related behavior specified in the factory.
      Parameters:
      index - the current index to get the subsequent index from
      Returns:
      the subsequent index

    • remove

      public void remove()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The remove operation is not supported by this Iterator implementation.
      Specified by:
      remove in interface Iterator<E>
      Throws:
      UnsupportedOperationException
      See Also: