Element (singa-structure 0.3.3 API)

java.lang.Object
- de.bioforscher.singa.structure.elements.Element

```
public class Element
extends Object
```
A chemical element or element is a species of atoms having the same number of protons. Generally no elements need to be created since all common elements are deposited statically in the ElementProvider. Each element is basically final. The isotopes and ions can easily be created with the provided methods.

Author:

cl

Constructor Summary

Constructors
Constructor and Description
`Element(String name, String symbol, int protonNumber, double atomicWeight, String electronConfiguration)`
`Element(String name, String symbol, int protonNumber, double atomicWeight, String electronConfiguration, double vanDerWaalsRadius)` Creates a new Element with name, symbol, proton number and atomic weight in `g/mol`.
`Element(String name, String symbol, int protonNumber, javax.measure.Quantity<MolarMass> atomicWeight, String electronConfiguration)` Creates a new Element with name, symbol, proton number and atomic weight.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Element`	`asAnion(int numberOfElectronsGained)` Converts this element into an ion (anion) by increasing its electron count.
`Element`	`asCation(int numberOfElectronsLost)` Converts this element into an ion (cation) by decreasing its electron count.
`Element`	`asIon(int charge)` Converts this element into an ion (cation) by decreasing its electron count.
`Element`	`asIsotope(int massNumber)` Converts this element into an isotope by adjusting its neutron count.
`boolean`	`equals(Object o)`
`javax.measure.Quantity<MolarMass>`	`getAtomicMass()` Returns the atomic mass.
`int`	`getCharge()` Returns the charge of this Element.
`int`	`getElectronNumber()` Returns the electron number.
`int`	`getMassNumber()`
`String`	`getName()` Returns the name.
`int`	`getNeutronNumber()` Returns the neutron number.
`int`	`getNumberOfPotentialBonds()` Estimates the Number of potential bonds this element forms.
`int`	`getProtonNumber()` Returns the proton number.
`String`	`getSymbol()` Returns the symbol.
`int`	`getValenceElectronNumber()` Returns the number of valence electrons.
`javax.measure.Quantity<javax.measure.quantity.Length>`	`getVanDerWaalsRadius()`
`int`	`hashCode()`
`boolean`	`isAnion()` Returns `true` if this Element is an anion (excess of electrons) and `false` otherwise.
`boolean`	`isCation()` Returns `true` if this Element is an cation (shortage of electrons) and `false` otherwise.
`boolean`	`isIon()` Returns `true` if this Element is an ion and `false` otherwise.
`boolean`	`isIsotope()` Returns `true` if this Element is an isotope and `false` otherwise.
`void`	`setAtomicMass(javax.measure.Quantity<MolarMass> atomicMass)` Sets the atomic mass.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Element
```
public Element(String name,
               String symbol,
               int protonNumber,
               javax.measure.Quantity<MolarMass> atomicWeight,
               String electronConfiguration)
```
    Creates a new Element with name, symbol, proton number and atomic weight.
    
    Parameters:
    
    name - The name.
    
    symbol - The symbol.
    
    protonNumber - The proton number.
    
    atomicWeight - The atomic weight.
    
    electronConfiguration - The electron configuration.
  - Element
```
public Element(String name,
               String symbol,
               int protonNumber,
               double atomicWeight,
               String electronConfiguration,
               double vanDerWaalsRadius)
```
    Creates a new Element with name, symbol, proton number and atomic weight in g/mol.
    
    Parameters:
    
    name - The name.
    
    symbol - The symbol.
    
    protonNumber - The proton number.
    
    atomicWeight - The atomic weight.
    
    electronConfiguration - The electron configuration.
    
    vanDerWaalsRadius - The van der Waals radius.
  - Element
```
public Element(String name,
               String symbol,
               int protonNumber,
               double atomicWeight,
               String electronConfiguration)
