Package org.forgerock.monitoring.api.instrument

Enum Statistic

java.lang.Object

java.lang.Enum<Statistic>

org.forgerock.monitoring.api.instrument.Statistic

All Implemented Interfaces:

Serializable, Comparable<Statistic>

public enum Statistic
extends Enum<Statistic>

A description of the value contained in a measurement. ForgeRock changes: - Updated Javadoc

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE_TASKS	Number of currently active tasks for a long task timer.
COUNT	Rate per second for calls.
DURATION	Duration of a running task in a long task timer.
MAX	The maximum amount recorded.
TOTAL	The sum of the amounts recorded.
TOTAL_TIME	The sum of the times recorded.
UNKNOWN	Undetermined.
VALUE	Instantaneous value, such as those reported by gauges.

Method Summary

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

TOTAL

public static final Statistic TOTAL

The sum of the amounts recorded.

TOTAL_TIME

public static final Statistic TOTAL_TIME

The sum of the times recorded. Always reported in nanoseconds.

COUNT

public static final Statistic COUNT

Rate per second for calls.

MAX

public static final Statistic MAX

The maximum amount recorded. When this represents a time, it is always reported in nanoseconds.

VALUE

public static final Statistic VALUE

Instantaneous value, such as those reported by gauges.

UNKNOWN

public static final Statistic UNKNOWN

Undetermined.

ACTIVE_TASKS

public static final Statistic ACTIVE_TASKS

Number of currently active tasks for a long task timer.

DURATION

public static final Statistic DURATION

Duration of a running task in a long task timer. Always reported in nanoseconds.

Method Detail

values

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

Returns:

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

valueOf

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

getTagValueRepresentation

public String getTagValueRepresentation()

Returns the Tag Value Representation for this Statistic

Returns:

String representation of the Tag Value