com.hfg.math.Percent 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 com.hfg.exception.InvalidValueException;

//------------------------------------------------------------------------------
/**
 Percent object bounded by 0 <=  value >= 100.

 @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 Percent
{
   private float mValue;

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

   //--------------------------------------------------------------------------
   public Percent(float inValue)
   {
      setValue(inValue);
   }

   //--------------------------------------------------------------------------
   public Percent(double inValue)
   {
      setValue((float)inValue);
   }

   //--------------------------------------------------------------------------
   public Percent(int inValue)
   {
      setValue(inValue);
   }

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

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

   //--------------------------------------------------------------------------
   public float getValue()
   {
      return mValue;
   }

   //--------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return String.format("%.2f%%", mValue);
   }

   //###########################################################################
   // PRIVATE METHODS
   //###########################################################################

   //--------------------------------------------------------------------------
   private void setValue(float inValue)
   {
      if (inValue < 0)
      {
         throw new InvalidValueException("The percent value cannot be less than 0!");
      }
      else if (inValue > 100)
      {
         throw new InvalidValueException("The percent value cannot be greater than 100!");
      }

      mValue = inValue;
   }
}