Java Doc for NumberUtils.java in  » Library » Apache-common-lang » org » apache » commons » lang » math » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Provides extra functionality for Java Number classes.

NumberUtils instances should NOT be constructed in standard programming.

Compares two floats for order.

This method is more comprehensive than the standard Java greater than, less than and equals operators.

• It returns -1 if the first value is less than the second.

Turns a string value into a java.lang.Number.

First, the value is examined for a type qualifier on the end ('f','F','d','D','l','L').

Checks whether the String a valid Java number.

Valid numbers include hexadecimal marked with the 0x qualifier, scientific notation and numbers marked with a type qualifier (e.g.

Gets the maximum of three double values.

If any value is NaN, NaN is returned.

Gets the maximum of three float values.

If any value is NaN, NaN is returned.

Gets the minimum of three double values.

If any value is NaN, NaN is returned.

Gets the minimum of three float values.

If any value is NaN, NaN is returned.

NumberUtils instances should NOT be constructed in standard programming. Instead, the class should be used as NumberUtils.stringToInt("6");.

This constructor is public to permit tools that require a JavaBean instance to operate.

Compares two doubles for order.

This method is more comprehensive than the standard Java greater than, less than and equals operators.

• It returns -1 if the first value is less than the second.
• It returns +1 if the first value is greater than the second.
• It returns 0 if the values are equal.

The ordering is as follows, largest to smallest:

• NaN
• Positive infinity
• Maximum double
• Normal positive numbers
• +0.0
• -0.0
• Normal negative numbers
• Minimum double (-Double.MAX_VALUE)
• Negative infinity

Comparing NaN with NaN will return 0.

Compares two floats for order.

This method is more comprehensive than the standard Java greater than, less than and equals operators.

• It returns -1 if the first value is less than the second.
• It returns +1 if the first value is greater than the second.
• It returns 0 if the values are equal.

The ordering is as follows, largest to smallest:

• NaN
• Positive infinity
• Maximum float
• Normal positive numbers
• +0.0
• -0.0
• Normal negative numbers
• Minimum float (-Float.MAX_VALUE)
• Negative infinity

Comparing NaN with NaN will return 0.

Convert a String to a BigDecimal.

Returns null if the string is null.

Convert a String to a BigInteger.

Returns null if the string is null.

Convert a String to a Double.

Returns null if the string is null.

Convert a String to a Float.

Returns null if the string is null.

Convert a String to a Integer, handling hex and octal notations.

Returns null if the string is null.

Convert a String to a Long.

Returns null if the string is null.

Turns a string value into a java.lang.Number.

First, the value is examined for a type qualifier on the end ('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 Integer to BigInteger and from Float to BigDecimal.

If the string starts with 0x or -0x, it will be interpreted as a hexadecimal integer. Values with leading 0's will not be interpreted as octal.

Returns null if the string is null.

This method does not trim the input string, i.e., strings with leading or trailing spaces will generate NumberFormatExceptions.

Checks whether the String contains only digit characters.

Null and empty String will return false.

Checks whether the String a valid Java number.

Valid numbers include hexadecimal marked with the 0x qualifier, scientific notation and numbers marked with a type qualifier (e.g. 123L).

Null and empty String will return false.

Returns the maximum value in an array.

Returns the maximum value in an array.

Returns the maximum value in an array.

Returns the maximum value in an array.

Returns the maximum value in an array.

Returns the maximum value in an array.

Gets the maximum of three long values.

Gets the maximum of three int values.

Gets the maximum of three short values.

Gets the maximum of three byte values.

Gets the maximum of three double values.

If any value is NaN, NaN is returned. Infinity is handled.

Gets the maximum of three float values.

If any value is NaN, NaN is returned. Infinity is handled.

Returns the minimum value in an array.

Returns the minimum value in an array.

Returns the minimum value in an array.

Returns the minimum value in an array.

Returns the minimum value in an array.

Returns the minimum value in an array.

Gets the minimum of three long values.

Gets the minimum of three int values.

Gets the minimum of three short values.

Gets the minimum of three byte values.

Gets the minimum of three double values.

If any value is NaN, NaN is returned. Infinity is handled.

Gets the minimum of three float values.

If any value is NaN, NaN is returned. Infinity is handled.

Convert a String to an int, returning zero if the conversion fails.

If the string is null, zero is returned.

 NumberUtils.stringToInt(null) = 0
 NumberUtils.stringToInt("")   = 0
 NumberUtils.stringToInt("1")  = 1
 

Convert a String to an int, returning a default value if the conversion fails.

If the string is null, the default value is returned.

 NumberUtils.stringToInt(null, 1) = 1
 NumberUtils.stringToInt("", 1)   = 1
 NumberUtils.stringToInt("1", 0)  = 1
 

Convert a String to a double, returning 0.0d if the conversion fails.

If the string str is null, 0.0d is returned.

 NumberUtils.toDouble(null)   = 0.0d
 NumberUtils.toDouble("")     = 0.0d
 NumberUtils.toDouble("1.5")  = 1.5d
 

Convert a String to a double, returning a default value if the conversion fails.

If the string str is null, 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
 

Convert a String to a float, returning 0.0f if the conversion fails.

If the string str is null, 0.0f is returned.

 NumberUtils.toFloat(null)   = 0.0f
 NumberUtils.toFloat("")     = 0.0f
 NumberUtils.toFloat("1.5")  = 1.5f
 

Convert a String to a float, returning a default value if the conversion fails.

If the string str is null, the default value is returned.

 NumberUtils.toFloat(null, 1.1f)   = 1.0f
 NumberUtils.toFloat("", 1.1f)     = 1.1f
 NumberUtils.toFloat("1.5", 0.0f)  = 1.5f
 

Convert a String to an int, returning zero if the conversion fails.

If the string is null, zero is returned.

 NumberUtils.toInt(null) = 0
 NumberUtils.toInt("")   = 0
 NumberUtils.toInt("1")  = 1
 

Convert a String to an int, 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
 

Convert a String to a long, returning zero if the conversion fails.

If the string is null, zero is returned.

 NumberUtils.toLong(null) = 0L
 NumberUtils.toLong("")   = 0L
 NumberUtils.toLong("1")  = 1L
 

Convert a String to a long, 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