Module datarush.commons

Package com.pervasive.datarush.monitoring

Enum StatisticState

java.lang.Object

java.lang.Enum<StatisticState>

com.pervasive.datarush.monitoring.StatisticState

All Implemented Interfaces:

Serializable, Comparable<StatisticState>

public enum StatisticState
extends Enum<StatisticState>

The state associated with a StatisticSupplier.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Collection of the statistic has started; partial results are available
FINISHED	Collection of statistic has finished; final results are available.
PAUSED	Collection of the statistic has paused; partial results are available
UNAVAILABLE	Statistic is either newly-created and has not yet started or is not available.

Method Summary

Modifier and Type	Method	Description
abstract boolean	isAvailable()	Returns whether the statistic is currently available
abstract boolean	isFinished()	Returns whether collection of the statistic has finished
static StatisticState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StatisticState[]	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

UNAVAILABLE

public static final StatisticState UNAVAILABLE

Statistic is either newly-created and has not yet started or is not available.

ACTIVE

public static final StatisticState ACTIVE

Collection of the statistic has started; partial results are available

PAUSED

public static final StatisticState PAUSED

Collection of the statistic has paused; partial results are available

FINISHED

public static final StatisticState FINISHED

Collection of statistic has finished; final results are available. Once a statistic reaches this state, the value is expected to no longer change. The framework may optimize out statistics that have reached the finished state by performing early aggregation of those statistics.

Method Detail

values

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

Returns:

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

valueOf

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

isAvailable

public abstract boolean isAvailable()

Returns whether the statistic is currently available

Returns:

whether the statistic is available

isFinished

public abstract boolean isFinished()

Returns whether collection of the statistic has finished

Returns:

whether collection of the statistic has finished