Package com.arpnetworking.metrics.mad.model

Enum Class UnitType

java.lang.Object

java.lang.Enum<UnitType>

com.arpnetworking.metrics.mad.model.UnitType

All Implemented Interfaces:

Serializable, Comparable<UnitType>, Constable

public enum UnitType
extends Enum<UnitType>

The unit type classification.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATA_SIZE	Used in describing data sizes.
TEMPERATURE	Used in describing measurements of temperature.
TIME	Used in describing time durations.

Method Summary

Modifier and Type	Method	Description
abstract Unit	getDefaultUnit()	Get the default unit for this unit type.
static UnitType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnitType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME

public static final UnitType TIME

Used in describing time durations.

DATA_SIZE

public static final UnitType DATA_SIZE

Used in describing data sizes.

TEMPERATURE

public static final UnitType TEMPERATURE

Used in describing measurements of temperature.

Method Details

values

public static UnitType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UnitType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDefaultUnit

public abstract Unit getDefaultUnit()

Get the default unit for this unit type. Used in normalizing values.

Returns:

The default unit for a given domain.