org.hawkular.inventory.api.model

Enum MetricUnit

java.lang.Object

java.lang.Enum<MetricUnit>

org.hawkular.inventory.api.model.MetricUnit

All Implemented Interfaces:

Serializable, Comparable<MetricUnit>

public enum MetricUnit
extends Enum<MetricUnit>

Units of a metric TODO this is limited and probably will be replaced by a dedicated entity type in the future (so that it is possible to create new units). Possibly we should also look at some more elaborate measurement unit solution like JSR-363.

Author:

Heiko W. Rupp

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTE
KILO_BYTE
MILLI_SECOND
MINUTE
NONE
SECONDS

Method Summary

Modifier and Type	Method and Description
static MetricUnit	fromDisplayName(String displayName)
String	getDisplayName()
static MetricUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricUnit[]	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

NONE

public static final MetricUnit NONE

MILLI_SECOND

public static final MetricUnit MILLI_SECOND

SECONDS

public static final MetricUnit SECONDS

MINUTE

public static final MetricUnit MINUTE

BYTE

public static final MetricUnit BYTE

KILO_BYTE

public static final MetricUnit KILO_BYTE

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public String getDisplayName()

fromDisplayName

public static MetricUnit fromDisplayName(String displayName)