MoleculeIteratorArrayListSimple

java.lang.Object
- etomica.molecule.iterator.MoleculeIteratorArrayListSimple

All Implemented Interfaces:

AtomsetIterator, MoleculeIterator, MoleculesetIterator, java.io.Serializable

Direct Known Subclasses:

MoleculeIteratorAllMolecules, MoleculeIteratorArrayList, MoleculeIteratorMolecule
```
public class MoleculeIteratorArrayListSimple
extends java.lang.Object
implements MoleculeIterator, java.io.Serializable
```
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 MoleculeSetSinglet`	`atomSetSinglet`
`protected int`	`cursor`	Index of element to be returned by subsequent call to next.
`protected IMoleculeList`	`list`

Constructor Summary

Constructors
Constructor	Description
`MoleculeIteratorArrayListSimple()`	Constructs new iterator with an empty list.
`MoleculeIteratorArrayListSimple(IMoleculeList atomList)`	Constructs new iterator set to iterate given list (upon reset).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`nBody()`	Returns 1, indicating that this is an atom iterator.
`IMoleculeList`	`next()`	Same as nextAtom().
`IMolecule`	`nextMolecule()`	Returns the next iterate and advances the iterator.
`void`	`reset()`	Puts iterator in state ready to begin iteration.
`void`	`setList(IMoleculeList atomList)`	Sets the list 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cursor
```
protected int cursor
```
    Index of element to be returned by subsequent call to next.
  - list
```
protected IMoleculeList list
```
  - atomSetSinglet
```
protected final MoleculeSetSinglet atomSetSinglet
```
- Constructor Detail
  - MoleculeIteratorArrayListSimple
```
public MoleculeIteratorArrayListSimple()
```
    Constructs new iterator with an empty list.
  - MoleculeIteratorArrayListSimple
```
public MoleculeIteratorArrayListSimple(IMoleculeList atomList)
```
    Constructs new iterator set to iterate given list (upon reset).
- Method Detail
  - setList
```
public void setList(IMoleculeList atomList)
```
    Sets the list for iteration. Null value will result in a NullPointerException.
  - nBody
```
public int nBody()
```
    Returns 1, indicating that this is an atom iterator.
    
    Specified by:
    
    nBody in interface AtomsetIterator
    
    Returns:
  - unset
```
public void unset()
```
    Puts iterator in state in which hasNext is false.
    
    Specified by:
    
    unset in interface AtomsetIterator
  - nextMolecule
```
public IMolecule nextMolecule()
```
    Returns the next iterate and advances the iterator.
    
    Specified by:
    
    nextMolecule in interface MoleculeIterator
  - next
```
public IMoleculeList next()
```
    Same as nextAtom().
    
    Specified by:
    
    next in interface MoleculesetIterator
  - 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
  - reset
```
public void reset()
```
    Puts iterator in state ready to begin iteration.
    
    Specified by:
    
    reset in interface AtomsetIterator

Class MoleculeIteratorArrayListSimple

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cursor

list

atomSetSinglet

Constructor Detail

MoleculeIteratorArrayListSimple

MoleculeIteratorArrayListSimple

Method Detail

setList

nBody

unset

nextMolecule

next

size

reset