Package org.jivesoftware.openfire.stats

Enum Class Statistic.Type

java.lang.Object

java.lang.Enum<Statistic.Type>

org.jivesoftware.openfire.stats.Statistic.Type

All Implemented Interfaces:

Serializable, Comparable<Statistic.Type>, Constable

Enclosing interface:

Statistic

public static enum Statistic.Type
extends Enum<Statistic.Type>

The type of statistic.

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
count	The total rate over time.
rate	The average rate over time.

Method Summary

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

rate

public static final Statistic.Type rate

The average rate over time. For example, the averave kb/s in bandwidth used for file transfers. Each time the Statistic.sample() method is invoked, it should return the "amount" of data recorded since the last invocation.

count

public static final Statistic.Type count

The total rate over time. For example, the number of users created. Each time the Statistic.sample() method is invoked, it should return the "amount" of data recorded since the last invocation. The values will be totalled over the relevant time interval (by minute, hourly, daily, etc.).

Method Details

values

public static Statistic.Type[] 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 Statistic.Type 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