com.hfg.graphics.units.GfxUnits 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.graphics.units;

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

import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 * Enumeration of absolute graphic length measurement 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 GfxUnits
{
   private static Map sInstanceMap = new HashMap<>(10);

   /** Twentieth of a point. Used by Microsoft in the Office Open XML standard. */
   public static final GfxUnits dxa     = new GfxUnits("dxa",    "dxa");
   /** English metric units. Used by Microsoft in the Office Open XML standard. */
   public static final GfxUnits emus         = new GfxUnits("emus",   "emu");
   public static final GfxUnits inches       = new GfxUnits("inches", "in");
   public static final GfxUnits centimeters  = new GfxUnits("centimeters", "cm");
   public static final GfxUnits millimeters  = new GfxUnits("millimeters", "mm");
   public static final GfxUnits micrometers  = new GfxUnits("micrometers", "μm");
   public static final GfxUnits pixels       = new GfxUnits("pixels", "px");
   public static final GfxUnits points       = new GfxUnits("points", "pt");
   public static final GfxUnits picas        = new GfxUnits("picas",  "pc");
   public static final GfxUnits half_points  = new GfxUnits("half-points", "hpt");
   public static final GfxUnits dots         = new GfxUnits("dots", "d");


   private String mName;
   private String mAbbrev;


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

   //---------------------------------------------------------------------------
   private GfxUnits(String inName, String inAbbrev)
   {
      mName = inName;
      mAbbrev = inAbbrev;

      sInstanceMap.put(mName.toLowerCase(), this);
      sInstanceMap.put(mAbbrev.toLowerCase(), this);
   }

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

   //---------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

   //---------------------------------------------------------------------------
   public String abbrev()
   {
      return mAbbrev;
   }

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return abbrev();
   }


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

}