Package etomica.molecule.iterator

Class MoleculeIteratorSinglet

java.lang.Object

etomica.molecule.iterator.MoleculeIteratorSinglet

All Implemented Interfaces:

AtomsetIterator, MoleculeIterator, MoleculeIteratorMoleculeDependent, MoleculesetIterator, java.io.Serializable

public final class MoleculeIteratorSinglet
extends java.lang.Object
implements MoleculeIterator, MoleculeIteratorMoleculeDependent, java.io.Serializable

Iterator that expires after returning a single atom, which is specified by a call to the setAtom method, or via the constructor. Subsequent calls to reset() and next() will return the specified atom, until another is specified via setAtom.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MoleculeSetSinglet	atomSetSinglet

Constructor Summary

Constructors

Constructor	Description
MoleculeIteratorSinglet()	Constructs iterator without defining atom.
MoleculeIteratorSinglet(IMolecule a)	Constructs iterator specifying that it return the given atom.

Method Summary

Modifier and Type	Method	Description
IMolecule	getMolecule()
int	nBody()	Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().
IMoleculeList	next()	Returns the next AtomSet iterate, or null if hasNext() is false.
IMolecule	nextMolecule()	Returns the iterator's atom and unsets iterator.
void	reset()	Resets iterator to a state where hasNext is true.
void	setMolecule(IMolecule a)	Defines atom returned by iterator and leaves iterator unset.
int	size()	returns 1 if atom is not null, 0 if atom is null.
void	unset()	Sets iterator to a state where hasNext() returns false.

Methods inherited from class java.lang.Object

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

Field Detail

atomSetSinglet

protected final MoleculeSetSinglet atomSetSinglet

Constructor Detail

MoleculeIteratorSinglet

public MoleculeIteratorSinglet()

Constructs iterator without defining atom. No atoms will be given by this iterator until a call to setAtom is performed.

MoleculeIteratorSinglet

public MoleculeIteratorSinglet(IMolecule a)

Constructs iterator specifying that it return the given atom. Call to reset() must be performed before beginning iteration.

Parameters:

a - The atom that will be returned by this iterator upon reset.

Method Detail

setMolecule

public void setMolecule(IMolecule a)

Defines atom returned by iterator and leaves iterator unset. Call to reset() must be performed before beginning iteration. If atom is null, hasNext will remain false on reset.

Specified by:

setMolecule in interface MoleculeIteratorMoleculeDependent

getMolecule

public IMolecule getMolecule()

Returns:

the atom given by this iterator as its single iterate

size

public int size()

returns 1 if atom is not null, 0 if atom is null.

Specified by:

size in interface AtomsetIterator

unset

public void unset()

Sets iterator to a state where hasNext() returns false.

Specified by:

unset in interface AtomsetIterator

reset

public void reset()

Resets iterator to a state where hasNext is true.

Specified by:

reset in interface AtomsetIterator

nextMolecule

public IMolecule nextMolecule()

Returns the iterator's atom and unsets iterator.

Specified by:

nextMolecule in interface MoleculeIterator

next

public IMoleculeList next()

Description copied from interface: MoleculesetIterator

Returns the next AtomSet iterate, or null if hasNext() is false.

Specified by:

next in interface MoleculesetIterator

nBody

public final int nBody()

Description copied from interface: AtomsetIterator

Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().

Specified by:

nBody in interface AtomsetIterator

Returns: