NumberUtils (MustardTools 0.2.5 API)

java.lang.Object
- cn.buli_home.utils.common.NumberUtils

```
public class NumberUtils
extends Object
```
数字工具类

版本:

1.0 Create by 2022/9/29

作者:

mustard

构造器概要

构造器
构造器和说明

NumberUtils()

构造器
构造器和说明
`NumberUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`equals(BigDecimal bigNum1, BigDecimal bigNum2)` 比较大小，值相等返回true 此方法通过调用`BigDecimal.compareTo(BigDecimal)`方法来判断是否相等此方法判断值相等时忽略精度的，即0.00 == 0
`static boolean`	`equals(double num1, double num2)` 比较大小，值相等返回true 此方法通过调用`Double.doubleToLongBits(double)`方法来判断是否相等此方法判断值相等时忽略精度的，即0.00 == 0
`static boolean`	`equals(float num1, float num2)` 比较大小，值相等返回true 此方法通过调用`Float.floatToIntBits(float)`方法来判断是否相等此方法判断值相等时忽略精度的，即0.00 == 0
`static boolean`	`equals(long num1, long num2)` 比较大小，值相等返回true 此方法修复传入long型数据由于没有本类型重载方法,导致数据精度丢失
`static boolean`	`equals(Number number1, Number number2)` 比较数字值是否相等，相等返回`true` 需要注意的是`BigDecimal`需要特殊处理 BigDecimal使用compareTo方式判断，因为使用equals方法也判断小数位数，如2.0和2.00就不相等，此方法判断值相等时忽略精度的，即0.00 == 0 如果用户提供两个Number都是`BigDecimal`，则通过调用`BigDecimal.compareTo(BigDecimal)`方法来判断是否相等其他情况调用`Object.equals(Object)`比较
`static boolean`	`isValid(double number)` 检查是否为有效的数字检查double否为无限大，或者Not a Number（NaN）
`static boolean`	`isValid(float number)` 检查是否为有效的数字检查double否为无限大，或者Not a Number（NaN）
`static boolean`	`isValidNumber(Number number)` 检查是否为有效的数字检查Double和Float是否为无限大，或者Not a Number 非数字类型和Null将返回false
`static double`	`parseDouble(String number)` 解析转换数字字符串为long型数字，规则如下： 1、0开头的忽略开头的0 2、空串返回0 3、其它情况按照10进制转换 4、.123形式返回0.123（按照小于0的小数对待）
`static Double`	`parseDouble(String numberStr, Double defaultValue)` 解析转换数字字符串为 `Double` 规则如下： 1、0开头的忽略开头的0 2、空串返回0 3、其它情况按照10进制转换 4、.123形式返回0.123（按照小于0的小数对待）
`static float`	`parseFloat(String number)` 解析转换数字字符串为long型数字，规则如下： 1、0开头的忽略开头的0 2、空串返回0 3、其它情况按照10进制转换 4、.123形式返回0.123（按照小于0的小数对待）
`static Float`	`parseFloat(String numberStr, Float defaultValue)` 解析转换数字字符串为 `Float` 规则如下： 1、0开头的忽略开头的0 2、空串返回0 3、其它情况按照10进制转换 4、.123形式返回0.123（按照小于0的小数对待）
`static int`	`parseInt(String number)` 解析转换数字字符串为int型数字，规则如下： 1、0x开头的视为16进制数字 2、0开头的忽略开头的0 3、其它情况按照10进制转换 4、空串返回0 5、.123形式返回0（按照小于0的小数对待） 6、123.56截取小数点之前的数字，忽略小数部分
`static Integer`	`parseInt(String numberStr, Integer defaultValue)` 解析转换数字字符串为 `Integer` 规则如下： 1、0x开头的视为16进制数字 2、0开头的忽略开头的0 3、其它情况按照10进制转换 4、空串返回0 5、.123形式返回0（按照小于0的小数对待） 6、123.56截取小数点之前的数字，忽略小数部分 7、解析失败返回默认值
`static long`	`parseLong(String number)` 解析转换数字字符串为long型数字，规则如下： 1、0x开头的视为16进制数字 2、0开头的忽略开头的0 3、空串返回0 4、其它情况按照10进制转换 5、.123形式返回0（按照小于0的小数对待） 6、123.56截取小数点之前的数字，忽略小数部分
`static Long`	`parseLong(String numberStr, Long defaultValue)` 解析转换数字字符串为 `Long` 规则如下： 1、0x开头的视为16进制数字 2、0开头的忽略开头的0 3、其它情况按照10进制转换 4、空串返回0 5、.123形式返回0（按照小于0的小数对待） 6、123.56截取小数点之前的数字，忽略小数部分 7、解析失败返回默认值
`static Number`	`parseNumber(String numberStr)` 将指定字符串转换为`Number` 对象此方法不支持科学计数法需要注意的是，在不同Locale下，数字的表示形式也是不同的，例如：德国、荷兰、比利时、丹麦、意大利、罗马尼亚和欧洲大多地区使用`,`区分小数也就是说，在这些国家地区，1.20表示120，而非1.2。
`static Number`	`parseNumber(String numberStr, Number defaultValue)` 将指定字符串转换为`Number` 此方法不支持科学计数法
`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 BigDecimal`	`toBigDecimal(Number number)` 数字转`BigDecimal` Float、Double等有精度问题，转换为字符串后再转换 null转换为0
`static BigDecimal`	`toBigDecimal(String numberStr)` 数字转`BigDecimal` null或""或空白符转换为0
`static BigInteger`	`toBigInteger(Number number)` 数字转`BigInteger` null转换为0
`static BigInteger`	`toBigInteger(String number)` 数字转`BigInteger` null或""或空白符转换为0

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

- 构造器详细资料
  - NumberUtils
```
public NumberUtils()
```
- 方法详细资料
  - isValidNumber
```
public static boolean isValidNumber(Number number)
```
    检查是否为有效的数字
    检查Double和Float是否为无限大，或者Not a Number
    非数字类型和Null将返回false
    
    参数:
    
    number - 被检查类型
    
    返回:
    
    检查结果，非数字类型和Null将返回false
  - isValid
```
public static boolean isValid(double number)
```
    检查是否为有效的数字
    检查double否为无限大，或者Not a Number（NaN）
    
    参数:
    
    number - 被检查double
    
    返回:
    
    检查结果
  - isValid
```
public static boolean isValid(float number)
```
    检查是否为有效的数字
    检查double否为无限大，或者Not a Number（NaN）
    
    参数:
    
    number - 被检查double
    
    返回:
    
    检查结果
  - equals
```
public static boolean equals(double num1,
                             double num2)
