MemorySize (Paimon : Common 0.7.0-incubating API)

java.lang.Object
- org.apache.paimon.options.MemorySize

所有已实现的接口:

Serializable, Comparable<MemorySize>
```
@Public
public class MemorySize
extends Object
implements Serializable, Comparable<MemorySize>
```
MemorySize is a representation of a number of bytes, viewable in different units.
Parsing

The size can be parsed from a text expression. If the expression is a pure number, the value will be interpreted as bytes.

从以下版本开始:

0.4.0

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class MemorySize.MemoryUnit
Enum which defines memory unit, mostly used to parse value from configuration file.

嵌套类
限定符和类型	类和说明
`static class`	`MemorySize.MemoryUnit` Enum which defines memory unit, mostly used to parse value from configuration file.

字段概要

字段
限定符和类型字段和说明

static MemorySize MAX_VALUE

static MemorySize ZERO

字段
限定符和类型	字段和说明
`static MemorySize`	`MAX_VALUE`
`static MemorySize`	`ZERO`

构造器概要

构造器
构造器和说明

MemorySize(long bytes)
Constructs a new MemorySize.

构造器
构造器和说明
`MemorySize(long bytes)` Constructs a new MemorySize.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`MemorySize`	`add(MemorySize that)`
`int`	`compareTo(MemorySize that)`
`MemorySize`	`divide(long by)`
`boolean`	`equals(Object obj)`
`long`	`getBytes()` Gets the memory size in bytes.
`long`	`getGibiBytes()` Gets the memory size in Gibibytes (= 1024 Mebibytes).
`long`	`getKibiBytes()` Gets the memory size in Kibibytes (= 1024 bytes).
`int`	`getMebiBytes()` Gets the memory size in Mebibytes (= 1024 Kibibytes).
`long`	`getTebiBytes()` Gets the memory size in Tebibytes (= 1024 Gibibytes).
`int`	`hashCode()`
`MemorySize`	`multiply(double multiplier)`
`static MemorySize`	`ofKibiBytes(long kibiBytes)`
`static MemorySize`	`ofMebiBytes(long mebiBytes)`
`static MemorySize`	`parse(String text)` Parses the given string as as MemorySize.
`static MemorySize`	`parse(String text, MemorySize.MemoryUnit defaultUnit)` Parses the given string with a default unit.
`static long`	`parseBytes(String text)` Parses the given string as bytes.
`MemorySize`	`subtract(MemorySize that)`
`String`	`toHumanReadableString()`
`String`	`toString()`

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

- 字段详细资料
  - ZERO
```
public static final MemorySize ZERO
```
  - MAX_VALUE
```
public static final MemorySize MAX_VALUE
```
- 构造器详细资料
  - MemorySize
```
public MemorySize(long bytes)
```
    Constructs a new MemorySize.
    
    参数:
    
    bytes - The size, in bytes. Must be zero or larger.
- 方法详细资料
  - ofMebiBytes
```
public static MemorySize ofMebiBytes(long mebiBytes)
```
  - ofKibiBytes
```
public static MemorySize ofKibiBytes(long kibiBytes)
```
  - getBytes
```
public long getBytes()
```
    Gets the memory size in bytes.
  - getKibiBytes
```
public long getKibiBytes()
```
    Gets the memory size in Kibibytes (= 1024 bytes).
  - getMebiBytes
```
public int getMebiBytes()
```
    Gets the memory size in Mebibytes (= 1024 Kibibytes).
  - getGibiBytes
```
public long getGibiBytes()
```
    Gets the memory size in Gibibytes (= 1024 Mebibytes).
  - getTebiBytes
```
public long getTebiBytes()
```
    Gets the memory size in Tebibytes (= 1024 Gibibytes).
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - toHumanReadableString
```
public String toHumanReadableString()
```
  - compareTo
```
public int compareTo(MemorySize that)
```
    指定者:
    
    compareTo 在接口中 Comparable<MemorySize>
  - add
```
public MemorySize add(MemorySize that)
```
  - subtract
```
public MemorySize subtract(MemorySize that)
```
  - multiply
```
public MemorySize multiply(double multiplier)
```
  - divide
```
public MemorySize divide(long by)
```
  - parse
```
public static MemorySize parse(String text)
                        throws IllegalArgumentException
```
    Parses the given string as as MemorySize.
    
    参数:
    
    text - The string to parse
    
    返回:
    
    The parsed MemorySize
    
    抛出:
    
    IllegalArgumentException - Thrown, if the expression cannot be parsed.
  - parse
```
public static MemorySize parse(String text,
                               MemorySize.MemoryUnit defaultUnit)
                        throws IllegalArgumentException
```
    Parses the given string with a default unit.
    
    参数:
    
    text - The string to parse.
    
    defaultUnit - specify the default unit.
    
    返回:
    
    The parsed MemorySize.
    
    抛出:
    
    IllegalArgumentException - Thrown, if the expression cannot be parsed.
  - parseBytes
```
public static long parseBytes(String text)
                       throws IllegalArgumentException
```
    Parses the given string as bytes. The supported expressions are listed under MemorySize.
    
    参数:
    
    text - The string to parse
    
    返回:
    
    The parsed size, in bytes.
    
    抛出:
    
    IllegalArgumentException - Thrown, if the expression cannot be parsed.

类 MemorySize

Parsing

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

ZERO

MAX_VALUE

构造器详细资料

MemorySize

方法详细资料

ofMebiBytes

ofKibiBytes

getBytes

getKibiBytes

getMebiBytes

getGibiBytes

getTebiBytes

hashCode

equals

toString

toHumanReadableString

compareTo

add

subtract

multiply

divide

parse

parse

parseBytes