NumberUtils (Cobble All-in-One 4.6.2 API)

java.lang.Object
- net.hasor.cobble.NumberUtils

```
public final class NumberUtils
extends Object
```
Provides extra functionality for Java Number classes.
2021-11-01 reduction based on Apache Commons lang3, org.apache.commons.lang3.math.NumberUtils

从以下版本开始:

1.0

作者:

赵永春 (zyc@hasor.net), Apache Software Foundation, Rand McNeely, Steve Downey, Eric Pugh, Phil Steitz, 赵永春

构造器概要

构造器
构造器和说明

NumberUtils()
NumberUtils instances should NOT be constructed in standard programming.

构造器
构造器和说明
`NumberUtils()` `NumberUtils` instances should NOT be constructed in standard programming.

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static Number`	`add(Number obj1, Number obj2)` 加
`static Number`	`aliquot(Number obj1, Number obj2)` 整除
`static Number`	`and(Number obj1, Number obj2)` 与
`static double`	`between(double value, double min, double max)` Gets the between num of min,max `double` values.
`static float`	`between(float value, float min, float max)` Gets the between num of min,max `float` values.
`static int`	`between(int value, int min, int max)` Gets the between num of min,max `int` values.
`static long`	`between(long value, long min, long max)` Gets the between num of min,max `long` values.
`static int`	`compare(double lhs, double rhs)` Compares two `doubles` for order.
`static int`	`compare(float lhs, float rhs)` Compares two floats for order.
`static BigDecimal`	`createBigDecimal(String val)` Convert a `String` to a `BigDecimal`.
`static BigInteger`	`createBigInteger(String val)` Convert a `String` to a `BigInteger`.
`static Double`	`createDouble(String val)` Convert a `String` to a `Double`.
`static Float`	`createFloat(String val)` Convert a `String` to a `Float`.
`static Integer`	`createInteger(String val)` Convert a `String` to a `Integer`, handling hex and octal notations.
`static Long`	`createLong(String val)` Convert a `String` to a `Long`.
`static Number`	`createNumber(String val)` Turns a string value into a java.lang.Number.
`static BigInteger`	`createUnsignedLong(long value)` Convert a `long` to a Unsigned `Long`.
`static Number`	`divide(Number obj1, Number obj2, int precision, RoundingMode roundingEnum)` 除
`static boolean`	`eq(Number obj1, Number obj2)` 相等
`static int`	`getNumericType(Object value)`
`static boolean`	`gt(Number obj1, Number obj2)` 大于
`static boolean`	`gteq(Number obj1, Number obj2)` 大于等于
`static boolean`	`isBoolean(Object object)`
`static boolean`	`isByteNumber(Object number)`
`static boolean`	`isByteType(Class<?> targetType)`
`static boolean`	`isCharacter(Object number)`
`static boolean`	`isDecimal(Number tester)` 测试是否为一个小数
`static boolean`	`isDigits(String str)` Checks whether the `String` contains only digit characters.
`static boolean`	`isDoubleNumber(Object number)`
`static boolean`	`isDoubleType(Class<?> targetType)`
`static boolean`	`isFloatNumber(Object number)`
`static boolean`	`isFloatType(Class<?> targetType)`
`static boolean`	`isIntegerNumber(Object number)`
`static boolean`	`isIntType(Class<?> targetType)`
`static boolean`	`isLongNumber(Object number)`
`static boolean`	`isLongType(Class<?> targetType)`
`static boolean`	`isNumber(Object object)`
`static boolean`	`isNumber(String str)` Checks whether the String a valid Java number.
`static boolean`	`isShortNumber(Object number)`
`static boolean`	`isShortType(Class<?> targetType)`
`static boolean`	`lt(Number obj1, Number obj2)` 小于
`static boolean`	`lteq(Number obj1, Number obj2)` 小于等于
`static int`	`maximum(int a, int b, int c)` Gets the maximum of three `int` values.
`static long`	`maximum(long a, long b, long c)` Gets the maximum of three `long` values.
`static int`	`minimum(int a, int b, int c)` Gets the minimum of three `int` values.
`static long`	`minimum(long a, long b, long c)` Gets the minimum of three `long` values.
`static Number`	`mod(Number obj1, Number obj2)` 求余
`static Number`	`multiply(Number obj1, Number obj2)` 乘
`static Number`	`negate(Number obj)` 取反，相当于：value * -1
`static Number`	`or(Number obj1, Number obj2)` 或
`static BigDecimal`	`round(BigDecimal number, int scale)` 保留固定位数小数采用四舍五入策略 `RoundingMode.HALF_UP` 例如保留2位小数：123.456789 => 123.46
`static BigDecimal`	`round(BigDecimal number, int scale, RoundingMode roundingMode)` 保留固定位数小数例如保留四位小数：123.456789 => 123.4567
`static BigDecimal`	`round(double v, int scale)` 保留固定位数小数采用四舍五入策略 `RoundingMode.HALF_UP` 例如保留2位小数：123.456789 => 123.46
`static BigDecimal`	`round(double v, int scale, RoundingMode roundingMode)` 保留固定位数小数例如保留四位小数：123.456789 => 123.4567
`static BigDecimal`	`round(String numberStr, int scale)` 保留固定位数小数采用四舍五入策略 `RoundingMode.HALF_UP` 例如保留2位小数：123.456789 => 123.46
`static BigDecimal`	`round(String numberStr, int scale, RoundingMode roundingMode)` 保留固定位数小数例如保留四位小数：123.456789 => 123.4567
`static BigDecimal`	`roundDown(BigDecimal value, int scale)` 保留固定小数位数，舍去多余位数
`static BigDecimal`	`roundDown(Number number, int scale)` 保留固定小数位数，舍去多余位数
`static BigDecimal`	`roundHalfEven(BigDecimal value, int scale)` 四舍六入五成双计算法四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
`static BigDecimal`	`roundHalfEven(Number number, int scale)` 四舍六入五成双计算法四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
`static String`	`roundStr(double v, int scale)` 保留固定位数小数采用四舍五入策略 `RoundingMode.HALF_UP` 例如保留2位小数：123.456789 => 123.46
`static String`	`roundStr(double v, int scale, RoundingMode roundingMode)` 保留固定位数小数例如保留四位小数：123.456789 => 123.4567
`static String`	`roundStr(String numberStr, int scale)` 保留固定位数小数采用四舍五入策略 `RoundingMode.HALF_UP` 例如保留2位小数：123.456789 => 123.46
`static String`	`roundStr(String numberStr, int scale, RoundingMode roundingMode)` 保留固定位数小数例如保留四位小数：123.456789 => 123.4567
`static Number`	`shiftLeft(Number obj1, Number obj2)` 左位移
`static Number`	`shiftRight(Number obj1, Number obj2)` 右位移
`static Number`	`shiftRightWithUnsigned(Number obj1, Number obj2)` 无符号右位移
`static int`	`stringToInt(String str)` Convert a `String` to an `int`, returning `zero` if the conversion fails.
`static int`	`stringToInt(String str, int defaultValue)` Convert a `String` to an `int`, returning a default value if the conversion fails.
`static Number`	`subtract(Number obj1, Number obj2)` 减
`static Number`	`xor(Number obj1, Number obj2)` 异或

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NumberUtils
```
public NumberUtils()
```
    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.
- 方法详细资料
  - stringToInt
```
public static int stringToInt(String str)
```
    Convert a String to an int, returning zero if the conversion fails.
    
    参数:
    
    str - the string to convert
    
    返回:
    
    the int represented by the string, or zero if conversion fails
  - stringToInt
```
public static int stringToInt(String str,
                              int defaultValue)