```
- Method Detail
  - getName
```
public String getName()
```
    Returns the name.
    
    Returns:
    
    The name.
  - getSymbol
```
public String getSymbol()
```
    Returns the symbol.
    
    Returns:
    
    The symbol.
  - getProtonNumber
```
public int getProtonNumber()
```
    Returns the proton number.
    
    Returns:
    
    The proton number.
  - getAtomicMass
```
public javax.measure.Quantity<MolarMass> getAtomicMass()
```
    Returns the atomic mass.
    
    Returns:
    
    The atomic mass.
  - setAtomicMass
```
public void setAtomicMass(javax.measure.Quantity<MolarMass> atomicMass)
```
    Sets the atomic mass.
    
    Parameters:
    
    atomicMass - The atomic mass.
  - getElectronNumber
```
public int getElectronNumber()
```
    Returns the electron number.
    
    Returns:
    
    The electron number.
  - getValenceElectronNumber
```
public int getValenceElectronNumber()
```
    Returns the number of valence electrons.
    
    Returns:
    
    The number of valence electrons.
  - getNumberOfPotentialBonds
```
public int getNumberOfPotentialBonds()
```
    Estimates the Number of potential bonds this element forms.
    
    Returns:
    
    The number of potential bonds this element forms
  - getNeutronNumber
```
public int getNeutronNumber()
```
    Returns the neutron number.
    
    Returns:
    
    The neutron number.
  - asIon
```
public Element asIon(int charge)
```
    Converts this element into an ion (cation) by decreasing its electron count.
    
    Parameters:
    
    charge - The total charge of this element
    
    Returns:
    
    An cation of this element.
  - asCation
```
public Element asCation(int numberOfElectronsLost)
```
    Converts this element into an ion (cation) by decreasing its electron count.
    
    Parameters:
    
    numberOfElectronsLost - The number of electrons to decrease.
    
    Returns:
    
    An cation of this element.
  - asAnion
```
public Element asAnion(int numberOfElectronsGained)
```
    Converts this element into an ion (anion) by increasing its electron count.
    
    Parameters:
    
    numberOfElectronsGained - The number of electrons gained.
    
    Returns:
    
    An anion of this element.
  - asIsotope
```
public Element asIsotope(int massNumber)
```
    Converts this element into an isotope by adjusting its neutron count.
    
    Parameters:
    
    massNumber - The mass number (number of protons + neutrons).
    
    Returns:
    
    An isotope of this element.
  - isIon
```
public boolean isIon()
```
    Returns true if this Element is an ion and false otherwise.
    
    Returns:
    
    true if this Element is an ion and false otherwise.
  - isAnion
```
public boolean isAnion()
```
    Returns true if this Element is an anion (excess of electrons) and false otherwise.
    
    Returns:
    
    true if this Element is an anion and false otherwise.
  - isCation
```
public boolean isCation()
```
    Returns true if this Element is an cation (shortage of electrons) and false otherwise.
    
    Returns:
    
    true if this Element is an cation and false otherwise.
  - getCharge
```
public int getCharge()
```
    Returns the charge of this Element.
    
    Returns:
    
    The charge of this Element.
  - getMassNumber
```
public int getMassNumber()
```
  - getVanDerWaalsRadius
```
public javax.measure.Quantity<javax.measure.quantity.Length> getVanDerWaalsRadius()
```
  - isIsotope
```
public boolean isIsotope()
```
    Returns true if this Element is an isotope and false otherwise.
    
    Returns:
    
    true if this Element is an isotope and false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Element

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Element

Element

Element

Method Detail

getName

getSymbol

getProtonNumber

getAtomicMass

setAtomicMass

getElectronNumber

getValenceElectronNumber

getNumberOfPotentialBonds

getNeutronNumber

asIon

asCation

asAnion

asIsotope

isIon

isAnion

isCation

getCharge

getMassNumber

getVanDerWaalsRadius

isIsotope

toString

equals

hashCode