org.apache.commons.math3.exception
Class NumberIsTooSmallException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by java.lang.IllegalArgumentException
                  extended by org.apache.commons.math3.exception.MathIllegalArgumentException
                      extended by org.apache.commons.math3.exception.MathIllegalNumberException
                          extended by org.apache.commons.math3.exception.NumberIsTooSmallException
All Implemented Interfaces:
Serializable, ExceptionContextProvider
Direct Known Subclasses:
NonPositiveDefiniteMatrixException, NotPositiveException, NotStrictlyPositiveException

public class NumberIsTooSmallException
extends MathIllegalNumberException

Exception to be thrown when a number is too small.

Since:
2.2
Version:
$Id: NumberIsTooSmallException.java 1364378 2012-07-22 17:42:38Z tn $
See Also:
Serialized Form

Constructor Summary
NumberIsTooSmallException(Localizable specific, Number wrong, Number min, boolean boundIsAllowed)
          Construct the exception with a specific context.
NumberIsTooSmallException(Number wrong, Number min, boolean boundIsAllowed)
          Construct the exception.
 
Method Summary
 boolean getBoundIsAllowed()
           
 Number getMin()
           
 
Methods inherited from class org.apache.commons.math3.exception.MathIllegalNumberException
getArgument
 
Methods inherited from class org.apache.commons.math3.exception.MathIllegalArgumentException
getContext, getLocalizedMessage, getMessage
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NumberIsTooSmallException

public NumberIsTooSmallException(Number wrong,
                                 Number min,
                                 boolean boundIsAllowed)
Construct the exception.

Parameters:
wrong - Value that is smaller than the minimum.
min - Minimum.
boundIsAllowed - Whether min is included in the allowed range.

NumberIsTooSmallException

public NumberIsTooSmallException(Localizable specific,
                                 Number wrong,
                                 Number min,
                                 boolean boundIsAllowed)
Construct the exception with a specific context.

Parameters:
specific - Specific context pattern.
wrong - Value that is smaller than the minimum.
min - Minimum.
boundIsAllowed - Whether min is included in the allowed range.
Method Detail

getBoundIsAllowed

public boolean getBoundIsAllowed()
Returns:
true if the minimum is included in the allowed range.

getMin

public Number getMin()
Returns:
the minimum.


Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.