com.hfg.units.AreaUnit 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.List;
import java.util.Map;

import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 Enumeration of standard area 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 AreaUnit extends Unit
{
   private static Map sInstanceMap = new HashMap<>(3);

   public static final AreaUnit sq_meter     = new AreaUnit(MeasurementSystem.SI, new SubUnit(LengthUnit.meter, 2));

   // Quasi SI unit
   public static final AreaUnit hectare      = new AreaUnit(MeasurementSystem.Metric, "hectare", "ha", new BaseSIUnitConverter(10000d));

   // British Imperial units
   public static final AreaUnit acre     = new AreaUnit(MeasurementSystem.BritishImperial, "acre", "acres", new BaseSIUnitConverter(4046.8564224));

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   private AreaUnit(MeasurementSystem inSystem, SubUnit inSubUnit)
   {
      super(inSystem, QuantityType.AREA, inSubUnit);
   }

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

   //---------------------------------------------------------------------------
   private AreaUnit(MeasurementSystem inSystem, String inName, String inAbbrev, Integer inPow, BaseSIUnitConverter inConversionToBaseSIUnit)
   {
      super(inSystem, QuantityType.AREA, inName, inAbbrev, inPow, inConversionToBaseSIUnit);

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

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

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

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

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

}