io.dropwizard.util

Enum DataSizeUnit

java.lang.Object

java.lang.Enum<DataSizeUnit>

io.dropwizard.util.DataSizeUnit

All Implemented Interfaces:

Serializable, Comparable<DataSizeUnit>

public enum DataSizeUnit
extends Enum<DataSizeUnit>

A unit of information using SI and IEC prefixes.

Since:

2.0

See Also:

Units of information on Wikipedia, Binary prefix on Wikipedia

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES Bytes (8 bits).
GIBIBYTES Gibibytes (1024 mebibytes).
GIGABYTES Gigabytes (1000 megabytes).
KIBIBYTES Kibibytes (1024 bytes).
KILOBYTES Kilobytes (1000 bytes).
MEBIBYTES Mebibytes (1024 kibibytes).
MEGABYTES Megabytes (1000 kilobytes).
PEBIBYTES Pebibytes (1024 tebibytes).
PETABYTES Petabytes (1000 terabytes).
TEBIBYTES Tebibytes (1024 gibibytes).
TERABYTES Terabytes (1000 gigabytes).

Method Summary

Modifier and Type	Method and Description
long	convert(long size, DataSizeUnit unit) Converts a size of the given unit into the current unit.
long	toBytes(long l) Converts the given number of the current units into bytes.
long	toGibibytes(long l) Converts the given number of the current units into gibibytes.
long	toGigabytes(long l) Converts the given number of the current units into gigabytes.
long	toKibibytes(long l) Converts the given number of the current units into kibibytes.
long	toKilobytes(long l) Converts the given number of the current units into kilobytes.
long	toMebibytes(long l) Converts the given number of the current units into mebibytes.
long	toMegabytes(long l) Converts the given number of the current units into megabytes.
long	toPebibytes(long l) Converts the given number of the current units into pebibytes.
long	toPetabytes(long l) Converts the given number of the current units into petabytes.
long	toTebibytes(long l) Converts the given number of the current units into tebibytes.
long	toTerabytes(long l) Converts the given number of the current units into terabytes.
static DataSizeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataSizeUnit[]	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 DataSizeUnit BYTES

Bytes (8 bits).

KILOBYTES

public static final DataSizeUnit KILOBYTES

Kilobytes (1000 bytes).

See Also:

Kilo-

MEGABYTES

public static final DataSizeUnit MEGABYTES

Megabytes (1000 kilobytes).

See Also:

Mega-

GIGABYTES

public static final DataSizeUnit GIGABYTES

Gigabytes (1000 megabytes).

See Also:

Giga-

TERABYTES

public static final DataSizeUnit TERABYTES

Terabytes (1000 gigabytes).

See Also:

Tera-

PETABYTES

public static final DataSizeUnit PETABYTES

Petabytes (1000 terabytes).

See Also:

Peta-

KIBIBYTES

public static final DataSizeUnit KIBIBYTES

Kibibytes (1024 bytes).

See Also:

Kibi-

MEBIBYTES

public static final DataSizeUnit MEBIBYTES

Mebibytes (1024 kibibytes).

See Also:

Mebi-

GIBIBYTES

public static final DataSizeUnit GIBIBYTES

Gibibytes (1024 mebibytes).

See Also:

Gibi-

TEBIBYTES

public static final DataSizeUnit TEBIBYTES

Tebibytes (1024 gibibytes).

See Also:

Tebi-

PEBIBYTES

public static final DataSizeUnit PEBIBYTES

Pebibytes (1024 tebibytes).

See Also:

Pebi-

Method Detail

values

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

Returns:

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

valueOf

public static DataSizeUnit 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 size,
                    DataSizeUnit unit)

Converts a size of the given unit into the current unit.

Parameters:

size - the magnitude of the size

unit - the unit of the size

Returns:

the given size in the current unit.

toBytes

public long toBytes(long l)

Converts the given number of the current units into bytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in bytes

toKilobytes

public long toKilobytes(long l)

Converts the given number of the current units into kilobytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in kilobytes

toMegabytes

public long toMegabytes(long l)

Converts the given number of the current units into megabytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in megabytes

toGigabytes

public long toGigabytes(long l)

Converts the given number of the current units into gigabytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in gigabytes

toTerabytes

public long toTerabytes(long l)

Converts the given number of the current units into terabytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in terabytes

toPetabytes

public long toPetabytes(long l)

Converts the given number of the current units into petabytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in petabytes

toKibibytes

public long toKibibytes(long l)

Converts the given number of the current units into kibibytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in kibibytes

toMebibytes

public long toMebibytes(long l)

Converts the given number of the current units into mebibytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in mebibytes

toGibibytes

public long toGibibytes(long l)

Converts the given number of the current units into gibibytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in gibibytes

toTebibytes

public long toTebibytes(long l)

Converts the given number of the current units into tebibytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in tebibytes

toPebibytes

public long toPebibytes(long l)

Converts the given number of the current units into pebibytes.

Parameters:

l - the magnitude of the size in the current unit

Returns:

l of the current units in pebibytes