Package org.aeonbits.owner.util.bytesize

Enum ByteSizeUnit

java.lang.Object

java.lang.Enum<ByteSizeUnit>

org.aeonbits.owner.util.bytesize.ByteSizeUnit

All Implemented Interfaces:

Serializable, Comparable<ByteSizeUnit>

public enum ByteSizeUnit
extends Enum<ByteSizeUnit>

Specifies the available byte size units that a ByteSize can have. A byte size unit has a ByteSizeStandard that dictates the base value to be raised to a given power as well as the power value that dictates the magnitude of the unit. For example, a unit having the SI standard with a power value of 4 is known as a terabyte while a unit having the IEC standard with a power value of 4 is known as a tebibyte. The former has a factor of 1000^4 while the latter has a factor of 1024^4.

Author:

Stefan Freyr Stefansson

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	The base unit.
EXABYTES	The SI exabyte.
EXBIBYTES	The IEC exibyte.
GIBIBYTES	The IEC gibibyte.
GIGABYTES	The SI gigabyte.
KIBIBYTES	The IEC kibibyte.
KILOBYTES	The SI kilobyte.
MEBIBYTES	The IEC mebibyte.
MEGABYTES	The SI megabyte.
PEBIBYTES	The IEC pebibyte.
PETABYTES	The SI petabyte.
TEBIBYTES	The IEC tebibyte.
TERABYTES	The SI terabyte.
YOBIBYTES	The IEC yobibyte.
YOTTABYTES	The SI yottabyte.
ZEBIBYTES	The IEC zebibyte.
ZETTABYTES	The SI zettabyte.

Method Summary

Modifier and Type	Method	Description
BigDecimal	getFactor()	Gets the multiplication factor for this ByteSizeUnit.
boolean	isIEC()	Returns whether this ByteSizeUnit is an IEC unit.
boolean	isSI()	Returns whether this ByteSizeUnit is an SI unit.
static ByteSizeUnit	parse(String unit)	Parses a string representation of a byte size unit and returns the corresponding ByteSizeUnit.
String	toStringLongForm()	Returns the long string representation of this unit, such as "kilobytes", "megabytes" or "bytes".
String	toStringShortForm()	Returns the short string representation of this unit, such as "KiB", "B" or "MB".
static ByteSizeUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ByteSizeUnit[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BYTES

public static final ByteSizeUnit BYTES

The base unit. Has a factor of 1.

KILOBYTES

public static final ByteSizeUnit KILOBYTES

The SI kilobyte. Has a factor of 1000^1.

KIBIBYTES

public static final ByteSizeUnit KIBIBYTES

The IEC kibibyte. Has a factor of 1024^1.

MEGABYTES

public static final ByteSizeUnit MEGABYTES

The SI megabyte. Has a factor of 1000^2.

MEBIBYTES

public static final ByteSizeUnit MEBIBYTES

The IEC mebibyte. Has a factor of 1024^2.

GIGABYTES

public static final ByteSizeUnit GIGABYTES

The SI gigabyte. Has a factor of 1000^3.

GIBIBYTES

public static final ByteSizeUnit GIBIBYTES

The IEC gibibyte. Has a factor of 1024^3.

TERABYTES

public static final ByteSizeUnit TERABYTES

The SI terabyte. Has a factor of 1000^4.

TEBIBYTES

public static final ByteSizeUnit TEBIBYTES

The IEC tebibyte. Has a factor of 1024^4.

PETABYTES

public static final ByteSizeUnit PETABYTES

The SI petabyte. Has a factor of 1000^5.

PEBIBYTES

public static final ByteSizeUnit PEBIBYTES

The IEC pebibyte. Has a factor of 1024^5.

EXABYTES

public static final ByteSizeUnit EXABYTES

The SI exabyte. Has a factor of 1000^6.

EXBIBYTES

public static final ByteSizeUnit EXBIBYTES

The IEC exibyte. Has a factor of 1024^6.

ZETTABYTES

public static final ByteSizeUnit ZETTABYTES

The SI zettabyte. Has a factor of 1000^7.

ZEBIBYTES

public static final ByteSizeUnit ZEBIBYTES

The IEC zebibyte. Has a factor of 1024^7.

YOTTABYTES

public static final ByteSizeUnit YOTTABYTES

The SI yottabyte. Has a factor of 1000^8.

YOBIBYTES

public static final ByteSizeUnit YOBIBYTES

The IEC yobibyte. Has a factor of 1024^8.

Method Detail

values

public static ByteSizeUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ByteSizeUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

parse

public static ByteSizeUnit parse(String unit)

Parses a string representation of a byte size unit and returns the corresponding ByteSizeUnit. There is support for various formats. Below is a list describing them where [prefix] represents the long form prefix of the unit (such as "kilo", "mega", "tera", etc) and [first] represents the first letter in the prefix (such as "k", "m", "t", etc):

• "" (empty string) - refers to the BYTES
• "b" - refers to the BYTES.
• "[prefix]byte" - the prefix determines what ByteSizeStandard is being used.
• "[prefix]bytes" - the prefix determines what ByteSizeStandard is being used.
• "[first]" - refers to the ByteSizeStandard.IEC standard for the corresponding prefix, eg. "k" is equal to "kibibyte"
• "[first]i" - refers to the ByteSizeStandard.IEC standard for the corresponding prefix, eg. "ki" is equal to "kibibyte"
• "[first]ib" - refers to the ByteSizeStandard.IEC standard for the corresponding prefix, eg. "kib" is equal to "kibibyte"
• "[first]b" - refers to the ByteSizeStandard.SI standard for the corresponding prefix, eg. "kb" is equal to "kilobyte"

The parsing is case insensitive, meaning that the following strings are equivalent: "KiB", "kIb", "KIB", etc. This method will return null if the specified string is not a valid ByteSizeUnit string as described above.

Parameters:

unit - the string representation of the desired ByteSizeUnit.

Returns:

the ByteSizeUnit represented by the specified string or null if the string could not be translated into a known unit.

isSI

public boolean isSI()

Returns whether this ByteSizeUnit is an SI unit.

Returns:

true iff this unit is an SI unit.

isIEC

public boolean isIEC()

Returns whether this ByteSizeUnit is an IEC unit.

Returns:

true iff this unit is an IEC unit.

getFactor

public BigDecimal getFactor()

Gets the multiplication factor for this ByteSizeUnit. Returns the result of raising the poweOf value of this units standard to the power specified in this unit.

Returns:

the factor by which to multiply for this unit.

toStringLongForm

public String toStringLongForm()

Returns the long string representation of this unit, such as "kilobytes", "megabytes" or "bytes". Note that this method always returns the plural form.

Returns:

the plural long string representation of this unit.

toStringShortForm

public String toStringShortForm()

Returns the short string representation of this unit, such as "KiB", "B" or "MB".

Returns:

the short string representation of this unit.