Package io.dropwizard.util

Enum SizeUnit

java.lang.Object

java.lang.Enum<SizeUnit>

io.dropwizard.util.SizeUnit

All Implemented Interfaces:

Serializable, Comparable<SizeUnit>

public enum SizeUnit
extends Enum<SizeUnit>

A unit of size.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	Bytes.
GIGABYTES	Gigabytes.
KILOBYTES	Kilobytes.
MEGABYTES	Megabytes.
TERABYTES	Terabytes.

Method Summary

Modifier and Type	Method	Description
long	convert(long size, SizeUnit 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	toGigabytes(long l)	Converts the given number of the current units into gigabytes.
long	toKilobytes(long l)	Converts the given number of the current units into kilobytes.
long	toMegabytes(long l)	Converts the given number of the current units into megabytes.
long	toTerabytes(long l)	Converts the given number of the current units into 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

Bytes.

KILOBYTES

public static final SizeUnit KILOBYTES

Kilobytes.

MEGABYTES

public static final SizeUnit MEGABYTES

Megabytes.

GIGABYTES

public static final SizeUnit GIGABYTES

Gigabytes.

TERABYTES

public static final SizeUnit TERABYTES

Terabytes.

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 size,
                    SizeUnit 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 bytes

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