```
    Convert a String to an int, returning a default value if the conversion fails.
    
    参数:
    
    str - the string to convert
    
    defaultValue - the default value
    
    返回:
    
    the int represented by the string, or the default if conversion fails
  - createNumber
```
public static Number createNumber(String val)
                           throws NumberFormatException
```
    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 hold 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.
    
    参数:
    
    val - String containing a number
    
    返回:
    
    Number created from the string
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createFloat
```
public static Float createFloat(String val)
```
    Convert a String to a Float.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted Float
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createDouble
```
public static Double createDouble(String val)
```
    Convert a String to a Double.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted Double
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createInteger
```
public static Integer createInteger(String val)
```
    Convert a String to a Integer, handling hex and octal notations.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted Integer
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createLong
```
public static Long createLong(String val)
```
    Convert a String to a Long.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted Long
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createUnsignedLong
```
public static BigInteger createUnsignedLong(long value)
```
    Convert a long to a Unsigned Long.
    
    参数:
    
    value - a String to convert
    
    返回:
    
    converted Long
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createBigInteger
```
public static BigInteger createBigInteger(String val)
```
    Convert a String to a BigInteger.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted BigInteger
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - createBigDecimal
```
public static BigDecimal createBigDecimal(String val)
```
    Convert a String to a BigDecimal.
    
    参数:
    
    val - a String to convert
    
    返回:
    
    converted BigDecimal
    
    抛出:
    
    NumberFormatException - if the value cannot be converted
  - minimum
```
public static long minimum(long a,
                           long b,
                           long c)
