Package org.apache.commons.math4.exception

Class NumberIsTooSmallException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.apache.commons.math4.exception.MathRuntimeException
org.apache.commons.math4.exception.MathIllegalArgumentException
org.apache.commons.math4.exception.MathIllegalNumberException
org.apache.commons.math4.exception.NumberIsTooSmallException
All Implemented Interfaces:
java.io.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
See Also:
Serialized Form

  • Field Summary

    Fields inherited from class org.apache.commons.math4.exception.MathIllegalNumberException

    INTEGER_ZERO

  • Constructor Summary

    Constructors 
    Constructor Description
    NumberIsTooSmallException​(java.lang.Number wrong, java.lang.Number min, boolean boundIsAllowed)
    Construct the exception.
    NumberIsTooSmallException​(Localizable specific, java.lang.Number wrong, java.lang.Number min, boolean boundIsAllowed)
    Construct the exception with a specific context.

  • Method Summary

    Modifier and Type Method Description
    boolean getBoundIsAllowed()  
    java.lang.Number getMin()  

    Methods inherited from class org.apache.commons.math4.exception.MathIllegalNumberException

    getArgument

    Methods inherited from class org.apache.commons.math4.exception.MathRuntimeException

    getContext, getLocalizedMessage, getMessage

    Methods inherited from class java.lang.Throwable

    addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NumberIsTooSmallException

      public NumberIsTooSmallException​(java.lang.Number wrong, java.lang.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, java.lang.Number wrong, java.lang.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 Details

    • getBoundIsAllowed

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

    • getMin

      public java.lang.Number getMin()
      Returns:
      the minimum.