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


import com.hfg.exception.ProgrammingException;
import com.hfg.util.CompareUtil;

//------------------------------------------------------------------------------
/**
 * Simple count container useful in Maps.
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg 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 Counter extends Number implements Comparable, Cloneable
{
   private int mValue;

   //---------------------------------------------------------------------------
   @Override
   public Counter clone()
   {
      Counter cloneObj;
      try
      {
         cloneObj = (Counter) super.clone();
      }
      catch (CloneNotSupportedException e)
      {
         throw new ProgrammingException(e);
      }

      return cloneObj;
   }

   //---------------------------------------------------------------------------
   public Counter add(Integer inValue)
   {
      if (inValue != null)
      {
         add(inValue.intValue());
      }

      return this;
   }

   //---------------------------------------------------------------------------
   public Counter reset()
   {
      mValue = 0;
      return this;
   }

   //---------------------------------------------------------------------------
   public Counter increment()
   {
      return add(1);
   }

   //---------------------------------------------------------------------------
   public Counter decrement()
   {
      return add(-1);
   }

   //---------------------------------------------------------------------------
   public Counter add(int inValue)
   {
      mValue += inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public int intValue()
   {
      return mValue;
   }

   //---------------------------------------------------------------------------
   public long longValue()
   {
      return intValue();
   }

   //---------------------------------------------------------------------------
   public float floatValue()
   {
      return (float) intValue();
   }

   //---------------------------------------------------------------------------
   public double doubleValue()
   {
      return (double) intValue();
   }


   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return intValue() + "";
   }


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

   //---------------------------------------------------------------------------
   @Override
   public int compareTo(Counter inObj2)
   {
      int result;
      if (inObj2 != null)
      {
         result = CompareUtil.compare(intValue(), inObj2.intValue());
      }
      else
      {
         result = -1;
      }

      return result;
   }
}