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

import com.hfg.units.LengthUnit;

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

//------------------------------------------------------------------------------
/**
 Common resolution 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 ResolutionUnit
{
   private String mName;
   private LengthUnit mLengthUnit;

   private static final Map VALUE_MAP = new HashMap<>(2);

   public static final ResolutionUnit DPI  = new ResolutionUnit("dpi", LengthUnit.inch);
   public static final ResolutionUnit DPMM = new ResolutionUnit("dpmm", LengthUnit.millimeter);


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

   //--------------------------------------------------------------------------
   private ResolutionUnit(String inName, LengthUnit inUnit)
   {
      mName = inName;
      mLengthUnit = inUnit;
      VALUE_MAP.put(inName, this);
   }

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

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

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

   //--------------------------------------------------------------------------
   public LengthUnit getLengthUnit()
   {
      return mLengthUnit;
   }

   //--------------------------------------------------------------------------
   public static ResolutionUnit valueOf(String inName)
   {
      return VALUE_MAP.get(inName.toLowerCase());
   }

   //--------------------------------------------------------------------------
   public static ResolutionUnit[] values()
   {
      return VALUE_MAP.values().toArray(new ResolutionUnit[] {});
   }
}