org.jboss.as.controller.client.helpers

Enum MeasurementUnit

java.lang.Object

java.lang.Enum<MeasurementUnit>

org.jboss.as.controller.client.helpers.MeasurementUnit

All Implemented Interfaces:

Serializable, Comparable<MeasurementUnit>

public enum MeasurementUnit
extends Enum<MeasurementUnit>

Metric data values can be in one of the following known units of measurement. These enum values should correspond to the "units" attribute enumerated type values as defined in the plugin descriptor's <metric> element.

Author:

Joseph Marques, Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MeasurementUnit.Family
static class	MeasurementUnit.MeasurementConversionException

Enum Constant Summary

Enum Constants

Enum Constant and Description
BITS
BYTES
CELSIUS
DAYS
EPOCH_MILLISECONDS
EPOCH_SECONDS
FAHRENHEIGHT
GIGABITS
GIGABYTES
HOURS
JIFFYS
KELVIN
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
MICROSECONDS
MILLISECONDS
MINUTES
NANOSECONDS
NONE
PER_DAY
PER_HOUR
PER_JIFFY
PER_MICROSECOND
PER_MILLISECOND
PER_MINUTE
PER_NANOSECOND
PER_SECOND
PERCENTAGE
PETABITS
PETABYTES
SECONDS
TERABITS
TERABYTES

Method Summary

Modifier and Type	Method and Description
static Double	calculateOffset(MeasurementUnit first, MeasurementUnit second)
MeasurementUnit	getBaseUnits()
MeasurementUnit.Family	getFamily()
String	getName() A Java bean style getter to allow us to access the enum name from JSPs (e.g.
static MeasurementUnit	getUsingDisplayUnits(String displayUnits, MeasurementUnit.Family family)
boolean	isComparableTo(MeasurementUnit other)
String	toString()
static MeasurementUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static MeasurementUnit[]	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

NONE

public static final MeasurementUnit NONE

PERCENTAGE

public static final MeasurementUnit PERCENTAGE

BYTES

public static final MeasurementUnit BYTES

KILOBYTES

public static final MeasurementUnit KILOBYTES

MEGABYTES

public static final MeasurementUnit MEGABYTES

GIGABYTES

public static final MeasurementUnit GIGABYTES

TERABYTES

public static final MeasurementUnit TERABYTES

PETABYTES

public static final MeasurementUnit PETABYTES

BITS

public static final MeasurementUnit BITS

KILOBITS

public static final MeasurementUnit KILOBITS

MEGABITS

public static final MeasurementUnit MEGABITS

GIGABITS

public static final MeasurementUnit GIGABITS

TERABITS

public static final MeasurementUnit TERABITS

PETABITS

public static final MeasurementUnit PETABITS

EPOCH_MILLISECONDS

public static final MeasurementUnit EPOCH_MILLISECONDS

EPOCH_SECONDS

public static final MeasurementUnit EPOCH_SECONDS

JIFFYS

public static final MeasurementUnit JIFFYS

NANOSECONDS

public static final MeasurementUnit NANOSECONDS

MICROSECONDS

public static final MeasurementUnit MICROSECONDS

MILLISECONDS

public static final MeasurementUnit MILLISECONDS

SECONDS

public static final MeasurementUnit SECONDS

MINUTES

public static final MeasurementUnit MINUTES

HOURS

public static final MeasurementUnit HOURS

DAYS

public static final MeasurementUnit DAYS

PER_JIFFY

public static final MeasurementUnit PER_JIFFY

PER_NANOSECOND

public static final MeasurementUnit PER_NANOSECOND

PER_MICROSECOND

public static final MeasurementUnit PER_MICROSECOND

PER_MILLISECOND

public static final MeasurementUnit PER_MILLISECOND

PER_SECOND

public static final MeasurementUnit PER_SECOND

PER_MINUTE

public static final MeasurementUnit PER_MINUTE

PER_HOUR

public static final MeasurementUnit PER_HOUR

PER_DAY

public static final MeasurementUnit PER_DAY

CELSIUS

public static final MeasurementUnit CELSIUS

KELVIN

public static final MeasurementUnit KELVIN

FAHRENHEIGHT

public static final MeasurementUnit FAHRENHEIGHT

Method Detail

values

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

Returns:

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

valueOf

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

getUsingDisplayUnits

public static MeasurementUnit getUsingDisplayUnits(String displayUnits,
                                                   MeasurementUnit.Family family)

getBaseUnits

public MeasurementUnit getBaseUnits()

isComparableTo

public boolean isComparableTo(MeasurementUnit other)

calculateOffset

public static Double calculateOffset(MeasurementUnit first,
                                     MeasurementUnit second)
                              throws MeasurementUnit.MeasurementConversionException

Throws:

MeasurementUnit.MeasurementConversionException

getFamily

public MeasurementUnit.Family getFamily()

getName

public String getName()

A Java bean style getter to allow us to access the enum name from JSPs (e.g. ${measureUnits.name}).

Returns:

the enum name

toString

public String toString()

Overrides:

toString in class Enum<MeasurementUnit>