```
    比较大小，值相等返回true
    此方法通过调用Double.doubleToLongBits(double)方法来判断是否相等
    此方法判断值相等时忽略精度的，即0.00 == 0
    
    参数:
    
    num1 - 数字1
    
    num2 - 数字2
    
    返回:
    
    是否相等
  - equals
```
public static boolean equals(float num1,
                             float num2)
```
    比较大小，值相等返回true
    此方法通过调用Float.floatToIntBits(float)方法来判断是否相等
    此方法判断值相等时忽略精度的，即0.00 == 0
    
    参数:
    
    num1 - 数字1
    
    num2 - 数字2
    
    返回:
    
    是否相等
  - equals
```
public static boolean equals(long num1,
                             long num2)
```
    比较大小，值相等返回true
    此方法修复传入long型数据由于没有本类型重载方法,导致数据精度丢失
    
    参数:
    
    num1 - 数字1
    
    num2 - 数字2
    
    返回:
    
    是否相等
  - equals
```
public static boolean equals(Number number1,
                             Number number2)
```
    比较数字值是否相等，相等返回true
    需要注意的是BigDecimal需要特殊处理
    BigDecimal使用compareTo方式判断，因为使用equals方法也判断小数位数，如2.0和2.00就不相等，
    此方法判断值相等时忽略精度的，即0.00 == 0
    - 如果用户提供两个Number都是BigDecimal，则通过调用BigDecimal.compareTo(BigDecimal)方法来判断是否相等
    - 其他情况调用Object.equals(Object)比较
    参数:
    
    number1 - 数字1
    
    number2 - 数字2
    
    返回:
    
    是否相等
    
    另请参阅:
    
    Objects.equals(Object, Object)
  - equals
```
public static boolean equals(BigDecimal bigNum1,
                             BigDecimal bigNum2)
