MatterImpl (com.hfg API Documentation)

java.lang.Object
- com.hfg.chem.MatterImpl

All Implemented Interfaces:

Matter, java.lang.Cloneable, java.lang.Comparable<MatterImpl>

Direct Known Subclasses:

OrganicMatterImpl
```
public class MatterImpl
extends java.lang.Object
implements Matter, java.lang.Cloneable, java.lang.Comparable<MatterImpl>
```
Elemental composition and mass tracking object for any organic or inorganic molecule.

Constructor Summary

Constructors
Constructor and Description

MatterImpl()

MatterImpl(java.util.Map<Element,java.lang.Float> inMap)

MatterImpl(Matter inInitialValue)

Constructors
Constructor and Description
`MatterImpl()`
`MatterImpl(java.util.Map<Element,java.lang.Float> inMap)`
`MatterImpl(Matter inInitialValue)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatterImpl`	`add(Matter inValue)`
`MatterImpl`	`add(Matter inValue, int inCount)`
`MatterImpl`	`addAtoms(Element inElement, float inNum)`
`MatterImpl`	`addAtoms(Element inElement, int inNum)`
`MatterImpl`	`addElementalComposition(java.util.Map<Element,java.lang.Float> inMap)`
`MatterImpl`	`addElementalComposition(java.util.Map<Element,java.lang.Float> inMap, int inNum)`
`protected void`	`calculateMassFromElementalComposition()`
`void`	`clearCalculatedProperties()`
`void`	`clearElementalComposition()`
`MatterImpl`	`clone()`
`int`	`compareTo(MatterImpl inObj)`
`boolean`	`equals(java.lang.Object inObj)`
`static Matter`	`fromChemicalFormula(java.lang.String inChemicalFormula)`
`java.lang.Double`	`getAverageMass()`
`java.lang.String`	`getChemicalFormula()` Returns a chemical formula String like 'C5H11NO'.
`java.lang.String`	`getChemicalFormulaWithSubscripts()` Returns a chemical formula String like 'C₅H₁₁NO'.
`java.util.Map<Element,java.lang.Float>`	`getElementalComposition()` Returns the elemental composition as an unmodifiable Map.
`java.lang.Double`	`getMonoisotopicMass()`
`int`	`hashCode()`
`protected boolean`	`massesAreUserSet()`
`MatterImpl`	`remove(Matter inValue)`
`MatterImpl`	`remove(Matter inValue, int inCount)`
`MatterImpl`	`setAverageMass(java.lang.Double inValue)` If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.
`void`	`setElementalComposition(java.util.Map<Element,java.lang.Float> inMap)`
`MatterImpl`	`setMonoisotopicMass(java.lang.Double inValue)` If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.

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

- Constructor Detail
  - MatterImpl
```
public MatterImpl()
```
  - MatterImpl
```
public MatterImpl(java.util.Map<Element,java.lang.Float> inMap)
```
  - MatterImpl
```
public MatterImpl(Matter inInitialValue)
```
- Method Detail
  - fromChemicalFormula
```
public static Matter fromChemicalFormula(java.lang.String inChemicalFormula)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object inObj)
```
    Overrides:
    
    equals in class java.lang.Object
  - compareTo
```
public int compareTo(MatterImpl inObj)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<MatterImpl>
  - setElementalComposition
```
public void setElementalComposition(java.util.Map<Element,java.lang.Float> inMap)
```
  - clearElementalComposition
```
public void clearElementalComposition()
```
  - addElementalComposition
```
public MatterImpl addElementalComposition(java.util.Map<Element,java.lang.Float> inMap)
```
  - addElementalComposition
```
public MatterImpl addElementalComposition(java.util.Map<Element,java.lang.Float> inMap,
                                          int inNum)
```
  - add
```
public MatterImpl add(Matter inValue)
```
  - add
```
public MatterImpl add(Matter inValue,
                      int inCount)
```
  - remove
```
public MatterImpl remove(Matter inValue)
```
  - remove
```
public MatterImpl remove(Matter inValue,
                         int inCount)
```
  - addAtoms
```
public MatterImpl addAtoms(Element inElement,
                           int inNum)
```
  - addAtoms
```
public MatterImpl addAtoms(Element inElement,
                           float inNum)
```
  - setMonoisotopicMass
```
public MatterImpl setMonoisotopicMass(java.lang.Double inValue)
```
    If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.
    
    Parameters:
    
    inValue - the mass to use as the monoisotopic mass for this object
    
    Returns:
    
    this OrganicMatterImpl object to enable method chaining
  - setAverageMass
```
public MatterImpl setAverageMass(java.lang.Double inValue)
```
    If the elemental composition is known, use setElementalComposition() and the masses will be derived automatically; this method is for use in those (hopefully) rare times when the mass is known but not the elemental composition.
    
    Parameters:
    
    inValue - the mass to use as the average mass for this object
    
    Returns:
    
    this OrganicMatterImpl object to enable method chaining
  - getMonoisotopicMass
```
public java.lang.Double getMonoisotopicMass()
```
    Specified by:
    
    getMonoisotopicMass in interface Matter
  - getAverageMass
```
public java.lang.Double getAverageMass()
```
    Specified by:
    
    getAverageMass in interface Matter
  - getElementalComposition
```
public java.util.Map<Element,java.lang.Float> getElementalComposition()
```
    Returns the elemental composition as an unmodifiable Map.
    
    Specified by:
    
    getElementalComposition in interface Matter
    
    Returns:
    
    Map containing the elemental composition
  - getChemicalFormula
```
public java.lang.String getChemicalFormula()
```
    Returns a chemical formula String like 'C5H11NO'. If carbon is present, it is listed first followed by the other elements in ascending mass order. Symbols for isotopes are enclosed in square brackets such as '[2H]2O' for deuterated water.
    
    Returns:
    
    the chemical formula string
  - getChemicalFormulaWithSubscripts
```
public java.lang.String getChemicalFormulaWithSubscripts()
```
    Returns a chemical formula String like 'C₅H₁₁NO'. If carbon is present, it is listed first followed by the other elements in ascending mass order. Symbols for isotopes are enclosed in square brackets such as '[²H]₂O' for deuterated water.
    
    Returns:
    
    the chemical formula string
  - clone
```
public MatterImpl clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - clearCalculatedProperties
```
public void clearCalculatedProperties()
```
  - calculateMassFromElementalComposition
```
protected void calculateMassFromElementalComposition()
```
  - massesAreUserSet
```
protected boolean massesAreUserSet()
```

Class MatterImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MatterImpl

MatterImpl

MatterImpl

Method Detail

fromChemicalFormula

hashCode

equals

compareTo

setElementalComposition

clearElementalComposition

addElementalComposition

addElementalComposition

add

add

remove

remove

addAtoms

addAtoms

setMonoisotopicMass

setAverageMass

getMonoisotopicMass

getAverageMass

getElementalComposition

getChemicalFormula

getChemicalFormulaWithSubscripts

clone

clearCalculatedProperties

calculateMassFromElementalComposition

massesAreUserSet