io.appulse.utils

Enum SizeUnit

java.lang.Object

java.lang.Enum<SizeUnit>

io.appulse.utils.SizeUnit

All Implemented Interfaces:

Serializable, Comparable<SizeUnit>

public enum SizeUnit
extends Enum<SizeUnit>

A SizeUnit represents digital information size at a given unit of granularity and provides utility methods to convert across the units.

Since:

1.13.0

Author:

Artem Labazin

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES Byte (B), 1 Byte.
GIGABYTES Gigabyte (GB), 2^30 Byte = 1.024 * 1.024 * 1.024 Byte = 1.073.741.824 Byte.
KILOBYTES Kilobyte (kB), 2^10 Byte = 1.024 Byte.
MEGABYTES Megabyte (MB), 2^20 Byte = 1.024 * 1.024 Byte = 1.048.576 Byte.
PETABYTES Petabyte (PB), 2^50 Byte = 1.024 * 1.024 * 1.024 * 1.024 * 1.024 Byte = 1.125.899.906.842.624 Byte.
TERABYTES Terabyte (TB), 2^40 Byte = 1.024 * 1.024 * 1.024 * 1.024 Byte = 1.099.511.627.776 Byte.

Method Summary

Modifier and Type	Method and Description
long	convert(long source, SizeUnit sourceUnit) Converts a source value with a specified SizeUnit to that instance.
long	toBytes(long value) Translates a value to bytes.
long	toGigabytes(long value) Translates a value to gigabytes.
long	toKilobytes(long value) Translates a value to kilobytes.
long	toMegabytes(long value) Translates a value to megabytes.
long	toPetabytes(long value) Translates a value to petabytes.
long	toTerabytes(long value) Translates a value to terabytes.
static SizeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static SizeUnit[]	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 SizeUnit BYTES

Byte (B), 1 Byte.

KILOBYTES

public static final SizeUnit KILOBYTES

Kilobyte (kB), 2^10 Byte = 1.024 Byte.

MEGABYTES

public static final SizeUnit MEGABYTES

Megabyte (MB), 2^20 Byte = 1.024 * 1.024 Byte = 1.048.576 Byte.

GIGABYTES

public static final SizeUnit GIGABYTES

Gigabyte (GB), 2^30 Byte = 1.024 * 1.024 * 1.024 Byte = 1.073.741.824 Byte.

TERABYTES

public static final SizeUnit TERABYTES

Terabyte (TB), 2^40 Byte = 1.024 * 1.024 * 1.024 * 1.024 Byte = 1.099.511.627.776 Byte.

PETABYTES

public static final SizeUnit PETABYTES

Petabyte (PB), 2^50 Byte = 1.024 * 1.024 * 1.024 * 1.024 * 1.024 Byte = 1.125.899.906.842.624 Byte.

Method Detail

values

public static SizeUnit[] 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 (SizeUnit c : SizeUnit.values())
    System.out.println(c);

Returns:

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

valueOf

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

convert

public long convert(long source,
                    SizeUnit sourceUnit)

Converts a source value with a specified SizeUnit to that instance.

Parameters:

source - the value to convert.

sourceUnit - the value's size unit.

Returns:

converted value.

toBytes

public long toBytes(long value)

Translates a value to bytes.

Parameters:

value - the value to convert.

Returns:

converted value, in bytes.

toKilobytes

public long toKilobytes(long value)

Translates a value to kilobytes.

Parameters:

value - the value to convert.

Returns:

converted value, in kilobytes.

toMegabytes

public long toMegabytes(long value)

Translates a value to megabytes.

Parameters:

value - the value to convert.

Returns:

converted value, in megabytes.

toGigabytes

public long toGigabytes(long value)

Translates a value to gigabytes.

Parameters:

value - the value to convert.

Returns:

converted value, in gigabytes.

toTerabytes

public long toTerabytes(long value)

Translates a value to terabytes.

Parameters:

value - the value to convert.

Returns:

converted value, in terabytes.

toPetabytes

public long toPetabytes(long value)

Translates a value to petabytes.

Parameters:

value - the value to convert.

Returns:

converted value, in petabytes.