fm.last.commons.lang.units

Enum IecByteUnit

java.lang.Object

java.lang.Enum<IecByteUnit>

fm.last.commons.lang.units.IecByteUnit

All Implemented Interfaces:

ByteUnit, Serializable, Comparable<IecByteUnit>

public enum IecByteUnit
extends Enum<IecByteUnit>
implements ByteUnit

These provide the IEC standardised ByteUnits (or binary prefixes), not those ambiguously misused by the media, or the JedecByteUnit units which overload the metric prefixes. :)

See Also:

Wikipedia - Binary prefix, Wikipedia - IEC60027

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES 1
GIBIBYTES 1,073,741,824
KIBIBYTES 1,024
MEBIBYTES 1,048,576
TEBIBYTES 1,099,511,627,776

Method Summary

Methods

Modifier and Type	Method and Description
double	convertTo(ByteUnit unit, double value)
long	multiplier()
static long	parse(String value)
String	suffix()
String	title()
long	toBytes(double multiple)
long	toBytes(long value)
static IecByteUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static IecByteUnit[]	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 IecByteUnit BYTES

1

KIBIBYTES

public static final IecByteUnit KIBIBYTES

1,024

MEBIBYTES

public static final IecByteUnit MEBIBYTES

1,048,576

GIBIBYTES

public static final IecByteUnit GIBIBYTES

1,073,741,824

TEBIBYTES

public static final IecByteUnit TEBIBYTES

1,099,511,627,776

Method Detail

values

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

Returns:

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

valueOf

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

toBytes

public long toBytes(double multiple)

Specified by:

toBytes in interface ByteUnit

toBytes

public long toBytes(long value)

Specified by:

toBytes in interface ByteUnit

convertTo

public double convertTo(ByteUnit unit,
               double value)

Specified by:

convertTo in interface ByteUnit

suffix

public String suffix()

Specified by:

suffix in interface ByteUnit

title

public String title()

Specified by:

title in interface ByteUnit

multiplier

public long multiplier()

Specified by:

multiplier in interface ByteUnit

parse

public static long parse(String value)