Package etomica.atom

Class AtomListFromArray

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<IAtom>

etomica.atom.AtomListFromArray

All Implemented Interfaces:

IAtomList, java.lang.Iterable<IAtom>, java.util.Collection<IAtom>, java.util.List<IAtom>

public class AtomListFromArray
extends java.util.AbstractList<IAtom>
implements IAtomList

AtomSet formed by wrapping an Atom array. Size of array cannot be changed after construction.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AtomListFromArray(int nAtoms)	Wraps a new atom array of the given length.
AtomListFromArray(IAtom[] atoms)	Wraps the given atom array.

Method Summary

Modifier and Type	Method	Description
IAtom	get(int i)	Part of implementation of AtomSet interface.
IAtom[]	getArray()
void	setAtoms(IAtom[] newAtoms)	Copies the atoms in the given array to the wrapped, final array of atoms.
void	setAtoms(IAtomList atomSet)	Copies the atoms in the given atom set to the wrapped array of atoms.
int	size()	Returns the length of the wrapped array.
java.lang.String	toString()

Methods inherited from class java.util.AbstractCollection

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

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 etomica.atom.IAtomList

getAtoms

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

AtomListFromArray

public AtomListFromArray(int nAtoms)

Wraps a new atom array of the given length.

AtomListFromArray

public AtomListFromArray(IAtom[] atoms)

Wraps the given atom array. Subsequent call to getArray will return the array instance given here.

Method Detail

get

public IAtom get(int i)

Part of implementation of AtomSet interface.

Specified by:

get in interface IAtomList

Specified by:

get in interface java.util.List<IAtom>

Specified by:

get in class java.util.AbstractList<IAtom>

Parameters:

i - the index of the desired atom in the list if i is greater than count-1, throws an IllegalArgumentException.

Returns:

the requested atom

getArray

public IAtom[] getArray()

Returns:

the wrapped array of atoms, which is declared final in the class.

setAtoms

public void setAtoms(IAtom[] newAtoms)

Copies the atoms in the given array to the wrapped, final array of atoms.

Throws:

java.lang.IllegalArgumentException - if length of array is not equal to count field of this instance.

java.lang.NullPointerException - if argument is null.

setAtoms

public void setAtoms(IAtomList atomSet)

Copies the atoms in the given atom set to the wrapped array of atoms.

Throws:

java.lang.IllegalArgumentException - if length of array is not equal to count field of this instance.

java.lang.NullPointerException - if argument is null

size

public int size()

Returns the length of the wrapped array.

Specified by:

size in interface java.util.Collection<IAtom>

Specified by:

size in interface IAtomList

Specified by:

size in interface java.util.List<IAtom>

Specified by:

size in class java.util.AbstractCollection<IAtom>

Returns:

the number of atoms in the list

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<IAtom>