Package etomica.molecule.iterator

Class MoleculeIteratorArrayList

java.lang.Object

etomica.molecule.iterator.MoleculeIteratorArrayListSimple

etomica.molecule.iterator.MoleculeIteratorArrayList

All Implemented Interfaces:

AtomsetIterator, MoleculeIterator, MoleculeIteratorMoleculeDependent, MoleculesetIterator

public class MoleculeIteratorArrayList
extends MoleculeIteratorArrayListSimple
implements MoleculeIteratorMoleculeDependent

An atom iterator of the elements from an AtomArrayList (in proper sequence). Iterator will fail if element are added to or removed from list while iteration is proceeding.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	upListNow

Fields inherited from class etomica.molecule.iterator.MoleculeIteratorArrayListSimple

atomSetSinglet, cursor, list

Constructor Summary

Constructors

Constructor	Description
MoleculeIteratorArrayList(IteratorDirective.Direction direction, int numToSkip, MoleculeToIndex atomToIndex, MoleculeToMoleculeList atomToAtomSet)

Method Summary

Modifier and Type	Method	Description
IMolecule	nextMolecule()	Returns the next iterate and advances the iterator.
void	reset()	Puts iterator in state ready to begin iteration.
void	setMolecule(IMolecule atom)	Sets the first atom for iteration.
int	size()	Returns the number of iterates that would be given by this iterator if reset with the current list.
void	unset()	Puts iterator in state in which hasNext is false.

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody

Methods inherited from class etomica.molecule.iterator.MoleculeIteratorArrayListSimple

nBody, next, setList

Methods inherited from interface etomica.molecule.iterator.MoleculesetIterator

next

Methods inherited from class java.lang.Object

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

Field Detail

upListNow

protected final boolean upListNow

Constructor Detail

MoleculeIteratorArrayList

public MoleculeIteratorArrayList(IteratorDirective.Direction direction,
                                 int numToSkip,
                                 MoleculeToIndex atomToIndex,
                                 MoleculeToMoleculeList atomToAtomSet)

Method Detail

nextMolecule

public IMolecule nextMolecule()

Returns the next iterate and advances the iterator.

Specified by:

nextMolecule in interface MoleculeIterator

Overrides:

nextMolecule in class MoleculeIteratorArrayListSimple

size

public int size()

Returns the number of iterates that would be given by this iterator if reset with the current list.

Specified by:

size in interface AtomsetIterator

Overrides:

size in class MoleculeIteratorArrayListSimple

reset

public void reset()

Puts iterator in state ready to begin iteration.

Specified by:

reset in interface AtomsetIterator

Overrides:

reset in class MoleculeIteratorArrayListSimple

unset

public void unset()

Description copied from class: MoleculeIteratorArrayListSimple

Puts iterator in state in which hasNext is false.

Specified by:

unset in interface AtomsetIterator

Overrides:

unset in class MoleculeIteratorArrayListSimple

setMolecule

public void setMolecule(IMolecule atom)

Sets the first atom for iteration. Iteration proceeds from this atom up and/or down the list, depending on how iterator was configured at construction.

Specified by:

setMolecule in interface MoleculeIteratorMoleculeDependent