```
    比较大小，值相等返回true
    此方法通过调用BigDecimal.compareTo(BigDecimal)方法来判断是否相等
    此方法判断值相等时忽略精度的，即0.00 == 0
    
    参数:
    
    bigNum1 - 数字1
    
    bigNum2 - 数字2
    
    返回:
    
    是否相等
  - 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 - 保留小数位数
    
    返回:
    
    新值
  - roundStr
```
public static String roundStr(String numberStr,
                              int scale)
```
    保留固定位数小数
    采用四舍五入策略 RoundingMode.HALF_UP
    例如保留2位小数：123.456789 =》 123.46
    
    参数:
    
    numberStr - 数字值的字符串表现形式
    
    scale - 保留小数位数
    
    返回:
    
    新值
  - 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
    
    返回:
    
    新值
  - 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
    
    返回:
    
    新值
  - roundHalfEven
```
public static BigDecimal roundHalfEven(Number number,
                                       int scale)
```
    四舍六入五成双计算法
    四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
```
 算法规则:
 四舍六入五考虑，
 五后非零就进一，
 五后皆零看奇偶，
 五前为偶应舍去，
 五前为奇要进一。
 
```
    参数:
    
    number - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
  - roundHalfEven
```
public static BigDecimal roundHalfEven(BigDecimal value,
                                       int scale)
```
    四舍六入五成双计算法
    四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。
```
 算法规则:
 四舍六入五考虑，
 五后非零就进一，
 五后皆零看奇偶，
 五前为偶应舍去，
 五前为奇要进一。
 
```
    参数:
    
    value - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
  - roundDown
```
public static BigDecimal roundDown(Number number,
                                   int scale)
```
    保留固定小数位数，舍去多余位数
    
    参数:
    
    number - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
  - roundDown
```
public static BigDecimal roundDown(BigDecimal value,
                                   int scale)
```
    保留固定小数位数，舍去多余位数
    
    参数:
    
    value - 需要科学计算的数据
    
    scale - 保留的小数位
    
    返回:
    
    结果
  - toBigDecimal
```
public static BigDecimal toBigDecimal(Number number)
```
    数字转BigDecimal
    Float、Double等有精度问题，转换为字符串后再转换
    null转换为0
    
    参数:
    
    number - 数字
    
    返回:
    
    BigDecimal
  - toBigDecimal
```
public static BigDecimal toBigDecimal(String numberStr)
```
    数字转BigDecimal
    null或""或空白符转换为0
    
    参数:
    
    numberStr - 数字字符串
    
    返回:
    
    BigDecimal
  - toBigInteger
```
public static BigInteger toBigInteger(Number number)
```
    数字转BigInteger
    null转换为0
    
    参数:
    
    number - 数字
    
    返回:
    
    BigInteger
  - toBigInteger
```
public static BigInteger toBigInteger(String number)
```
    数字转BigInteger
    null或""或空白符转换为0
    
    参数:
    
    number - 数字字符串
    
    返回:
    
    BigInteger
  - parseInt
```
public static int parseInt(String number)
                    throws NumberFormatException
```
    解析转换数字字符串为int型数字，规则如下：
```
 1、0x开头的视为16进制数字
 2、0开头的忽略开头的0
 3、其它情况按照10进制转换
 4、空串返回0
 5、.123形式返回0（按照小于0的小数对待）
 6、123.56截取小数点之前的数字，忽略小数部分
 
```
    参数:
    
    number - 数字，支持0x开头、0开头和普通十进制
    
    返回:
    
    int
    
    抛出:
    
    NumberFormatException - 数字格式异常
  - parseLong
```
public static long parseLong(String number)
```
    解析转换数字字符串为long型数字，规则如下：
```
 1、0x开头的视为16进制数字
 2、0开头的忽略开头的0
 3、空串返回0
 4、其它情况按照10进制转换
 5、.123形式返回0（按照小于0的小数对待）
 6、123.56截取小数点之前的数字，忽略小数部分
 
```
    参数:
    
    number - 数字，支持0x开头、0开头和普通十进制
    
    返回:
    
    long
  - parseFloat
```
public static float parseFloat(String number)
```
    解析转换数字字符串为long型数字，规则如下：
```
 1、0开头的忽略开头的0
 2、空串返回0
 3、其它情况按照10进制转换
 4、.123形式返回0.123（按照小于0的小数对待）
 
