com.atlassian.beehive.core.stats

Enum StatisticsType

java.lang.Object

java.lang.Enum<StatisticsType>

com.atlassian.beehive.core.stats.StatisticsType

All Implemented Interfaces:

Serializable, Comparable<StatisticsType>

public enum StatisticsType
extends Enum<StatisticsType>

The type of statistic that a StatisticsKey represents.

The different types of statistics have different underlying meanings and might be represented differently in a management user interface.

Since:

v0.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNTER A statistic that counts the number of times an event has occurred, such as the number of times that a given lock has been acquired.
GAUGE A statistic that represents something that represents a varying measurement, such as the number of threads that are currently waiting to acquire a given lock.

Method Summary

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

COUNTER

public static final StatisticsType COUNTER

A statistic that counts the number of times an event has occurred, such as the number of times that a given lock has been acquired.

Statistics of this type should strictly increase in value, as they represent a tally of events that have already occurred, not a currently measured value.

GAUGE

public static final StatisticsType GAUGE

A statistic that represents something that represents a varying measurement, such as the number of threads that are currently waiting to acquire a given lock.

Statistics of this type may either increase or decrease over time, as they represent a currently measure value, not a tally of discrete events.

Method Detail

values

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

Returns:

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

valueOf

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