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

Go to download
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.List;
import java.util.Map;

import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 Enumeration of standard mass 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 MassUnit extends Unit
{
   private static final Map sInstanceMap = new HashMap<>(6);
                                                                                                              // The base SI unit of mass is the kilogram
   public static final MassUnit gram     = new MassUnit(MeasurementSystem.Metric, "gram",    "g");
   public static final MassUnit amu      = new MassUnit(MeasurementSystem.Metric, "atomic mass unit",    "Da", new BaseSIUnitConverter(1.660539040E-24), new SubUnit(MassUnit.gram), new SubUnit(AmountOfSubstanceUnit.mole, -1)).addAlternateName("dalton").addAlternateName("u");
   public static final MassUnit dalton   = MassUnit.amu;
   
   // British Imperial units
   public static final MassUnit ounce     = new MassUnit(MeasurementSystem.BritishImperial, "ounce",    "oz", new BaseSIUnitConverter(453.59237 / 16));
   public static final MassUnit pound     = new MassUnit(MeasurementSystem.BritishImperial, "pound",    "lb", new BaseSIUnitConverter(453.59237));
   public static final MassUnit stone     = new MassUnit(MeasurementSystem.BritishImperial, "stone",    "st", new BaseSIUnitConverter(6350.29318));

   //---------------------------------------------------------------------------
   private MassUnit(MeasurementSystem inSystem, String inName, String inAbbrev)
   {
      this(inSystem, inName, inAbbrev, null);
   }

   //---------------------------------------------------------------------------
   private MassUnit(MeasurementSystem inSystem, String inName, String inAbbrev, BaseSIUnitConverter inConversionToBaseSIUnit, SubUnit... inSubUnits)
   {
      this(inSystem, inName, inAbbrev, null, inConversionToBaseSIUnit, inSubUnits);
   }

   //---------------------------------------------------------------------------
   private MassUnit(MeasurementSystem inSystem, String inName, String inAbbrev, Integer inPow, BaseSIUnitConverter inConversionToBaseSIUnit, SubUnit[] inSubUnits)
   {
      super(inSystem, QuantityType.MASS, inName, inAbbrev, inPow, inConversionToBaseSIUnit, inSubUnits);

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

   //---------------------------------------------------------------------------
   protected MassUnit(List inSubUnits)
   {
      super(inSubUnits);

      // Sanity check that we were give subunits of type 'mass'.
      for (SubUnit subUnit : inSubUnits)
      {
         if (! subUnit.getUnit().getQuantityType().equals(QuantityType.MASS))
         {
            throw new RuntimeException("Cannot construct a " + getClass().getSimpleName() + " for a subunit of type " + subUnit.getUnit().getQuantityType() + "!");
         }
      }
   }


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

   //---------------------------------------------------------------------------
   @Override
   public MassUnit addAlternateName(String inValue)
   {
      return (MassUnit) super.addAlternateName(inValue);
   }
}