```
    Gets the minimum of three long values.
    
    参数:
    
    a - value 1
    
    b - value 2
    
    c - value 3
    
    返回:
    
    the smallest of the values
  - minimum
```
public static int minimum(int a,
                          int b,
                          int c)
```
    Gets the minimum of three int values.
    
    参数:
    
    a - value 1
    
    b - value 2
    
    c - value 3
    
    返回:
    
    the smallest of the values
  - maximum
```
public static long maximum(long a,
                           long b,
                           long c)
```
    Gets the maximum of three long values.
    
    参数:
    
    a - value 1
    
    b - value 2
    
    c - value 3
    
    返回:
    
    the largest of the values
  - maximum
```
public static int maximum(int a,
                          int b,
                          int c)
```
    Gets the maximum of three int values.
    
    参数:
    
    a - value 1
    
    b - value 2
    
    c - value 3
    
    返回:
    
    the largest of the values
  - between
```
public static long between(long value,
                           long min,
                           long max)
```
    Gets the between num of min,max long values.
    
    参数:
    
    value - value 1
    
    min - value 2
    
    max - value 3
  - between
```
public static int between(int value,
                          int min,
                          int max)
```
    Gets the between num of min,max int values.
    
    参数:
    
    value - value 1
    
    min - value 2
    
    max - value 3
  - between
```
public static float between(float value,
                            float min,
                            float max)
```
    Gets the between num of min,max float values.
    
    参数:
    
    value - value 1
    
    min - value 2
    
    max - value 3
  - between
```
public static double between(double value,
                             double min,
                             double max)
```
    Gets the between num of min,max double values.
    
    参数:
    
    value - value 1
    
    min - value 2
    
    max - value 3
  - compare
```
public static int compare(double lhs,
                          double rhs)
```
    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.
    参数:
    
    lhs - the first double
    
    rhs - the second double
    
    返回:
    
    -1 if lhs is less, +1 if greater, 0 if equal to rhs
  - compare
```
public static int compare(float lhs,
                          float rhs)
```
    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.
    参数:
    
    lhs - the first float
    
    rhs - the second float
    
    返回:
    
    -1 if lhs is less, +1 if greater, 0 if equal to rhs
  - isDigits
```
public static boolean isDigits(String str)
```
    Checks whether the String contains only digit characters.
    
    Null and empty String will return false.
    
    参数:
    
    str - the String to check
    
    返回:
    
    true if str contains only unicode numeric
  - isNumber
```
public static boolean isNumber(String str)
```
    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.
    
    参数:
    
    str - the String to check
    
    返回:
    
    true if the string is a correctly formatted number
  - isByteType
```
public static boolean isByteType(Class<?> targetType)
```
  - isShortType
```
public static boolean isShortType(Class<?> targetType)
```
  - isIntType
```
public static boolean isIntType(Class<?> targetType)
```
  - isLongType
```
public static boolean isLongType(Class<?> targetType)
```
  - isFloatType
```
public static boolean isFloatType(Class<?> targetType)
```
  - isDoubleType
```
public static boolean isDoubleType(Class<?> targetType)
```
  - isNumber
```
public static boolean isNumber(Object object)
```
  - isBoolean
```
public static boolean isBoolean(Object object)
```
  - isByteNumber
```
public static boolean isByteNumber(Object number)
```
  - isShortNumber
```
public static boolean isShortNumber(Object number)
```
  - isIntegerNumber
```
public static boolean isIntegerNumber(Object number)
```
  - isCharacter
```
public static boolean isCharacter(Object number)
```
  - isLongNumber
```
public static boolean isLongNumber(Object number)
```
  - isFloatNumber
```
public static boolean isFloatNumber(Object number)
```
  - isDoubleNumber
```
public static boolean isDoubleNumber(Object number)
```
  - getNumericType
```
public static int getNumericType(Object value)
```
  - add
```
public static Number add(Number obj1,
                         Number obj2)
