Package one.microstream.configuration.types

Enum ByteUnit

java.lang.Object

java.lang.Enum<ByteUnit>

one.microstream.configuration.types.ByteUnit

All Implemented Interfaces:

Serializable, Comparable<ByteUnit>, java.lang.constant.Constable

public enum ByteUnit
extends Enum<ByteUnit>

Size units for byte multiples:

Can be used to convert between units as well, see convert(double, ByteUnit).

See Also:

https://en.wikipedia.org/wiki/Binary_prefix, https://physics.nist.gov/cuu/Units/prefixes.html, https://physics.nist.gov/cuu/Units/binary.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ByteUnit.Conversion	Fluent API helper for convert(double, ByteUnit) to get readable code like:

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
B
EB
EiB
GB
GiB
KB
KiB
MB
MiB
PB
PiB
TB
TiB
YB
YiB
ZB
ZiB

Method Summary

Modifier and Type	Method	Description
static ByteUnit.Conversion	convert(double sourceValue, ByteUnit sourceUnit)	Starts a conversion, continue with ByteUnit.Conversion.to(ByteUnit), e.g.:
static ByteUnit	ofName(String name)
long	toBytes(double value)	Returns the number of bytes, which this unit multiplied by value yields.
static ByteUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ByteUnit[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

B

public static final ByteUnit B

KB

public static final ByteUnit KB

MB

public static final ByteUnit MB

GB

public static final ByteUnit GB

TB

public static final ByteUnit TB

PB

public static final ByteUnit PB

EB

public static final ByteUnit EB

ZB

public static final ByteUnit ZB

YB

public static final ByteUnit YB

KiB

public static final ByteUnit KiB

MiB

public static final ByteUnit MiB

GiB

public static final ByteUnit GiB

TiB

public static final ByteUnit TiB

PiB

public static final ByteUnit PiB

EiB

public static final ByteUnit EiB

ZiB

public static final ByteUnit ZiB

YiB

public static final ByteUnit YiB

Method Details

values

public static ByteUnit[] values()

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

Returns:

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

valueOf

public static ByteUnit 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

ofName

public static ByteUnit ofName(String name)

convert

public static ByteUnit.Conversion convert(double sourceValue, ByteUnit sourceUnit)

Starts a conversion, continue with ByteUnit.Conversion.to(ByteUnit), e.g.:

convert(1.5, ByteMultiple.MB).to(ByteMultiple.KB);

Parameters:

sourceValue - the source value to convert

sourceUnit - the source unit to convert

Returns:

the conversion for method chaining

See Also:

ByteUnit.Conversion

toBytes

public long toBytes(double value)

Returns the number of bytes, which this unit multiplied by value yields.

Parameters:

value - the value to convert

Returns:

the value converted to bytes