com.isti.util

Enum SizeUnit

java.lang.Object

java.lang.Enum<SizeUnit>

com.isti.util.SizeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SizeUnit>

public enum SizeUnit
extends java.lang.Enum<SizeUnit>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES bytes
EXABYTE exabyte
GIGABYTE gigabyte
KILOBYTE kilobyte
MEGABYTE megabyte
PETABYTE petabyte
TERABYTE terabyte

Method Summary

Modifier and Type	Method and Description
double	convert(long numbytes) Converts the number of bytes to the size.
long	getNumbytes() Get the number of bytes per unit.
static void	getText(java.lang.StringBuilder sb, double size, SizeUnit sizeUnit) Gets the text for the size and size unit.
static void	getText(java.lang.StringBuilder sb, long numbytes, SizeUnit... sizeUnits) Get the size text for the number of bytes in the largest size unit where the size is at least one.
java.lang.String	toString()
static SizeUnit	valueOf(java.lang.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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BYTES

public static final SizeUnit BYTES

bytes

EXABYTE

public static final SizeUnit EXABYTE

exabyte

GIGABYTE

public static final SizeUnit GIGABYTE

gigabyte

KILOBYTE

public static final SizeUnit KILOBYTE

kilobyte

MEGABYTE

public static final SizeUnit MEGABYTE

megabyte

PETABYTE

public static final SizeUnit PETABYTE

petabyte

TERABYTE

public static final SizeUnit TERABYTE

terabyte

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getText

public static void getText(java.lang.StringBuilder sb,
                           double size,
                           SizeUnit sizeUnit)

Gets the text for the size and size unit.

Parameters:

sb - the string builder.

size - the size in the specified size unit.

sizeUnit - the size unit.

getText

public static void getText(java.lang.StringBuilder sb,
                           long numbytes,
                           SizeUnit... sizeUnits)

Get the size text for the number of bytes in the largest size unit where the size is at least one.

Parameters:

sb - the string builder.

numbytes - the number of bytes.

sizeUnits - the size units or an empty array for all.

convert

public double convert(long numbytes)

Converts the number of bytes to the size.

Parameters:

numbytes - the number of bytes.

Returns:

the size.

getNumbytes

public long getNumbytes()

Get the number of bytes per unit.

Returns:

the number of bytes per unit.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<SizeUnit>