org.tools4j.elara.plugin.metrics

Enum FrequencyMetric

java.lang.Object

java.lang.Enum<FrequencyMetric>

org.tools4j.elara.plugin.metrics.FrequencyMetric

All Implemented Interfaces:

Serializable, Comparable<FrequencyMetric>

public enum FrequencyMetric
extends Enum<FrequencyMetric>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMAND_POLL_FREQUENCY
COMMAND_PROCESSED_FREQUENCY
DUTY_CYCLE_FREQUENCY
DUTY_CYCLE_PERFORMED_FREQUENCY
EVENT_APPLIED_FREQUENCY
EVENT_POLL_FREQUENCY
EXTRA_STEP_INVOCATION_FREQUENCY
EXTRA_STEP_PERFORMED_FREQUENCY
INPUT_RECEIVED_FREQUENCY
INPUTS_POLL_FREQUENCY
OUTPUT_POLL_FREQUENCY
OUTPUT_PUBLISHED_FREQUENCY
STEP_ERROR_FREQUENCY

Method Summary

Modifier and Type	Method and Description
static FrequencyMetric	byOrdinal(int ordinal)
static short	choice(FrequencyMetric... metrics)
static short	choice(Set<FrequencyMetric> metrics)
static int	count()
static int	count(short choice)
static FrequencyMetric	metric(short choice, int index)
static FrequencyMetric	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrequencyMetric[]	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

DUTY_CYCLE_FREQUENCY

public static final FrequencyMetric DUTY_CYCLE_FREQUENCY

INPUTS_POLL_FREQUENCY

public static final FrequencyMetric INPUTS_POLL_FREQUENCY

COMMAND_POLL_FREQUENCY

public static final FrequencyMetric COMMAND_POLL_FREQUENCY

EVENT_POLL_FREQUENCY

public static final FrequencyMetric EVENT_POLL_FREQUENCY

OUTPUT_POLL_FREQUENCY

public static final FrequencyMetric OUTPUT_POLL_FREQUENCY

EXTRA_STEP_INVOCATION_FREQUENCY

public static final FrequencyMetric EXTRA_STEP_INVOCATION_FREQUENCY

DUTY_CYCLE_PERFORMED_FREQUENCY

public static final FrequencyMetric DUTY_CYCLE_PERFORMED_FREQUENCY

INPUT_RECEIVED_FREQUENCY

public static final FrequencyMetric INPUT_RECEIVED_FREQUENCY

COMMAND_PROCESSED_FREQUENCY

public static final FrequencyMetric COMMAND_PROCESSED_FREQUENCY

EVENT_APPLIED_FREQUENCY

public static final FrequencyMetric EVENT_APPLIED_FREQUENCY

OUTPUT_PUBLISHED_FREQUENCY

public static final FrequencyMetric OUTPUT_PUBLISHED_FREQUENCY

EXTRA_STEP_PERFORMED_FREQUENCY

public static final FrequencyMetric EXTRA_STEP_PERFORMED_FREQUENCY

STEP_ERROR_FREQUENCY

public static final FrequencyMetric STEP_ERROR_FREQUENCY

Method Detail

values

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

Returns:

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

valueOf

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

choice

public static short choice(FrequencyMetric... metrics)

choice

public static short choice(Set<FrequencyMetric> metrics)

count

public static int count(short choice)

metric

public static FrequencyMetric metric(short choice,
                                     int index)

count

public static int count()

byOrdinal

public static FrequencyMetric byOrdinal(int ordinal)