```
    加
  - subtract
```
public static Number subtract(Number obj1,
                              Number obj2)
```
    减
  - multiply
```
public static Number multiply(Number obj1,
                              Number obj2)
```
    乘
  - divide
```
public static Number divide(Number obj1,
                            Number obj2,
                            int precision,
                            RoundingMode roundingEnum)
```
    除
  - aliquot
```
public static Number aliquot(Number obj1,
                             Number obj2)
```
    整除
  - mod
```
public static Number mod(Number obj1,
                         Number obj2)
```
    求余
  - negate
```
public static Number negate(Number obj)
```
    取反，相当于：value * -1
  - isDecimal
```
public static boolean isDecimal(Number tester)
```
    测试是否为一个小数
  - eq
```
public static boolean eq(Number obj1,
                         Number obj2)
```
    相等
  - gt
```
public static boolean gt(Number obj1,
                         Number obj2)
```
    大于
  - gteq
```
public static boolean gteq(Number obj1,
                           Number obj2)
```
    大于等于
  - lt
```
public static boolean lt(Number obj1,
                         Number obj2)
```
    小于
  - lteq
```
public static boolean lteq(Number obj1,
                           Number obj2)
```
    小于等于
  - and
```
public static Number and(Number obj1,
                         Number obj2)
```
    与
  - or
```
public static Number or(Number obj1,
                        Number obj2)
```
    或
  - xor
```
public static Number xor(Number obj1,
                         Number obj2)
```
    异或
  - shiftLeft
```
public static Number shiftLeft(Number obj1,
                               Number obj2)
```
    左位移
  - shiftRight
```
public static Number shiftRight(Number obj1,
                                Number obj2)
```
    右位移
  - shiftRightWithUnsigned
```
public static Number shiftRightWithUnsigned(Number obj1,
                                            Number obj2)
