net.sf.octet.collection
Class BasicOrbitalCollection

java.lang.Object
  net.sf.octet.collection.BasicOrbitalCollection

All Implemented Interfaces:

OrbitalCollection

public class BasicOrbitalCollection

extends java.lang.Object

implements OrbitalCollection

A default implementation of the OrbitalCollection interface backed by an ArraySequence.

Author:

Richard Apodaca

Constructor Summary

BasicOrbitalCollection()
Creates an empty BasicOrbitalCollection.

BasicOrbitalCollection(java.util.Collection orbitals)
Constructs a BasicOrbitalCollection from the elements contained in orbitals.

BasicOrbitalCollection(Orbital[] orbitals)
Constructs a BasicOrbitalCollection from the elements contained in orbitals.

Method Summary

boolean	containsOrbital(Orbital orbital) Returns true if the specified Orbital is contained in this collection, and false otherwise.
int	countOrbitals() Returns the number of Orbitals contained in this Orbital collection.
Orbital	getOrbital(int index) Returns the Orbital located at the specified zero-based index.
int	getOrbitalIndex(Orbital orbital) Returns the zero-based index of the specified Orbital.
OrbitalIterator	iterateOrbitals() Returns an iterator over all Orbitals in this collection.
Orbital[]	toOrbitalArray() Returns a copy of the Orbitals contained in this collection as an array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicOrbitalCollection

public BasicOrbitalCollection()

Creates an empty BasicOrbitalCollection.

BasicOrbitalCollection

public BasicOrbitalCollection(java.util.Collection orbitals)

Constructs a BasicOrbitalCollection from the elements contained in orbitals.

Parameters:

orbitals - the collection from which to get Orbitals

Throws:

java.lang.IllegalArgumentException - if electrons contains Objects that do not implement Electron

java.lang.NullPointerException - if electrons contains null

BasicOrbitalCollection

public BasicOrbitalCollection(Orbital[] orbitals)

Constructs a BasicOrbitalCollection from the elements contained in orbitals.

Parameters:

orbitals - the array from which to get Orbitals

Throws:

java.lang.IllegalArgumentException - if orbitals contains Objects that do not implement Orbital

java.lang.NullPointerException - if orbitals contains null

Method Detail

containsOrbital

public boolean containsOrbital(Orbital orbital)

Description copied from interface: OrbitalCollection

Returns true if the specified Orbital is contained in this collection, and false otherwise.

Specified by:

containsOrbital in interface OrbitalCollection

Parameters:

orbital - the Orbital

Returns:

true if contained, false otherwise

countOrbitals

public int countOrbitals()

Description copied from interface: OrbitalCollection

Returns the number of Orbitals contained in this Orbital collection.

Specified by:

countOrbitals in interface OrbitalCollection

Returns:

the number of Orbitals in this collection

getOrbitalIndex

public int getOrbitalIndex(Orbital orbital)

Description copied from interface: OrbitalCollection

Returns the zero-based index of the specified Orbital.

Specified by:

getOrbitalIndex in interface OrbitalCollection

Parameters:

orbital - the Orbital

Returns:

the index of the Orbital, or -1 if this collection does not contain orbital

iterateOrbitals

public OrbitalIterator iterateOrbitals()

Description copied from interface: OrbitalCollection

Returns an iterator over all Orbitals in this collection.

Specified by:

iterateOrbitals in interface OrbitalCollection

Returns:

an iterator over all Orbitals in this collection

getOrbital

public Orbital getOrbital(int index)

Description copied from interface: OrbitalCollection

Returns the Orbital located at the specified zero-based index.

Specified by:

getOrbital in interface OrbitalCollection

Parameters:

index - the index

Returns:

the Orbital at index, or null if the index is invalid

toOrbitalArray

public Orbital[] toOrbitalArray()

Description copied from interface: OrbitalCollection

Returns a copy of the Orbitals contained in this collection as an array. The resulting array may be modified without changing the state of this collection.

Specified by:

toOrbitalArray in interface OrbitalCollection

Returns:

a copy of the Orbital array for this collection