Enum Class TelemetryFormat.Unit

java.lang.Object

java.lang.Enum<TelemetryFormat.Unit>

dev.jvmguard.annotation.TelemetryFormat.Unit

All Implemented Interfaces:

Serializable, Comparable<TelemetryFormat.Unit>, Constable

Enclosing class:

TelemetryFormat

public static enum TelemetryFormat.Unit
extends Enum<TelemetryFormat.Unit>

Telemetry unit used in the TelemetryFormat annotation.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	The monitored value has the unit "bytes".
MICROSECONDS	The monitored value has the unit "microseconds".
MILLISECONDS	The monitored value has the unit "milliseconds".
NANOSECONDS	The monitored value has the unit "nanoseconds".
PER_SECOND	The monitored value has the unit "per second".
PERCENT	The monitored value has the unit "percent".
PLAIN	The monitored value is a unitless number.

Method Summary

Modifier and Type	Method	Description
static TelemetryFormat.Unit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TelemetryFormat.Unit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAIN

public static final TelemetryFormat.Unit PLAIN

The monitored value is a unitless number.

PER_SECOND

public static final TelemetryFormat.Unit PER_SECOND

The monitored value has the unit "per second". Conversion into the units "per-minute" and "per-hour" is done automatically as required. In practice, this conversion would occur if TelemetryFormat.scale() is set to a negative number.

PERCENT

public static final TelemetryFormat.Unit PERCENT

The monitored value has the unit "percent". To show two decimal digits, set TelemetryFormat.scale() to 2.

MILLISECONDS

public static final TelemetryFormat.Unit MILLISECONDS

The monitored value has the unit "milliseconds". Conversion into higher unit prefixes such as seconds or minutes is done automatically as required.

MICROSECONDS

public static final TelemetryFormat.Unit MICROSECONDS

The monitored value has the unit "microseconds". Conversion into higher unit prefixes such as seconds or minutes is done automatically as required.

NANOSECONDS

public static final TelemetryFormat.Unit NANOSECONDS

The monitored value has the unit "nanoseconds". Conversion into higher unit prefixes such as microseconds or milliseconds is done automatically as required.

BYTES

public static final TelemetryFormat.Unit BYTES

The monitored value has the unit "bytes". Conversion into higher unit prefixes such as kB, MB or GB is done automatically as required.

Method Details

values

public static TelemetryFormat.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 TelemetryFormat.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