org.echocat.jomon.runtime.util

Enum ByteUnit

java.lang.Object

java.lang.Enum<ByteUnit>

org.echocat.jomon.runtime.util.ByteUnit

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTE
EXA_BYTE
GIGA_BYTE
KILO_BYTE
MEGA_BYTE
PETA_BYTE
TERA_BYTE

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	convert(double count, ByteUnit sourceUnit)
abstract long	convert(long count, ByteUnit sourceUnit)
static ByteUnit	getByDisplay(java.lang.String display)
static ByteUnit	getByShortDisplay(java.lang.String shortDisplay)
java.lang.String	getDisplay()
java.lang.String	getShortDisplay()
abstract double	toBytes(double count)
abstract long	toBytes(long count)
abstract double	toExaBytes(double count)
abstract long	toExaBytes(long count)
abstract double	toGigaBytes(double count)
abstract long	toGigaBytes(long count)
abstract double	toKiloBytes(double count)
abstract long	toKiloBytes(long count)
abstract double	toMegaBytes(double count)
abstract long	toMegaBytes(long count)
abstract double	toPetaBytes(double count)
abstract long	toPetaBytes(long count)
java.lang.String	toString()
abstract double	toTeraBytes(double count)
abstract long	toTeraBytes(long count)
static ByteUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ByteUnit[]	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 ByteUnit BYTE

KILO_BYTE

public static final ByteUnit KILO_BYTE

MEGA_BYTE

public static final ByteUnit MEGA_BYTE

GIGA_BYTE

public static final ByteUnit GIGA_BYTE

TERA_BYTE

public static final ByteUnit TERA_BYTE

PETA_BYTE

public static final ByteUnit PETA_BYTE

EXA_BYTE

public static final ByteUnit EXA_BYTE

Method Detail

values

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

Returns:

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

valueOf

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

getByDisplay

@Nonnull
public static ByteUnit getByDisplay(@Nonnull
                            java.lang.String display)
                             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getByShortDisplay

@Nonnull
public static ByteUnit getByShortDisplay(@Nonnull
                                 java.lang.String shortDisplay)
                                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

convert

@Nonnegative
public abstract long convert(@Nonnegative
                       long count,
                       @Nonnull
                       ByteUnit sourceUnit)

convert

@Nonnegative
public abstract double convert(@Nonnegative
                         double count,
                         @Nonnull
                         ByteUnit sourceUnit)

toBytes

@Nonnegative
public abstract long toBytes(@Nonnegative
                       long count)

toKiloBytes

@Nonnegative
public abstract long toKiloBytes(@Nonnegative
                           long count)

toMegaBytes

@Nonnegative
public abstract long toMegaBytes(@Nonnegative
                           long count)

toGigaBytes

@Nonnegative
public abstract long toGigaBytes(@Nonnegative
                           long count)

toTeraBytes

@Nonnegative
public abstract long toTeraBytes(@Nonnegative
                           long count)

toPetaBytes

@Nonnegative
public abstract long toPetaBytes(@Nonnegative
                           long count)

toExaBytes

@Nonnegative
public abstract long toExaBytes(@Nonnegative
                          long count)

toBytes

@Nonnegative
public abstract double toBytes(@Nonnegative
                         double count)

toKiloBytes

@Nonnegative
public abstract double toKiloBytes(@Nonnegative
                             double count)

toMegaBytes

@Nonnegative
public abstract double toMegaBytes(@Nonnegative
                             double count)

toGigaBytes

@Nonnegative
public abstract double toGigaBytes(@Nonnegative
                             double count)

toTeraBytes

@Nonnegative
public abstract double toTeraBytes(@Nonnegative
                             double count)

toPetaBytes

@Nonnegative
public abstract double toPetaBytes(@Nonnegative
                             double count)

toExaBytes

@Nonnegative
public abstract double toExaBytes(@Nonnegative
                            double count)

getDisplay

@Nonnull
public java.lang.String getDisplay()

getShortDisplay

@Nonnull
public java.lang.String getShortDisplay()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ByteUnit>