The Octet Molecular Representation Framework v0.8.2

net.sf.octet.model
Class BasicOrbital

java.lang.Object
  extended bynet.sf.octet.collection.BasicElectronCollection
      extended bynet.sf.octet.model.BasicOrbital
All Implemented Interfaces:
ElectronCollection, Orbital

public class BasicOrbital
extends BasicElectronCollection
implements Orbital

A default implementation of the Orbital interface. BasicOrbital extends BasicElectronCollection by ensuring that the Orbital contract is honored.

Author:
Richard Apodaca

Constructor Summary
BasicOrbital()
          Constructs an empty, fully functional BasicOrbital.
BasicOrbital(java.util.Collection electrons)
          Constructs a fully functional BasicOrbital from the specified Collection containing Electrons.
BasicOrbital(Electron[] electrons)
          Constructs a fully functional BasicOrbital from the specified array containing Electrons.
 
Methods inherited from class net.sf.octet.collection.BasicElectronCollection
containsElectron, countElectrons, getElectron, getElectronIndex, iterateElectrons, toElectronArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.octet.collection.ElectronCollection
containsElectron, countElectrons, getElectron, getElectronIndex, iterateElectrons, toElectronArray
 

Constructor Detail

BasicOrbital

public BasicOrbital()
Constructs an empty, fully functional BasicOrbital.


BasicOrbital

public BasicOrbital(java.util.Collection electrons)
Constructs a fully functional BasicOrbital from the specified Collection containing Electrons.

Parameters:
electrons - the Collection containing Electrons
Throws:
IllegalRepresentationException - if electrons violates the Orbital contract

BasicOrbital

public BasicOrbital(Electron[] electrons)
Constructs a fully functional BasicOrbital from the specified array containing Electrons.

Parameters:
electrons - the array containing Electrons
Throws:
IllegalRepresentationException - if electrons violates the Orbital contract

The Octet Molecular Representation Framework v0.8.2