com.hfg.units.AmountOfSubstanceUnit Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation

com.hfg xml, html, svg, and bioinformatics utility library

There is a newer version: 20240423

package com.hfg.units;


import java.util.HashMap;
import java.util.Map;

import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 Enumeration of amount of substance units.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class AmountOfSubstanceUnit extends Unit
{
   private static Map sLookupMap = new HashMap<>();

   public static final AmountOfSubstanceUnit mole            = new AmountOfSubstanceUnit(MeasurementSystem.SI, "mole", "mol");
   /**
    * The mole equivalents of an acid or base is determined by calculating the number of H+ or OH- ions per molecule.
    */
   public static final AmountOfSubstanceUnit mole_equivalent = new AmountOfSubstanceUnit(MeasurementSystem.SI, "mole equivalent", "");


   //---------------------------------------------------------------------------
   private AmountOfSubstanceUnit(MeasurementSystem inSystem, String inName, String inAbbrev)
   {
      super(inSystem, QuantityType.AMOUNT_OF_SUBSTANCE, inName, inAbbrev);

      sLookupMap.put(name(), this);
      sLookupMap.put(getAbbrev(), this);
   }



   //---------------------------------------------------------------------------
   public static AmountOfSubstanceUnit valueOf(String inString)
   {
      return StringUtil.isSet(inString) ? sLookupMap.get(inString) : null;
   }

}