org.springframework.util.unit

Enum DataUnit

java.lang.Object

java.lang.Enum<DataUnit>

org.springframework.util.unit.DataUnit

All Implemented Interfaces:

Serializable, Comparable<DataUnit>

public enum DataUnit
extends Enum<DataUnit>

A standard set of data size units.

Since:

5.1

Author:

Stephane Nicoll

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static DataUnit	fromSuffix(String suffix) Return the DataUnit matching the specified suffix.
static DataUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataUnit[]	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 DataUnit BYTES

Bytes.

KILOBYTES

public static final DataUnit KILOBYTES

Kilobytes.

MEGABYTES

public static final DataUnit MEGABYTES

Megabytes.

GIGABYTES

public static final DataUnit GIGABYTES

Gigabytes.

TERABYTES

public static final DataUnit TERABYTES

Terabytes.

Method Detail

values

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

Returns:

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

valueOf

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

fromSuffix

public static DataUnit fromSuffix(String suffix)

Return the DataUnit matching the specified suffix.

Parameters:

suffix - one of the standard suffix

Returns:

the DataUnit matching the specified suffix

Throws:

IllegalArgumentException - if the suffix does not match any of this enum's constants