Package one.microstream.bytes

Enum ByteMultiple

java.lang.Object

java.lang.Enum<ByteMultiple>

one.microstream.bytes.ByteMultiple

All Implemented Interfaces:

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

public enum ByteMultiple
extends Enum<ByteMultiple>

Size units for byte multiples:

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

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	ByteMultiple.Conversion	Fluent API helper for convert(double,ByteMultiple) 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 ByteMultiple.Conversion	convert(double sourceValue, ByteMultiple sourceUnit)	Starts a conversion, continue with ByteMultiple.Conversion.to(ByteMultiple), e.g.:
static ByteMultiple	ofName(String name)
long	toBytes(double value)
static ByteMultiple	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ByteMultiple[]	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 Detail

B

public static final ByteMultiple B

KB

public static final ByteMultiple KB

MB

public static final ByteMultiple MB

GB

public static final ByteMultiple GB

TB

public static final ByteMultiple TB

PB

public static final ByteMultiple PB

EB

public static final ByteMultiple EB

ZB

public static final ByteMultiple ZB

YB

public static final ByteMultiple YB

KiB

public static final ByteMultiple KiB

MiB

public static final ByteMultiple MiB

GiB

public static final ByteMultiple GiB

TiB

public static final ByteMultiple TiB

PiB

public static final ByteMultiple PiB

EiB

public static final ByteMultiple EiB

ZiB

public static final ByteMultiple ZiB

YiB

public static final ByteMultiple YiB

Method Detail

values

public static ByteMultiple[] 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 ByteMultiple 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 ByteMultiple ofName(String name)

convert

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

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

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

See Also:

ByteMultiple.Conversion

toBytes

public long toBytes(double value)