DataSize (hutool-core 5.8.9 API)

java.lang.Object
- cn.hutool.core.io.unit.DataSize

所有已实现的接口:: Comparable<DataSize>

public final class DataSize
extends Object
implements Comparable<DataSize>

数据大小，可以将类似于'12MB'表示转换为bytes长度的数字

此类来自于：Spring-framework

     byte        1B     1
     kilobyte    1KB    1,024
     megabyte    1MB    1,048,576
     gigabyte    1GB    1,073,741,824
     terabyte    1TB    1,099,511,627,776

从以下版本开始:: 5.3.10
作者:: Sam Brannen,Stephane Nicoll

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`int`	`compareTo(DataSize other)`
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`boolean`	`isNegative()` 是否为负数，不包括0
`static DataSize`	`of(BigDecimal amount, DataUnit unit)` 获得指定`DataUnit`对应的DataSize
`static DataSize`	`of(long amount, DataUnit unit)` 获得指定`DataUnit`对应的DataSize
`static DataSize`	`ofBytes(long bytes)` 获得对应bytes的DataSize
`static DataSize`	`ofGigabytes(long gigabytes)` 获得对应gigabytes的DataSize
`static DataSize`	`ofKilobytes(long kilobytes)` 获得对应kilobytes的DataSize
`static DataSize`	`ofMegabytes(long megabytes)` 获得对应megabytes的DataSize
`static DataSize`	`ofTerabytes(long terabytes)` 获得对应terabytes的DataSize
`static DataSize`	`parse(CharSequence text)` 获取指定数据大小文本对应的DataSize对象，如果无单位指定，默认获取`DataUnit.BYTES` 例如： "12KB" -- parses as "12 kilobytes" "5MB" -- parses as "5 megabytes" "20" -- parses as "20 bytes"
`static DataSize`	`parse(CharSequence text, DataUnit defaultUnit)` Obtain a DataSize from a text string such as `12MB` using the specified default `DataUnit` if no unit is specified.
`long`	`toBytes()` 返回bytes大小
`long`	`toGigabytes()` 返回GB大小
`long`	`toKilobytes()` 返回KB大小
`long`	`toMegabytes()` 返回MB大小
`String`	`toString()`
`long`	`toTerabytes()` 返回TB大小

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

- 方法详细资料
  - ofBytes
```
public static DataSize ofBytes(long bytes)
```
    获得对应bytes的DataSize
    
    参数:
    
    bytes - bytes大小，可正可负
    
    返回:
    
    this
  - ofKilobytes
```
public static DataSize ofKilobytes(long kilobytes)
```
    获得对应kilobytes的DataSize
    
    参数:
    
    kilobytes - kilobytes大小，可正可负
    
    返回:
    
    a DataSize
  - ofMegabytes
```
public static DataSize ofMegabytes(long megabytes)
```
    获得对应megabytes的DataSize
    
    参数:
    
    megabytes - megabytes大小，可正可负
    
    返回:
    
    a DataSize
  - ofGigabytes
```
public static DataSize ofGigabytes(long gigabytes)
```
    获得对应gigabytes的DataSize
    
    参数:
    
    gigabytes - gigabytes大小，可正可负
    
    返回:
    
    a DataSize
  - ofTerabytes
```
public static DataSize ofTerabytes(long terabytes)
```
    获得对应terabytes的DataSize
    
    参数:
    
    terabytes - terabytes大小，可正可负
    
    返回:
    
    a DataSize
  - of
```
public static DataSize of(long amount,
                          DataUnit unit)
```
    获得指定DataUnit对应的DataSize
    
    参数:
    
    amount - 大小
    
    unit - 数据大小单位，null表示默认的BYTES
    
    返回:
    
    DataSize
  - of
```
public static DataSize of(BigDecimal amount,
                          DataUnit unit)
```
    获得指定DataUnit对应的DataSize
    
    参数:
    
    amount - 大小
    
    unit - 数据大小单位，null表示默认的BYTES
    
    返回:
    
    DataSize
    
    从以下版本开始:
    
    5.4.5
  - parse
```
public static DataSize parse(CharSequence text)
```
    获取指定数据大小文本对应的DataSize对象，如果无单位指定，默认获取DataUnit.BYTES
    例如：
```
 "12KB" -- parses as "12 kilobytes"
 "5MB"  -- parses as "5 megabytes"
 "20"   -- parses as "20 bytes"
 
```
    参数:
    
    text - the text to parse
    
    返回:
    
    the parsed DataSize
    
    另请参阅:
    
    parse(CharSequence, DataUnit)
  - parse
```
public static DataSize parse(CharSequence text,
                             DataUnit defaultUnit)
```
    Obtain a DataSize from a text string such as 12MB using the specified default DataUnit if no unit is specified.
    The string starts with a number followed optionally by a unit matching one of the supported suffixes.
    Examples:
```
 "12KB" -- parses as "12 kilobytes"
 "5MB"  -- parses as "5 megabytes"
 "20"   -- parses as "20 kilobytes" (where the  defaultUnit is DataUnit.KILOBYTES)
 
```
    参数:
    
    text - the text to parse
    
    defaultUnit - 默认的数据单位
    
    返回:
    
    the parsed DataSize
  - isNegative
```
public boolean isNegative()
```
    是否为负数，不包括0
    
    返回:
    
    负数返回true，否则false
  - toBytes
```
public long toBytes()
```
    返回bytes大小
    
    返回:
    
    bytes大小
  - toKilobytes
```
public long toKilobytes()
```
    返回KB大小
    
    返回:
    
    KB大小
  - toMegabytes
```
public long toMegabytes()
```
    返回MB大小
    
    返回:
    
    MB大小
  - toGigabytes
```
public long toGigabytes()
```
    返回GB大小
    
    返回:
    
    GB大小
  - toTerabytes
```
public long toTerabytes()
```
    返回TB大小
    
    返回:
    
    TB大小
  - compareTo
```
public int compareTo(DataSize other)
```
    指定者:
    
    compareTo 在接口中 Comparable<DataSize>
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object other)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object

类 DataSize

方法概要

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

方法详细资料

ofBytes

ofKilobytes

ofMegabytes

ofGigabytes

ofTerabytes

of

of

parse

parse

isNegative

toBytes

toKilobytes

toMegabytes

toGigabytes

toTerabytes

compareTo

toString

equals

hashCode