Package etomica.atom

Interface IAtomList

All Superinterfaces:

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

All Known Implementing Classes:

AtomArrayList, AtomListFromArray, AtomPair, AtomSetSinglet

public interface IAtomList
extends java.util.List<IAtom>

Interface for a list of IAtoms. The IAtomList might contain 0, 1, 2 or many IAtoms.

Method Summary

Modifier and Type	Method	Description
IAtom	get(int i)	Returns the i-th atom, with numbering beginning from 0.
default java.util.List<IAtom>	getAtoms()
int	size()

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

Method Detail

get

IAtom get(int i)

Returns the i-th atom, with numbering beginning from 0.

Specified by:

get in interface java.util.List<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

size

int size()

Specified by:

size in interface java.util.Collection<IAtom>

Specified by:

size in interface java.util.List<IAtom>

Returns:

the number of atoms in the list

getAtoms

default java.util.List<IAtom> getAtoms()