Package org.openscience.cdk.silent

Class ElectronContainer

java.lang.Object

org.openscience.cdk.silent.ChemObject

org.openscience.cdk.silent.ElectronContainer

All Implemented Interfaces:

Serializable, Cloneable, ICDKObject, IChemObject, IElectronContainer

Direct Known Subclasses:

Bond, LonePair, SingleElectron

public class ElectronContainer
extends ChemObject
implements Serializable, IElectronContainer, Cloneable

Base class for entities containing electrons, like bonds, orbitals, lone-pairs.

See Also:

Serialized Form

Source code:

main

Belongs to CDK module:

silent

Keywords:

orbital, lone-pair, bond

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	electronCount	Number of electrons in the ElectronContainer.

Constructor Summary

Constructors

Constructor	Description
ElectronContainer()	Constructs an empty ElectronContainer.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clones this IChemObject.
Integer	getElectronCount()	Returns the number of electrons in this electron container.
void	setElectronCount(Integer electronCount)	Sets the number of electrons in this electron container.
String	toString()	Returns a one line description of this IChemObject.

Methods inherited from class org.openscience.cdk.silent.ChemObject

addListener, addProperties, compare, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openscience.cdk.interfaces.ICDKObject

getBuilder

Methods inherited from interface org.openscience.cdk.interfaces.IChemObject

addListener, addProperties, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty

Field Detail

electronCount

protected Integer electronCount

Number of electrons in the ElectronContainer.

Constructor Detail

ElectronContainer

public ElectronContainer()

Constructs an empty ElectronContainer.

Method Detail

getElectronCount

public Integer getElectronCount()

Returns the number of electrons in this electron container.

Specified by:

getElectronCount in interface IElectronContainer

Returns:

The number of electrons in this electron container.

See Also:

setElectronCount(java.lang.Integer)

setElectronCount

public void setElectronCount(Integer electronCount)

Sets the number of electrons in this electron container.

Specified by:

setElectronCount in interface IElectronContainer

Parameters:

electronCount - The number of electrons in this electron container.

See Also:

getElectronCount()

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: ChemObject

Clones this IChemObject. It clones the identifier, flags, properties and pointer vectors. The ChemObjectListeners are not cloned, and neither is the content of the pointer vectors.

Specified by:

clone in interface IChemObject

Overrides:

clone in class ChemObject

Returns:

The cloned object

Throws:

CloneNotSupportedException - if the IChemObject cannot be cloned

toString

public String toString()

Description copied from interface: IChemObject

Returns a one line description of this IChemObject.

Specified by:

toString in interface IChemObject

Overrides:

toString in class Object

Returns:

a String representation of this object