net.sf.octet.builder
Interface MoleculeBuilder

All Superinterfaces:

RepresentationBuilder

All Known Implementing Classes:

BasicMoleculeBuilder

public interface MoleculeBuilder

extends RepresentationBuilder

A builder of Octet Molecule representations. MoleculeBuilder extends the RepresentationBuilder interface by enabling clients to get a fully-functional Octet Molecule through releaseMolecule.

Author:

Richard Apodaca

See Also:

"Builder Pattern (GoF95)", RepresentationKit, RepresentationBuilder

Method Summary

Molecule

releaseMolecule() Returns the Molecule that was constructed.

Methods inherited from interface net.sf.octet.builder.RepresentationBuilder

addAtom, addBondingSystem, addConfiguration, addElectron, addGammaSequence, addHalfPlane, addHalfPlane, addHydrogens, addOrbital, connect, connect, constrainCenter, constrainLower, constrainUpper, flush, ionizeAntibondingElectrons, ionizeAtom, ionizeBondingElectrons

Method Detail

releaseMolecule

public Molecule releaseMolecule()

Returns the Molecule that was constructed. All further use of this MoleculeBuilder will refer to a new Molecule under construction.

Returns:

the Molecule under construction

Throws:

IllegalRepresentationException - if the representation under construction does not represent a valid Molecule