Class NumberUtils
- Since:
- 2.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ByteReusable Byte constant for minus one.static final ByteReusable Byte constant for one.static final ByteReusable Byte constant for zero.static final DoubleReusable Double constant for minus one.static final DoubleReusable Double constant for one.static final DoubleReusable Double constant for zero.static final FloatReusable Float constant for minus one.static final FloatReusable Float constant for one.static final FloatReusable Float constant for zero.static final IntegerReusable Integer constant for minus one.static final IntegerReusable Integer constant for one.static final IntegerReusable Integer constant for twostatic final IntegerReusable Integer constant for zero.static final LongInteger.MAX_VALUEas aLong.static final LongInteger.MIN_VALUEas aLong.static final LongReusable Long constant for minus one.static final LongReusable Long constant for one.static final LongReusable Long constant for zero.static final ShortReusable Short constant for minus one.static final ShortReusable Short constant for one.static final ShortReusable Short constant for zero. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic intcompare(byte x, byte y) Compares twobytevalues numerically.static intcompare(int x, int y) Compares twointvalues numerically.static intcompare(long x, long y) Compares tolongvalues numerically.static intcompare(short x, short y) Compares toshortvalues numerically.static BigDecimalcreateBigDecimal(String str) Creates aBigDecimalfrom aString.static BigIntegercreateBigInteger(String str) Creates aBigIntegerfrom aString.static DoublecreateDouble(String str) static FloatcreateFloat(String str) static IntegercreateInteger(String str) static LongcreateLong(String str) static NumbercreateNumber(String str) static booleanisCreatable(String str) Checks whether the String is a valid Java number.static booleanChecks whether theStringcontains only digit characters.static booleanDeprecated.This feature will be removed in Lang 4, useisCreatable(String)insteadstatic booleanisParsable(String str) Checks whether the given String is a parsable number.static bytemax(byte... array) Returns the maximum value in an array.static bytemax(byte a, byte b, byte c) Gets the maximum of threebytevalues.static doublemax(double... array) Returns the maximum value in an array.static doublemax(double a, double b, double c) Gets the maximum of threedoublevalues.static floatmax(float... array) Returns the maximum value in an array.static floatmax(float a, float b, float c) Gets the maximum of threefloatvalues.static intmax(int... array) Returns the maximum value in an array.static intmax(int a, int b, int c) Gets the maximum of threeintvalues.static longmax(long... array) Returns the maximum value in an array.static longmax(long a, long b, long c) Gets the maximum of threelongvalues.static shortmax(short... array) Returns the maximum value in an array.static shortmax(short a, short b, short c) Gets the maximum of threeshortvalues.static bytemin(byte... array) Returns the minimum value in an array.static bytemin(byte a, byte b, byte c) Gets the minimum of threebytevalues.static doublemin(double... array) Returns the minimum value in an array.static doublemin(double a, double b, double c) Gets the minimum of threedoublevalues.static floatmin(float... array) Returns the minimum value in an array.static floatmin(float a, float b, float c) Gets the minimum of threefloatvalues.static intmin(int... array) Returns the minimum value in an array.static intmin(int a, int b, int c) Gets the minimum of threeintvalues.static longmin(long... array) Returns the minimum value in an array.static longmin(long a, long b, long c) Gets the minimum of threelongvalues.static shortmin(short... array) Returns the minimum value in an array.static shortmin(short a, short b, short c) Gets the minimum of threeshortvalues.static bytestatic byteConverts aStringto abyte, returning a default value if the conversion fails.static doublestatic doubleConverts aStringto adouble, returning a default value if the conversion fails.static doubletoDouble(BigDecimal value) Converts aBigDecimalto adouble.static doubletoDouble(BigDecimal value, double defaultValue) Converts aBigDecimalto adouble.static floatstatic floatConverts aStringto afloat, returning a default value if the conversion fails.static intstatic intConverts aStringto anint, returning a default value if the conversion fails.static longstatic longConverts aStringto along, returning a default value if the conversion fails.static BigDecimaltoScaledBigDecimal(Double value) Converts aDoubleto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN.static BigDecimaltoScaledBigDecimal(Double value, int scale, RoundingMode roundingMode) static BigDecimaltoScaledBigDecimal(Float value) Converts aFloatto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN.static BigDecimaltoScaledBigDecimal(Float value, int scale, RoundingMode roundingMode) static BigDecimaltoScaledBigDecimal(String value) Converts aStringto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN.static BigDecimaltoScaledBigDecimal(String value, int scale, RoundingMode roundingMode) static BigDecimaltoScaledBigDecimal(BigDecimal value) Converts aBigDecimalto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN.static BigDecimaltoScaledBigDecimal(BigDecimal value, int scale, RoundingMode roundingMode) Converts aBigDecimalto aBigDecimalwhose scale is the specified value with aRoundingModeapplied.static shortstatic shortConverts aStringto anshort, returning a default value if the conversion fails.
-
Field Details
-
LONG_ZERO
Reusable Long constant for zero. -
LONG_ONE
Reusable Long constant for one. -
LONG_MINUS_ONE
Reusable Long constant for minus one. -
INTEGER_ZERO
Reusable Integer constant for zero. -
INTEGER_ONE
Reusable Integer constant for one. -
INTEGER_TWO
Reusable Integer constant for two -
INTEGER_MINUS_ONE
Reusable Integer constant for minus one. -
SHORT_ZERO
Reusable Short constant for zero. -
SHORT_ONE
Reusable Short constant for one. -
SHORT_MINUS_ONE
Reusable Short constant for minus one. -
BYTE_ZERO
Reusable Byte constant for zero. -
BYTE_ONE
Reusable Byte constant for one. -
BYTE_MINUS_ONE
Reusable Byte constant for minus one. -
DOUBLE_ZERO
Reusable Double constant for zero. -
DOUBLE_ONE
Reusable Double constant for one. -
DOUBLE_MINUS_ONE
Reusable Double constant for minus one. -
FLOAT_ZERO
Reusable Float constant for zero. -
FLOAT_ONE
Reusable Float constant for one. -
FLOAT_MINUS_ONE
Reusable Float constant for minus one. -
LONG_INT_MAX_VALUE
Integer.MAX_VALUEas aLong.- Since:
- 3.12.0
-
LONG_INT_MIN_VALUE
Integer.MIN_VALUEas aLong.- Since:
- 3.12.0
-
-
Constructor Details
-
NumberUtils
Deprecated.TODO Make private in 4.0.NumberUtilsinstances should NOT be constructed in standard programming. Instead, the class should be used asNumberUtils.toInt("6");.This constructor is public to permit tools that require a JavaBean instance to operate.
-
-
Method Details
-
compare
Compares twobytevalues numerically. This is the same functionality as provided in Java 7.- Parameters:
x- the firstbyteto comparey- the secondbyteto compare- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y - Since:
- 3.4
-
compare
Compares twointvalues numerically. This is the same functionality as provided in Java 7.- Parameters:
x- the firstintto comparey- the secondintto compare- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y - Since:
- 3.4
-
compare
Compares tolongvalues numerically. This is the same functionality as provided in Java 7.- Parameters:
x- the firstlongto comparey- the secondlongto compare- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y - Since:
- 3.4
-
compare
Compares toshortvalues numerically. This is the same functionality as provided in Java 7.- Parameters:
x- the firstshortto comparey- the secondshortto compare- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y - Since:
- 3.4
-
createBigDecimal
- Parameters:
str- aStringto convert, may be null- Returns:
- converted
BigDecimal(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted
-
createBigInteger
Creates aBigIntegerfrom aString. Handles hexadecimal (0x or #) and octal (0) notations.Returns
nullif the string isnull.- Parameters:
str- aStringto convert, may be null- Returns:
- converted
BigInteger(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted- Since:
- 3.2
-
createDouble
- Parameters:
str- aStringto convert, may be null- Returns:
- converted
Double(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted
-
createFloat
- Parameters:
str- aStringto convert, may be null- Returns:
- converted
Float(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted
-
createInteger
Creates anIntegerfrom aString. Handles hexadecimal (0xhhhh) and octal (0dddd) notations. N.B. a leading zero means octal; spaces are not trimmed.Returns
nullif the string isnull.- Parameters:
str- aStringto convert, may be null- Returns:
- converted
Integer(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted
-
createLong
Creates aLongfrom aString. Handles hexadecimal (0Xhhhh) and octal (0ddd) notations. N.B. a leading zero means octal; spaces are not trimmed.Returns
nullif the string isnull.- Parameters:
str- aStringto convert, may be null- Returns:
- converted
Long(or null if the input is null) - Throws:
NumberFormatException- if the value cannot be converted- Since:
- 3.1
-
createNumber
Creates aNumberfrom aString.If the string starts with
0xor-0x(lower or upper case) or#or-#, it will be interpreted as a hexadecimal Integer - or Long, if the number of digits after the prefix is more than 8 - or BigInteger if there are more than 16 digits.Then, the value is examined for a type qualifier on the end, i.e. one of
'f', 'F', 'd', 'D', 'l', 'L'. If it is found, it starts trying to create successively larger types from the type specified until one is found that can represent the value.If a type specifier is not found, it will check for a decimal point and then try successively larger types from
IntegertoBigIntegerand fromFloattoBigDecimal.Integral values with a leading
0will be interpreted as octal; the returned number will be Integer, Long or BigDecimal as appropriate.Returns
nullif the string isnull.This method does not trim the input string, i.e., strings with leading or trailing spaces will generate NumberFormatExceptions.
- Parameters:
str- String containing a number, may be null- Returns:
- Number created from the string (or null if the input is null)
- Throws:
NumberFormatException- if the value cannot be converted
-
isCreatable
Checks whether the String is a valid Java number.Valid numbers include hexadecimal marked with the
0xor0Xqualifier, octal numbers, scientific notation and numbers marked with a type qualifier (e.g. 123L).Non-hexadecimal strings beginning with a leading zero are treated as octal values. Thus the string
09will returnfalse, since9is not a valid octal value. However, numbers beginning with0.are treated as decimal.nulland empty/blankStringwill returnfalse.Note,
createNumber(String)should return a number for every input resulting intrue.- Parameters:
str- theStringto check- Returns:
trueif the string is a correctly formatted number- Since:
- 3.5
-
isDigits
Checks whether theStringcontains only digit characters.nulland empty String will returnfalse.- Parameters:
str- theStringto check- Returns:
trueif str contains only Unicode numeric
-
isNumber
Deprecated.This feature will be removed in Lang 4, useisCreatable(String)insteadChecks whether the String is a valid Java number.Valid numbers include hexadecimal marked with the
0xor0Xqualifier, octal numbers, scientific notation and numbers marked with a type qualifier (e.g. 123L).Non-hexadecimal strings beginning with a leading zero are treated as octal values. Thus the string
09will returnfalse, since9is not a valid octal value. However, numbers beginning with0.are treated as decimal.nulland empty/blankStringwill returnfalse.Note,
createNumber(String)should return a number for every input resulting intrue.- Parameters:
str- theStringto check- Returns:
trueif the string is a correctly formatted number- Since:
- 3.3 the code supports hexadecimal
0Xhhhan octal0dddvalidation
-
isParsable
Checks whether the given String is a parsable number.Parsable numbers include those Strings understood by
Integer.parseInt(String),Long.parseLong(String),Float.parseFloat(String)orDouble.parseDouble(String). This method can be used instead of catchingParseExceptionwhen calling one of those methods.Hexadecimal and scientific notations are not considered parsable. See
isCreatable(String)on those cases.nulland empty String will returnfalse.- Parameters:
str- the String to check.- Returns:
trueif the string is a parsable number.- Since:
- 3.4
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(byte[]) to max(byte...)
-
max
Gets the maximum of threebytevalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(double[]) to max(double...)
- See Also:
-
max
Gets the maximum of threedoublevalues.If any value is
NaN,NaNis returned. Infinity is handled.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
- See Also:
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(float[]) to max(float...)
- See Also:
-
max
Gets the maximum of threefloatvalues.If any value is
NaN,NaNis returned. Infinity is handled.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
- See Also:
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(int[]) to max(int...)
-
max
Gets the maximum of threeintvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(long[]) to max(long...)
-
max
Gets the maximum of threelongvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
-
max
Returns the maximum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the maximum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from max(short[]) to max(short...)
-
max
Gets the maximum of threeshortvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the largest of the values
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(byte[]) to min(byte...)
-
min
Gets the minimum of threebytevalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(double[]) to min(double...)
- See Also:
-
min
Gets the minimum of threedoublevalues.If any value is
NaN,NaNis returned. Infinity is handled.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
- See Also:
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(float[]) to min(float...)
- See Also:
-
min
Gets the minimum of threefloatvalues.If any value is
NaN,NaNis returned. Infinity is handled.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
- See Also:
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(int[]) to min(int...)
-
min
Gets the minimum of threeintvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(long[]) to min(long...)
-
min
Gets the minimum of threelongvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
-
min
Returns the minimum value in an array.- Parameters:
array- an array, must not be null or empty- Returns:
- the minimum value in the array
- Throws:
NullPointerException- ifarrayisnullIllegalArgumentException- ifarrayis empty- Since:
- 3.4 Changed signature from min(short[]) to min(short...)
-
min
Gets the minimum of threeshortvalues.- Parameters:
a- value 1b- value 2c- value 3- Returns:
- the smallest of the values
-
toByte
Converts aStringto abyte, returningzeroif the conversion fails.If the string is
null,zerois returned.NumberUtils.toByte(null) = 0 NumberUtils.toByte("") = 0 NumberUtils.toByte("1") = 1- Parameters:
str- the string to convert, may be null- Returns:
- the byte represented by the string, or
zeroif conversion fails - Since:
- 2.5
-
toByte
Converts aStringto abyte, returning a default value if the conversion fails.If the string is
null, the default value is returned.NumberUtils.toByte(null, 1) = 1 NumberUtils.toByte("", 1) = 1 NumberUtils.toByte("1", 0) = 1- Parameters:
str- the string to convert, may be nulldefaultValue- the default value- Returns:
- the byte represented by the string, or the default if conversion fails
- Since:
- 2.5
-
toDouble
Converts aBigDecimalto adouble.If the
BigDecimalvalueisnull, then the specified default value is returned.NumberUtils.toDouble(null) = 0.0d NumberUtils.toDouble(BigDecimal.valueOf(8.5d)) = 8.5d
- Parameters:
value- theBigDecimalto convert, may benull.- Returns:
- the double represented by the
BigDecimalor0.0dif theBigDecimalisnull. - Since:
- 3.8
-
toDouble
Converts aBigDecimalto adouble.If the
BigDecimalvalueisnull, then the specified default value is returned.NumberUtils.toDouble(null, 1.1d) = 1.1d NumberUtils.toDouble(BigDecimal.valueOf(8.5d), 1.1d) = 8.5d
- Parameters:
value- theBigDecimalto convert, may benull.defaultValue- the default value- Returns:
- the double represented by the
BigDecimalor the defaultValue if theBigDecimalisnull. - Since:
- 3.8
-
toDouble
Converts aStringto adouble, returning0.0dif the conversion fails.If the string
strisnull,0.0dis returned.NumberUtils.toDouble(null) = 0.0d NumberUtils.toDouble("") = 0.0d NumberUtils.toDouble("1.5") = 1.5d- Parameters:
str- the string to convert, may benull- Returns:
- the double represented by the string, or
0.0dif conversion fails - Since:
- 2.1
-
toDouble
Converts aStringto adouble, returning a default value if the conversion fails.If the string
strisnull, the default value is returned.NumberUtils.toDouble(null, 1.1d) = 1.1d NumberUtils.toDouble("", 1.1d) = 1.1d NumberUtils.toDouble("1.5", 0.0d) = 1.5d- Parameters:
str- the string to convert, may benulldefaultValue- the default value- Returns:
- the double represented by the string, or defaultValue if conversion fails
- Since:
- 2.1
-
toFloat
Converts aStringto afloat, returning0.0fif the conversion fails.If the string
strisnull,0.0fis returned.NumberUtils.toFloat(null) = 0.0f NumberUtils.toFloat("") = 0.0f NumberUtils.toFloat("1.5") = 1.5f- Parameters:
str- the string to convert, may benull- Returns:
- the float represented by the string, or
0.0fif conversion fails - Since:
- 2.1
-
toFloat
Converts aStringto afloat, returning a default value if the conversion fails.If the string
strisnull, the default value is returned.NumberUtils.toFloat(null, 1.1f) = 1.1f NumberUtils.toFloat("", 1.1f) = 1.1f NumberUtils.toFloat("1.5", 0.0f) = 1.5f- Parameters:
str- the string to convert, may benulldefaultValue- the default value- Returns:
- the float represented by the string, or defaultValue if conversion fails
- Since:
- 2.1
-
toInt
Converts aStringto anint, returningzeroif the conversion fails.If the string is
null,zerois returned.NumberUtils.toInt(null) = 0 NumberUtils.toInt("") = 0 NumberUtils.toInt("1") = 1- Parameters:
str- the string to convert, may be null- Returns:
- the int represented by the string, or
zeroif conversion fails - Since:
- 2.1
-
toInt
Converts aStringto anint, returning a default value if the conversion fails.If the string is
null, the default value is returned.NumberUtils.toInt(null, 1) = 1 NumberUtils.toInt("", 1) = 1 NumberUtils.toInt("1", 0) = 1- Parameters:
str- the string to convert, may be nulldefaultValue- the default value- Returns:
- the int represented by the string, or the default if conversion fails
- Since:
- 2.1
-
toLong
Converts aStringto along, returningzeroif the conversion fails.If the string is
null,zerois returned.NumberUtils.toLong(null) = 0L NumberUtils.toLong("") = 0L NumberUtils.toLong("1") = 1L- Parameters:
str- the string to convert, may be null- Returns:
- the long represented by the string, or
0if conversion fails - Since:
- 2.1
-
toLong
Converts aStringto along, returning a default value if the conversion fails.If the string is
null, the default value is returned.NumberUtils.toLong(null, 1L) = 1L NumberUtils.toLong("", 1L) = 1L NumberUtils.toLong("1", 0L) = 1L- Parameters:
str- the string to convert, may be nulldefaultValue- the default value- Returns:
- the long represented by the string, or the default if conversion fails
- Since:
- 2.1
-
toScaledBigDecimal
Converts aBigDecimalto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN. If the suppliedvalueis null, thenBigDecimal.ZEROis returned.Note, the scale of a
BigDecimalis the number of digits to the right of the decimal point.- Parameters:
value- theBigDecimalto convert, may be null.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aBigDecimalto aBigDecimalwhose scale is the specified value with aRoundingModeapplied. If the inputvalueisnull, we simply returnBigDecimal.ZERO.- Parameters:
value- theBigDecimalto convert, may be null.scale- the number of digits to the right of the decimal point.roundingMode- a rounding behavior for numerical operations capable of discarding precision.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aDoubleto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN. If the suppliedvalueis null, thenBigDecimal.ZEROis returned.Note, the scale of a
BigDecimalis the number of digits to the right of the decimal point.- Parameters:
value- theDoubleto convert, may be null.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aDoubleto aBigDecimalwhose scale is the specified value with aRoundingModeapplied. If the inputvalueisnull, we simply returnBigDecimal.ZERO.- Parameters:
value- theDoubleto convert, may be null.scale- the number of digits to the right of the decimal point.roundingMode- a rounding behavior for numerical operations capable of discarding precision.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aFloatto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN. If the suppliedvalueis null, thenBigDecimal.ZEROis returned.Note, the scale of a
BigDecimalis the number of digits to the right of the decimal point.- Parameters:
value- theFloatto convert, may be null.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aFloatto aBigDecimalwhose scale is the specified value with aRoundingModeapplied. If the inputvalueisnull, we simply returnBigDecimal.ZERO.- Parameters:
value- theFloatto convert, may be null.scale- the number of digits to the right of the decimal point.roundingMode- a rounding behavior for numerical operations capable of discarding precision.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aStringto aBigDecimalwith a scale of two that has been rounded usingRoundingMode.HALF_EVEN. If the suppliedvalueis null, thenBigDecimal.ZEROis returned.Note, the scale of a
BigDecimalis the number of digits to the right of the decimal point.- Parameters:
value- theStringto convert, may be null.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toScaledBigDecimal
Converts aStringto aBigDecimalwhose scale is the specified value with aRoundingModeapplied. If the inputvalueisnull, we simply returnBigDecimal.ZERO.- Parameters:
value- theStringto convert, may be null.scale- the number of digits to the right of the decimal point.roundingMode- a rounding behavior for numerical operations capable of discarding precision.- Returns:
- the scaled, with appropriate rounding,
BigDecimal. - Since:
- 3.8
-
toShort
Converts aStringto ashort, returningzeroif the conversion fails.If the string is
null,zerois returned.NumberUtils.toShort(null) = 0 NumberUtils.toShort("") = 0 NumberUtils.toShort("1") = 1- Parameters:
str- the string to convert, may be null- Returns:
- the short represented by the string, or
zeroif conversion fails - Since:
- 2.5
-
toShort
Converts aStringto anshort, returning a default value if the conversion fails.If the string is
null, the default value is returned.NumberUtils.toShort(null, 1) = 1 NumberUtils.toShort("", 1) = 1 NumberUtils.toShort("1", 0) = 1- Parameters:
str- the string to convert, may be nulldefaultValue- the default value- Returns:
- the short represented by the string, or the default if conversion fails
- Since:
- 2.5
-