net.sf.octet.model
Interface Nucleus

public interface Nucleus

A representation of a nucleus. Nuclei may or may not be shared among Atoms as Flyweights. Because there is no way to determine which allocation system is in use, comparison of two Nucleus objects should be made with Object.equals() rather than operator ==.

Author:

Richard Apodaca

See Also:

"Flyweight Pattern [GoF95]"

Method Summary

int	countProtons() Returns the atomic number of this Nucleus.
int	getMassNumber() Returns the mass number of this Nucleus.

Method Detail

countProtons

public int countProtons()

Returns the atomic number of this Nucleus. This value will be an integer greater than 0.

Returns:

the atomic number of this Nucleus

getMassNumber

public int getMassNumber()

Returns the mass number of this Nucleus. This value will be an integer greater than 0.

Returns:

the mass number of this Nucleus