Package com.github.alex1304.ultimategdbot.api.utils

Enum SystemUnit

java.lang.Object

java.lang.Enum<SystemUnit>

com.github.alex1304.ultimategdbot.api.utils.SystemUnit

All Implemented Interfaces:

Serializable, Comparable<SystemUnit>

public enum SystemUnit
extends Enum<SystemUnit>

Enumerates system units (bytes, kilobytes, etc until terabytes) Provides methods for conversion and formatting.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTE
GIGABYTE
KILOBYTE
MEGABYTE
TERABYTE

Method Summary

Modifier and Type	Method	Description
double	convert(long byteValue)	Converts the given value to the unit represented by the current object
static String	format(long byteValue)	Formats the given value to a human readable format, using the appropriate unit
String	toString()
static SystemUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SystemUnit[]	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

BYTE

public static final SystemUnit BYTE

KILOBYTE

public static final SystemUnit KILOBYTE

MEGABYTE

public static final SystemUnit MEGABYTE

GIGABYTE

public static final SystemUnit GIGABYTE

TERABYTE

public static final SystemUnit TERABYTE

Method Detail

values

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

Returns:

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

valueOf

public static SystemUnit 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 double convert(long byteValue)

Converts the given value to the unit represented by the current object

Parameters:

byteValue - the value to convert

Returns:

double

toString

public String toString()

Overrides:

toString in class Enum<SystemUnit>

format

public static String format(long byteValue)

Formats the given value to a human readable format, using the appropriate unit

Parameters:

byteValue - the value to format

Returns:

String