Top Description Fields Constructors Methods
org.apache.commons.math3.exception

public Class NumberIsTooSmallException

extends MathIllegalNumberException
Class Inheritance
Known Direct Subclasses
org.apache.commons.math3.linear.NonPositiveDefiniteMatrixException, org.apache.commons.math3.exception.NotPositiveException, org.apache.commons.math3.exception.NotStrictlyPositiveException
Imports
org.apache.commons.math3.exception.util.Localizable, .LocalizedFormats

Exception to be thrown when a number is too small.
Since
2.2

Field Summary

Modifier and TypeField and Description
private final boolean
boundIsAllowed

Whether the maximum is included in the allowed range.

private final Number
min

Higher bound.

private static final long
Inherited from org.apache.commons.math3.exception.MathIllegalNumberException:
INTEGER_ZERO

Constructor Summary

AccessConstructor and Description
public
NumberIsTooSmallException(Number
Value that is smaller than the minimum.
wrong
,
Number
Minimum.
min
,
boolean
Whether min is included in the allowed range.
boundIsAllowed
)

Construct the exception.

public
NumberIsTooSmallException(Localizable
Specific context pattern.
specific
,
Number
Value that is smaller than the minimum.
wrong
,
Number
Minimum.
min
,
boolean
Whether min is included in the allowed range.
boundIsAllowed
)

Construct the exception with a specific context.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the minimum is included in the allowed range.
getBoundIsAllowed
()

public Number

Returns:

the minimum.
getMin
()

Inherited from org.apache.commons.math3.exception.MathIllegalNumberException:
getArgument

Field Detail

boundIsAllowedback to summary
private final boolean boundIsAllowed

Whether the maximum is included in the allowed range.

minback to summary
private final Number min

Higher bound.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.commons.math3.exception.MathIllegalNumberException.serialVersionUID.

Serializable version Id.

Constructor Detail

NumberIsTooSmallExceptionback to summary
public NumberIsTooSmallException(Number wrong, Number min, boolean boundIsAllowed)

Construct the exception.

Parameters
wrong:Number

Value that is smaller than the minimum.

min:Number

Minimum.

boundIsAllowed:boolean

Whether min is included in the allowed range.

NumberIsTooSmallExceptionback to summary
public NumberIsTooSmallException(Localizable specific, Number wrong, Number min, boolean boundIsAllowed)

Construct the exception with a specific context.

Parameters
specific:Localizable

Specific context pattern.

wrong:Number

Value that is smaller than the minimum.

min:Number

Minimum.

boundIsAllowed:boolean

Whether min is included in the allowed range.

Method Detail

getBoundIsAllowedback to summary
public boolean getBoundIsAllowed()
Returns:boolean

true if the minimum is included in the allowed range.

getMinback to summary
public Number getMin()
Returns:Number

the minimum.