```
    参数:
    
    number - 数字，支持0x开头、0开头和普通十进制
    
    返回:
    
    long
  - parseDouble
```
public static double parseDouble(String number)
```
    解析转换数字字符串为long型数字，规则如下：
```
 1、0开头的忽略开头的0
 2、空串返回0
 3、其它情况按照10进制转换
 4、.123形式返回0.123（按照小于0的小数对待）
 
```
    参数:
    
    number - 数字，支持0x开头、0开头和普通十进制
    
    返回:
    
    long
  - parseNumber
```
public static Number parseNumber(String numberStr)
                          throws NumberFormatException
```
    将指定字符串转换为Number 对象
    此方法不支持科学计数法
    需要注意的是，在不同Locale下，数字的表示形式也是不同的，例如：
    德国、荷兰、比利时、丹麦、意大利、罗马尼亚和欧洲大多地区使用`,`区分小数
    也就是说，在这些国家地区，1.20表示120，而非1.2。
    
    参数:
    
    numberStr - Number字符串
    
    返回:
    
    Number对象
    
    抛出:
    
    NumberFormatException - 包装了ParseException，当给定的数字字符串无法解析时抛出
  - parseInt
```
public static Integer parseInt(String numberStr,
                               Integer defaultValue)
```
    解析转换数字字符串为 Integer 规则如下：
```
 1、0x开头的视为16进制数字
 2、0开头的忽略开头的0
 3、其它情况按照10进制转换
 4、空串返回0
 5、.123形式返回0（按照小于0的小数对待）
 6、123.56截取小数点之前的数字，忽略小数部分
 7、解析失败返回默认值
 
```
    参数:
    
    numberStr - 数字字符串，支持0x开头、0开头和普通十进制
    
    defaultValue - 如果解析失败, 将返回defaultValue, 允许null
    
    返回:
    
    Integer
  - parseLong
```
public static Long parseLong(String numberStr,
                             Long defaultValue)
```
    解析转换数字字符串为 Long 规则如下：
```
 1、0x开头的视为16进制数字
 2、0开头的忽略开头的0
 3、其它情况按照10进制转换
 4、空串返回0
 5、.123形式返回0（按照小于0的小数对待）
 6、123.56截取小数点之前的数字，忽略小数部分
 7、解析失败返回默认值
 
```
    参数:
    
    numberStr - 数字字符串，支持0x开头、0开头和普通十进制
    
    defaultValue - 如果解析失败, 将返回defaultValue, 允许null
    
    返回:
    
    Long
  - parseFloat
```
public static Float parseFloat(String numberStr,
                               Float defaultValue)
```
    解析转换数字字符串为 Float 规则如下：
```
 1、0开头的忽略开头的0
 2、空串返回0
 3、其它情况按照10进制转换
 4、.123形式返回0.123（按照小于0的小数对待）
 
```
    参数:
    
    numberStr - 数字字符串，支持0x开头、0开头和普通十进制
    
    defaultValue - 如果解析失败, 将返回defaultValue, 允许null
    
    返回:
    
    Float
  - parseDouble
```
public static Double parseDouble(String numberStr,
                                 Double defaultValue)
```
    解析转换数字字符串为 Double 规则如下：
```
 1、0开头的忽略开头的0
 2、空串返回0
 3、其它情况按照10进制转换
 4、.123形式返回0.123（按照小于0的小数对待）
 
```
    参数:
    
    numberStr - 数字字符串，支持0x开头、0开头和普通十进制
    
    defaultValue - 如果解析失败, 将返回defaultValue, 允许null
    
    返回:
    
    Double
  - parseNumber
```
public static Number parseNumber(String numberStr,
                                 Number defaultValue)
```
    将指定字符串转换为Number 此方法不支持科学计数法
    
    参数:
    
    numberStr - Number字符串
    
    defaultValue - 如果解析失败, 将返回defaultValue, 允许null
    
    返回:
    
    Number对象

类 NumberUtils

构造器概要

方法概要

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

构造器详细资料

NumberUtils

方法详细资料

isValidNumber

isValid

isValid

equals

equals

equals

equals

equals

round

roundStr

round

round

roundStr

round

roundStr

round

round

roundStr

roundHalfEven

roundHalfEven

roundDown

roundDown

toBigDecimal

toBigDecimal

toBigInteger

toBigInteger

parseInt

parseLong

parseFloat

parseDouble

parseNumber

parseInt

parseLong

parseFloat

parseDouble

parseNumber