Package etomica.atom

Class AtomPair

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<IAtom>

etomica.atom.AtomPair

All Implemented Interfaces:

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

public final class AtomPair
extends java.util.AbstractList<IAtom>
implements IAtomList, java.util.RandomAccess

Data structure that contains two mutable atom instances.

Field Summary

Fields

Modifier and Type	Field	Description
IAtom	atom0
IAtom	atom1

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AtomPair()
AtomPair(IAtom atom0, IAtom atom1)

Method Summary

Modifier and Type	Method	Description
void	add(int i, IAtom iAtom)
boolean	add(IAtom iAtom)
boolean	addAll(int i, java.util.Collection<? extends IAtom> collection)
boolean	addAll(java.util.Collection<? extends IAtom> collection)
void	clear()
boolean	contains(java.lang.Object o)
boolean	equals(java.lang.Object obj)
IAtom	get(int i)	Returns the i-th atom, with numbering beginning from 0.
int	hashCode()
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<IAtom>	iterator()
IAtom	remove(int i)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> collection)
boolean	retainAll(java.util.Collection<?> collection)
IAtom	set(int i, IAtom iAtom)
int	size()
IAtom[]	toArray()
java.lang.String	toString()

Methods inherited from class java.util.AbstractCollection

containsAll, toArray

Methods inherited from class java.util.AbstractList

lastIndexOf, listIterator, listIterator, removeRange, 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

containsAll, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, replaceAll, sort, spliterator, subList, toArray

Methods inherited from class java.lang.Object

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

Field Detail

atom0

public IAtom atom0

atom1

public IAtom atom1

Constructor Detail

AtomPair

public AtomPair()

AtomPair

public AtomPair(IAtom atom0,
                IAtom atom1)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<IAtom>

Specified by:

equals in interface java.util.List<IAtom>

Overrides:

equals in class java.util.AbstractList<IAtom>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<IAtom>

Specified by:

hashCode in interface java.util.List<IAtom>

Overrides:

hashCode in class java.util.AbstractList<IAtom>

get

public IAtom get(int i)

Description copied from interface: IAtomList

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

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

set

public IAtom set(int i,
                 IAtom iAtom)

Specified by:

set in interface java.util.List<IAtom>

Overrides:

set in class java.util.AbstractList<IAtom>

add

public void add(int i,
                IAtom iAtom)

Specified by:

add in interface java.util.List<IAtom>

Overrides:

add in class java.util.AbstractList<IAtom>

remove

public IAtom remove(int i)

Specified by:

remove in interface java.util.List<IAtom>

Overrides:

remove in class java.util.AbstractList<IAtom>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<IAtom>

Overrides:

indexOf in class java.util.AbstractList<IAtom>

size

public int size()

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<IAtom>

Specified by:

isEmpty in interface java.util.List<IAtom>

Overrides:

isEmpty in class java.util.AbstractCollection<IAtom>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<IAtom>

Specified by:

contains in interface java.util.List<IAtom>

Overrides:

contains in class java.util.AbstractCollection<IAtom>

iterator

public java.util.Iterator<IAtom> iterator()

Specified by:

iterator in interface java.util.Collection<IAtom>

Specified by:

iterator in interface java.lang.Iterable<IAtom>

Specified by:

iterator in interface java.util.List<IAtom>

Overrides:

iterator in class java.util.AbstractList<IAtom>

toArray

public IAtom[] toArray()

Specified by:

toArray in interface java.util.Collection<IAtom>

Specified by:

toArray in interface java.util.List<IAtom>

Overrides:

toArray in class java.util.AbstractCollection<IAtom>

add

public boolean add(IAtom iAtom)

Specified by:

add in interface java.util.Collection<IAtom>

Specified by:

add in interface java.util.List<IAtom>

Overrides:

add in class java.util.AbstractList<IAtom>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<IAtom>

Specified by:

remove in interface java.util.List<IAtom>

Overrides:

remove in class java.util.AbstractCollection<IAtom>

addAll

public boolean addAll(java.util.Collection<? extends IAtom> collection)

Specified by:

addAll in interface java.util.Collection<IAtom>

Specified by:

addAll in interface java.util.List<IAtom>

Overrides:

addAll in class java.util.AbstractCollection<IAtom>

addAll

public boolean addAll(int i,
                      java.util.Collection<? extends IAtom> collection)

Specified by:

addAll in interface java.util.List<IAtom>

Overrides:

addAll in class java.util.AbstractList<IAtom>

removeAll

public boolean removeAll(java.util.Collection<?> collection)

Specified by:

removeAll in interface java.util.Collection<IAtom>

Specified by:

removeAll in interface java.util.List<IAtom>

Overrides:

removeAll in class java.util.AbstractCollection<IAtom>

retainAll

public boolean retainAll(java.util.Collection<?> collection)

Specified by:

retainAll in interface java.util.Collection<IAtom>

Specified by:

retainAll in interface java.util.List<IAtom>

Overrides:

retainAll in class java.util.AbstractCollection<IAtom>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<IAtom>

Specified by:

clear in interface java.util.List<IAtom>

Overrides:

clear in class java.util.AbstractList<IAtom>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<IAtom>