cn.ponfee.commons.io

枚举 HumanReadables

java.lang.Object

java.lang.Enum<HumanReadables>

cn.ponfee.commons.io.HumanReadables

所有已实现的接口:

Serializable, Comparable<HumanReadables>

public enum HumanReadables
extends Enum<HumanReadables>

The file size human readable utility class, provide mutual conversions from human readable size to byte size

The similar function in stackoverflow, linked: https://stackoverflow.com/questions/3758606/how-to-convert-byte-size-into-human-readable-format-in-java?r=SearchResults

Apache also provide similar function FileUtils.byteCountToDisplaySize(long)

spring-core 5.x: org.springframework.util.unit.DataSize

作者:

Ponfee

枚举常量概要

枚举常量

枚举常量和说明
BINARY
SI

方法概要

限定符和类型	方法和说明
int	base()
String	human(long size) Returns a string of bytes count human-readable size
long	parse(String size)
long	parse(String size, boolean strict) Parse the readable byte count, allowed suffix units: "1", "1 B", "1 MB", "1 MiB", "1 M"
long[]	sizes()
String[]	units()
static HumanReadables	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static HumanReadables[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

SI

public static final HumanReadables SI

BINARY

public static final HumanReadables BINARY

方法详细资料

values

public static HumanReadables[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (HumanReadables c : HumanReadables.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static HumanReadables valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

human

public String human(long size)

Returns a string of bytes count human-readable size

参数:

size - the size

返回:

string of human-readable data size

parse

public long parse(String size)

parse

public long parse(String size,
                  boolean strict)

Parse the readable byte count, allowed suffix units: "1", "1 B", "1 MB", "1 MiB", "1 M"

参数:

size - the size

strict - the strict, if BINARY then verify whether contains "i"

返回:

a long value bytes count

base

public int base()

units

public String[] units()

sizes

public long[] sizes()