net.sf.octet.builder
Class AbstractRepresentationBuilder.BondingSystemTemplate

java.lang.Object
  net.sf.octet.builder.AbstractRepresentationBuilder.BondingSystemTemplate

All Implemented Interfaces:

BondingSystemProxy

Enclosing class:

AbstractRepresentationBuilder

protected class AbstractRepresentationBuilder.BondingSystemTemplate

extends java.lang.Object

implements BondingSystemProxy

A template for the construction of represenation-specific bonding systems. Note that this class is not immutable; values returned may differ from those returned by previous or subsequent method invocations.

Author:

Richard Apodaca

Method Summary

boolean	containsAtom(Atom atom) Returns true if atom is shared by this BondingSystemTemplate.
int	countAtomPairs() Returns the number of AtomPairs shared by this BondingSystemTemplate.
int	getAntibondingElectronCount() Returns the number of antibonding electrons owned by this BondingSystemTemplate.
AtomPair	getAtomPair(int index) Returns the AtomPair located at index.
java.util.List	getAtomPairs() Returns an unmodifiable List containing the AtomPairs shared by this BondingSystemTemplate.
int	getBondingElectronCount() Returns the number of bonding electrons owned by this BondingSystemTemplate.

Methods inherited from class java.lang.Object

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

Method Detail

countAtomPairs

public int countAtomPairs()

Returns the number of AtomPairs shared by this BondingSystemTemplate.

Returns:

the number of AtomPairs owned by this BondingSystemTemplate

getAtomPair

public AtomPair getAtomPair(int index)

Returns the AtomPair located at index.

Parameters:

index - the index to query

Returns:

the AtomPair located at index

getAtomPairs

public java.util.List getAtomPairs()

Returns an unmodifiable List containing the AtomPairs shared by this BondingSystemTemplate.

Returns:

an unmodifiable List containing the AtomPairs shared by this BondingSystemTemplate

getBondingElectronCount

public int getBondingElectronCount()

Returns the number of bonding electrons owned by this BondingSystemTemplate.

Returns:

the number of bonding electrons owned by this BondingSystemTemplate

getAntibondingElectronCount

public int getAntibondingElectronCount()

Returns the number of antibonding electrons owned by this BondingSystemTemplate.

Returns:

the number of antibonding electrons owned by this BondingSystemTemplate

containsAtom

public boolean containsAtom(Atom atom)

Returns true if atom is shared by this BondingSystemTemplate.

Parameters:

atom - the Atom to query

Returns:

true if atom is shared by this BondingSystemTemplate