Package com.itrsgroup.collection.datamodel

Enum Class Unit

java.lang.Object

java.lang.Enum<Unit>

com.itrsgroup.collection.datamodel.Unit

All Implemented Interfaces:

Serializable, Comparable<Unit>, Constable

public enum Unit
extends Enum<Unit>

Enumeration of supported units of measure.

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
AMPERES
AUD
BITS
BITS_PER_SECOND
BYTE_SECONDS
BYTES
BYTES_PER_SECOND
CAD
CHF
CNY
CORES
DAYS
DEGREES_CELSIUS
DKK
EPOCH_MILLISECONDS
EPOCH_NANOSECONDS
EUR
EXABYTES
EXBIBYTES
FRACTION
GBP
GIBIBYTES
GIGABITS
GIGABITS_PER_SECOND
GIGABYTES
GIGABYTES_PER_SECOND
GIGAHERTZ
GRAMS
HERTZ
HKD
HOURS
JOULES
JPY
KIBIBYTES
KIBIBYTES_PER_SECOND
KILOBITS
KILOBITS_PER_SECOND
KILOBYTES
KILOBYTES_PER_SECOND
KILOGRAMS
KILOJOULES
KILOMETRES
KILOVOLTS
MEBIBYTES
MEGABITS
MEGABITS_PER_SECOND
MEGABYTES
MEGABYTES_PER_SECOND
MEGAHERTZ
METRES
MICROCORES
MICROSECONDS
MILLIAMPERES
MILLICORES
MILLISECONDS
MINUTES
NANOCORES
NANOSECONDS
NOK
NONE
NZD
PEBIBYTES
PER_MINUTE
PER_SECOND
PERCENT
PETABYTES
SECONDS
SEK
SGD
TEBIBYTES
TERABITS
TERABITS_PER_SECOND
TERABYTES
TERABYTES_PER_SECOND
USD
VOLTS
WATTS
ZAR

Method Summary

Modifier and Type	Method	Description
Unit	base()
String	description()
double	factor()
boolean	isBase()
static Unit	ofSerdeNumber(short n)
double	scale(double value, Unit target)	Scale a value from this unit to another of the same base unit.
short	serdeNumber()
String	symbol()
static Unit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Unit	valueOf(TimeUnit timeUnit)	Translate a TimeUnit into the equivalent Unit.
static Unit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static Unit	withDescription(String description)	Get the unit corresponding to the specified description.

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

NONE

public static final Unit NONE

BITS

public static final Unit BITS

KILOBITS

public static final Unit KILOBITS

MEGABITS

public static final Unit MEGABITS

GIGABITS

public static final Unit GIGABITS

TERABITS

public static final Unit TERABITS

BYTES

public static final Unit BYTES

KILOBYTES

public static final Unit KILOBYTES

KIBIBYTES

public static final Unit KIBIBYTES

MEGABYTES

public static final Unit MEGABYTES

MEBIBYTES

public static final Unit MEBIBYTES

GIGABYTES

public static final Unit GIGABYTES

GIBIBYTES

public static final Unit GIBIBYTES

TERABYTES

public static final Unit TERABYTES

TEBIBYTES

public static final Unit TEBIBYTES

PETABYTES

public static final Unit PETABYTES

PEBIBYTES

public static final Unit PEBIBYTES

EXABYTES

public static final Unit EXABYTES

EXBIBYTES

public static final Unit EXBIBYTES

BITS_PER_SECOND

public static final Unit BITS_PER_SECOND

KILOBITS_PER_SECOND

public static final Unit KILOBITS_PER_SECOND

MEGABITS_PER_SECOND

public static final Unit MEGABITS_PER_SECOND

GIGABITS_PER_SECOND

public static final Unit GIGABITS_PER_SECOND

TERABITS_PER_SECOND

public static final Unit TERABITS_PER_SECOND

BYTES_PER_SECOND

public static final Unit BYTES_PER_SECOND

KILOBYTES_PER_SECOND

public static final Unit KILOBYTES_PER_SECOND

KIBIBYTES_PER_SECOND

