Package etomica.box

Class AtomSetAllMolecules

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<IMolecule>

etomica.box.AtomSetAllMolecules

All Implemented Interfaces:

IMoleculeList, java.lang.Iterable<IMolecule>, java.util.Collection<IMolecule>, java.util.List<IMolecule>

public class AtomSetAllMolecules
extends java.util.AbstractList<IMolecule>
implements IMoleculeList

Creates a facade that makes a set of molecule lists look like a single list. This class is configured by calling setMoleculeLists(). This should be called after construction, every time one of the molecule lists in the set is changed by adding or removing a molecule, and when a list is added or removed from the set.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AtomSetAllMolecules()	Constructs an empty list.

Method Summary

Modifier and Type	Method	Description
IMolecule	get(int i)	Returns the i-th molecule, with numbering beginning from 0.
void	setMoleculeLists(IMoleculeList[] newMoleculeLists)	Configures this list based on the given array of lists.
int	size()

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AtomSetAllMolecules

public AtomSetAllMolecules()

Constructs an empty list. Subsequent call to setMoleculeLists() is needed to configure this list.

Method Detail

get

public IMolecule get(int i)

Description copied from interface: IMoleculeList

Returns the i-th molecule, with numbering beginning from 0. If i is greater than count-1, throws an IllegalArgumentException.

Specified by:

get in interface IMoleculeList

Specified by:

get in interface java.util.List<IMolecule>

Specified by:

get in class java.util.AbstractList<IMolecule>

Parameters:

i - specification of the desired molecule.

Returns:

a molecule as ordered by the species and then the molecules within the species.

Throws:

java.lang.IndexOutOfBoundsException - if i >= getMoleculeCount() or i < 0

size

public int size()

Specified by:

size in interface java.util.Collection<IMolecule>

Specified by:

size in interface IMoleculeList

Specified by:

size in interface java.util.List<IMolecule>

Specified by:

size in class java.util.AbstractCollection<IMolecule>

Returns:

total number of molecules in the list.

setMoleculeLists

public void setMoleculeLists(IMoleculeList[] newMoleculeLists)

Configures this list based on the given array of lists. The ordering of this list is obtained by concatenating the given lists.

Parameters:

newMoleculeLists - lists of molecules that form this list.