com.hazelcast.jet.core.metrics

Enum Unit

java.lang.Object

java.lang.Enum<Unit>

com.hazelcast.jet.core.metrics.Unit

All Implemented Interfaces:

Serializable, Comparable<Unit>

public enum Unit
extends Enum<Unit>

Measurement unit of user-defined metrics (see Metric). Meant to provide further information on the type of value measured by user metrics.

The unit values will end up populating the metric tag MetricTags.UNIT. It can be used by UI tools to format the value and it's not used by Jet itself.

Since:

Jet 4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN 0 or 1
BYTES Size, counter, represented in bytes
COUNT Number of items: size, counter...
ENUM 0..n, ordinal of an enum
MS Timestamp or duration represented in ms
PERCENT An integer in range 0..100

Method Summary

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

BYTES

public static final Unit BYTES

Size, counter, represented in bytes

MS

public static final Unit MS

Timestamp or duration represented in ms

PERCENT

public static final Unit PERCENT

An integer in range 0..100

COUNT

public static final Unit COUNT

Number of items: size, counter...

BOOLEAN

public static final Unit BOOLEAN

0 or 1

ENUM

public static final Unit ENUM

0..n, ordinal of an enum

Method Detail

values

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

Returns:

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

valueOf

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