Module datarush.commons

Package com.pervasive.datarush.monitoring

Enum GaugeAggregator

java.lang.Object

java.lang.Enum<GaugeAggregator>

com.pervasive.datarush.monitoring.GaugeAggregator

All Implemented Interfaces:

Serializable, Comparable<GaugeAggregator>

public enum GaugeAggregator
extends Enum<GaugeAggregator>

The gauge aggregator to use

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAX	Current values are aggregated by finding the maximum of current values.
MIN	Current values are aggregated by finding the minimum of current values.
SUM	Current values are aggregated by summation.

Method Summary

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

SUM

public static final GaugeAggregator SUM

Current values are aggregated by summation. minAllowedValue is aggregated by finding the minimum of minAllowedValue. maxAllowedValue is aggregated by finding the maximum of maxAllowedValue.

MIN

public static final GaugeAggregator MIN

Current values are aggregated by finding the minimum of current values. minAllowedValue is aggregated by finding the minimum of minAllowedValue. maxAllowedValue is aggregated by finding the maximum of maxAllowedValue.

MAX

public static final GaugeAggregator MAX

Current values are aggregated by finding the maximum of current values. minAllowedValue is aggregated by finding the minimum of minAllowedValue. maxAllowedValue is aggregated by finding the maximum of maxAllowedValue.

Method Detail

values

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

Returns:

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

valueOf

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