```
    无符号右位移
  - round
```
public static BigDecimal round(double v,
                               int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 => 123.46
    
    参数:
    
    v - 值
    
    scale - 保留小数位数
    
    返回:
    
    新值
  - roundStr
```
public static String roundStr(double v,
                              int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 => 123.46
    
    参数:
    
    v - 值
    
    scale - 保留小数位数
    
    返回:
    
    新值
  - round
```
public static BigDecimal round(String numberStr,
                               int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 => 123.46
    
    参数:
    
    numberStr - 数字值的字符串表现形式
    
    scale - 保留小数位数
    
    返回:
    
    新值
  - round
```
public static BigDecimal round(BigDecimal number,
                               int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 => 123.46
    
    参数:
    
    number - 数字值
    
    scale - 保留小数位数
    
    返回:
    
    新值
    
    从以下版本开始:
    
    4.1.0
  - roundStr
```
public static String roundStr(String numberStr,
                              int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 => 123.46
    
    参数:
    
    numberStr - 数字值的字符串表现形式
    
    scale - 保留小数位数
    
    返回:
    
    新值
    
    从以下版本开始:
    
    3.2.2
  - round
```
public static BigDecimal round(double v,
                               int scale,
                               RoundingMode roundingMode)
```
    保留固定位数小数
    例如保留四位小数：123.456789 => 123.4567
    
    参数:
    
    v - 值
    
    scale - 保留小数位数
    
    roundingMode - 保留小数的模式 RoundingMode
    
    返回:
    
    新值
  - roundStr
```
public static String roundStr(double v,
                              int scale,
                              RoundingMode roundingMode)
```
    保留固定位数小数
    例如保留四位小数：123.456789 => 123.4567
    
    参数:
    
    v - 值
    
    scale - 保留小数位数
    
    roundingMode - 保留小数的模式 RoundingMode
    
    返回:
    
    新值
    
    从以下版本开始:
    
    3.2.2
  - round
```
public static BigDecimal round(String numberStr,
                               int scale,
                               RoundingMode roundingMode)
```
    保留固定位数小数
    例如保留四位小数：123.456789 => 123.4567
    
    参数:
    
    numberStr - 数字值的字符串表现形式
    
    scale - 保留小数位数，如果传入小于0，则默认0
    
    roundingMode - 保留小数的模式 RoundingMode，如果传入null则默认四舍五入
    
    返回:
    
    新值
  - round
```
public static BigDecimal round(BigDecimal number,
                               int scale,
                               RoundingMode roundingMode)
```
    保留固定位数小数
    例如保留四位小数：123.456789 => 123.4567
    
    参数:
    
    number - 数字值
    
    scale - 保留小数位数，如果传入小于0，则默认0
    
    roundingMode - 保留小数的模式 RoundingMode，如果传入null则默认四舍五入
    
    返回:
    
    新值
  - roundStr
```
public static String roundStr(String numberStr,
                              int scale,
                              RoundingMode roundingMode)
```
    保留固定位数小数
    例如保留四位小数：123.456789 => 123.4567
    
    参数:
    
    numberStr - 数字值的字符串表现形式
    
    scale - 保留小数位数
    
    roundingMode - 保留小数的模式 RoundingMode
    
    返回:
    
    新值
    
    从以下版本开始:
    
    3.2.2
  - roundHalfEven
```
public static BigDecimal roundHalfEven(Number number,
                                       int scale)
```
    四舍六入五成双计算法
    四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
```
 算法规则:
 四舍六入五考虑，
 五后非零就进一，
 五后皆零看奇偶，
 五前为偶应舍去，
 五前为奇要进一。
 
```
    参数:
    
    number - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
    
    从以下版本开始:
    
    4.1.0
  - roundHalfEven
```
public static BigDecimal roundHalfEven(BigDecimal value,
                                       int scale)
```
    四舍六入五成双计算法
    四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
```
 算法规则:
 四舍六入五考虑，
 五后非零就进一，
 五后皆零看奇偶，
 五前为偶应舍去，
 五前为奇要进一。
 
```
    参数:
    
    value - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
    
    从以下版本开始:
    
    4.1.0
  - roundDown
```
public static BigDecimal roundDown(Number number,
                                   int scale)
```
    保留固定小数位数，舍去多余位数
    
    参数:
    
    number - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
    
    从以下版本开始:
    
    4.1.0
  - roundDown
```
public static BigDecimal roundDown(BigDecimal value,
                                   int scale)
```
    保留固定小数位数，舍去多余位数
    
    参数:
    
    value - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
    
    从以下版本开始:
    
    4.1.0

类 NumberUtils

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

NumberUtils

方法详细资料

stringToInt

stringToInt

createNumber

createFloat

createDouble

createInteger

createLong

createUnsignedLong

createBigInteger

createBigDecimal

minimum

minimum

maximum

maximum

between

between

between

between

compare

compare

isDigits

isNumber

isByteType

isShortType

isIntType

isLongType

isFloatType

isDoubleType

isNumber

isBoolean

isByteNumber

isShortNumber

isIntegerNumber

isCharacter

isLongNumber

isFloatNumber

isDoubleNumber

getNumericType

add

subtract

multiply

divide

aliquot

mod

negate

isDecimal

eq

gt

gteq

lt

lteq

and

or

xor

shiftLeft

shiftRight

shiftRightWithUnsigned

round

roundStr

round

round

roundStr

round

roundStr

round

round

roundStr

roundHalfEven

roundHalfEven

roundDown

roundDown