com.hfg.math.Quadrant 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.math;

import java.util.Map;

import com.hfg.exception.InvalidValueException;
import com.hfg.util.CompareUtil;
import com.hfg.util.collection.OrderedMap;

//------------------------------------------------------------------------------
/**
 Canonical quadrant names.
           |
     II   |   I
   ---------------
     III  |  IV
          |
 
 @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 Quadrant implements Comparable
{
   private static Map sValueMap = new OrderedMap<>(4);

   public static final Quadrant I   = new Quadrant(1);
   public static final Quadrant II  = new Quadrant(2);
   public static final Quadrant III = new Quadrant(3);
   public static final Quadrant IV  = new Quadrant(4);

   private int mIntValue;


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

   //--------------------------------------------------------------------------
   private Quadrant(int inValue)
   {
      mIntValue = inValue;
      sValueMap.put(new RomanNumeral(mIntValue).toString(), this);
   }

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

   //--------------------------------------------------------------------------
   public static Quadrant[] values()
   {
      return sValueMap.values().toArray(new Quadrant[0]);
   }

   //--------------------------------------------------------------------------
   public static Quadrant valueOf(String inValue)
   {
      return (inValue != null ? sValueMap.get(inValue.toUpperCase()) :  null);
   }

   //--------------------------------------------------------------------------
   public static Quadrant valueOf(int inValue)
   {
      Quadrant value = null;
      try
      {
         value = sValueMap.get(new RomanNumeral(inValue).toString());
      }
      catch (InvalidValueException e)
      {
         // Ignore
      }

      return value;
   }

   //--------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return new RomanNumeral(mIntValue).toString();
   }

   //--------------------------------------------------------------------------
   @Override
   public int hashCode()
   {
      return mIntValue;
   }

   //--------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      return (0 == compareTo(inObj2));
   }

   //--------------------------------------------------------------------------
   @Override
   public int compareTo(Object inObj2)
   {
      int result = -1;
      if (inObj2 instanceof Quadrant)
      {
         result = CompareUtil.compare(mIntValue, ((Quadrant) inObj2).mIntValue);
      }

      return result;
   }
}