Package ai.djl.metric

Enum Class MetricType

java.lang.Object

java.lang.Enum<MetricType>

ai.djl.metric.MetricType

All Implemented Interfaces:

Serializable, Comparable<MetricType>, Constable

public enum MetricType
extends Enum<MetricType>

An enum holds metric type constants.

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
COUNTER
GAUGE
HISTOGRAM

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the string value of the MetricType.
static MetricType	of(String value)	Returns Unit instance from an string value.
static MetricType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricType[]	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

COUNTER

public static final MetricType COUNTER

GAUGE

public static final MetricType GAUGE

HISTOGRAM

public static final MetricType HISTOGRAM

Method Details

values

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

getValue

public String getValue()

Returns the string value of the MetricType.

Returns:

the string value of the MetricType

of

public static MetricType of(String value)

Returns Unit instance from an string value.

Parameters:

value - the String value of Unit

Returns:

the Unit