public static final Unit KIBIBYTES_PER_SECOND

MEGABYTES_PER_SECOND

public static final Unit MEGABYTES_PER_SECOND

GIGABYTES_PER_SECOND

public static final Unit GIGABYTES_PER_SECOND

TERABYTES_PER_SECOND

public static final Unit TERABYTES_PER_SECOND

PER_SECOND

public static final Unit PER_SECOND

PER_MINUTE

public static final Unit PER_MINUTE

NANOSECONDS

public static final Unit NANOSECONDS

MICROSECONDS

public static final Unit MICROSECONDS

MILLISECONDS

public static final Unit MILLISECONDS

SECONDS

public static final Unit SECONDS

MINUTES

public static final Unit MINUTES

HOURS

public static final Unit HOURS

DAYS

public static final Unit DAYS

DEGREES_CELSIUS

public static final Unit DEGREES_CELSIUS

HERTZ

public static final Unit HERTZ

MEGAHERTZ

public static final Unit MEGAHERTZ

GIGAHERTZ

public static final Unit GIGAHERTZ

PERCENT

public static final Unit PERCENT

FRACTION

public static final Unit FRACTION

NANOCORES

public static final Unit NANOCORES

CORES

public static final Unit CORES

MICROCORES

public static final Unit MICROCORES

MILLICORES

public static final Unit MILLICORES

EPOCH_NANOSECONDS

public static final Unit EPOCH_NANOSECONDS

EPOCH_MILLISECONDS

public static final Unit EPOCH_MILLISECONDS

METRES

public static final Unit METRES

KILOMETRES

public static final Unit KILOMETRES

VOLTS

public static final Unit VOLTS

KILOVOLTS

public static final Unit KILOVOLTS

MILLIAMPERES

public static final Unit MILLIAMPERES

AMPERES

public static final Unit AMPERES

JOULES

public static final Unit JOULES

KILOJOULES

public static final Unit KILOJOULES

WATTS

public static final Unit WATTS

GRAMS

public static final Unit GRAMS

KILOGRAMS

public static final Unit KILOGRAMS

AUD

public static final Unit AUD

CAD

public static final Unit CAD

CHF

public static final Unit CHF

CNY

public static final Unit CNY

DKK

public static final Unit DKK

EUR

public static final Unit EUR

GBP

public static final Unit GBP

HKD

public static final Unit HKD

JPY

public static final Unit JPY

NOK

public static final Unit NOK

NZD

public static final Unit NZD

SEK

public static final Unit SEK

SGD

public static final Unit SGD

USD

public static final Unit USD

ZAR

public static final Unit ZAR

BYTE_SECONDS

public static final Unit BYTE_SECONDS

Method Details

values

public static Unit[] 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 Unit 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

isBase

public boolean isBase()

Returns:

True if this is a base unit, false otherwise.

base

public Unit base()

Returns:

This unit's base unit, which is itself if this is a base unit.

description

public String description()

Returns:

This unit's description.

symbol

public String symbol()

Returns:

This unit's symbol, or null if it does not have one.

factor

public double factor()

Returns:

This unit's scaling factor relative to it's base unit.

serdeNumber

public short serdeNumber()

Returns:

Unique serialization number.

scale

public double scale(double value,
 Unit target)

Scale a value from this unit to another of the same base unit.

Parameters:

value - value to scale

target - target unit

Returns:

equivalent value in the target unit

Throws:

IllegalArgumentException - if this unit and the target unit do not have the same base

withDescription

public static Unit withDescription(String description)

Get the unit corresponding to the specified description.

Parameters:

description - The description.

Returns:

The unit.

Throws:

IllegalArgumentException - If the specified description is unknown.

valueOf

public static Unit valueOf(TimeUnit timeUnit)

Translate a TimeUnit into the equivalent Unit.

Parameters:

timeUnit - source unit

Returns:

The equivalent unit, or NONE if no match.

ofSerdeNumber

public static Unit ofSerdeNumber(short n)

Parameters:

n - serde number

Returns:

the type corresponding to the given serde number

Throws:

IllegalArgumentException - if no match found