com.opencloud.rhino.monitoring.stats.ext

Enum SubscriptionMode

java.lang.Object

java.lang.Enum<SubscriptionMode>

com.opencloud.rhino.monitoring.stats.ext.SubscriptionMode

All Implemented Interfaces:

Serializable, Comparable<SubscriptionMode>

public enum SubscriptionMode
extends Enum<SubscriptionMode>

Defines mode specifiers that client’s can use when subscribing to statistics.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELTA_COUNTER Delta counter — client receives delta value between successive samples
PER_SECOND_COUNTER Delta counter — client receives delta value representing the per second difference between successive samples, rounded to the nearest whole integer.
PERMANENT_FREQUENCY_DISTRIBUTION Permanent frequency distribution where all samples always contribute (no rollover)
RESETTING_FREQUENCY_DISTRIBUTION Frequency distribution where samples always contribute and the distribution is cleared when read by client
ROLLING_FREQUENCY_DISTRIBUTION Frequency distribution with multiple generations and automatic rollover (default)
SIMPLE_COUNTER Simple counter — client receives exact value of counter
SIMPLE_GAUGE Simple gauge — client receives exact value of gauge

Method Summary

Modifier and Type	Method and Description
static String	describe(SubscriptionMode mode)
static boolean	isValidCounterMode(SubscriptionMode mode)
static boolean	isValidSampleMode(SubscriptionMode mode)
static SubscriptionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubscriptionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIMPLE_COUNTER

public static final SubscriptionMode SIMPLE_COUNTER

Simple counter — client receives exact value of counter

SIMPLE_GAUGE

public static final SubscriptionMode SIMPLE_GAUGE

Simple gauge — client receives exact value of gauge

DELTA_COUNTER

public static final SubscriptionMode DELTA_COUNTER

Delta counter — client receives delta value between successive samples

PER_SECOND_COUNTER

public static final SubscriptionMode PER_SECOND_COUNTER

Delta counter — client receives delta value representing the per second difference between successive samples, rounded to the nearest whole integer.

ROLLING_FREQUENCY_DISTRIBUTION

public static final SubscriptionMode ROLLING_FREQUENCY_DISTRIBUTION

Frequency distribution with multiple generations and automatic rollover (default)

PERMANENT_FREQUENCY_DISTRIBUTION

public static final SubscriptionMode PERMANENT_FREQUENCY_DISTRIBUTION

Permanent frequency distribution where all samples always contribute (no rollover)

RESETTING_FREQUENCY_DISTRIBUTION

public static final SubscriptionMode RESETTING_FREQUENCY_DISTRIBUTION

Frequency distribution where samples always contribute and the distribution is cleared when read by client

Method Detail

values

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

Returns:

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

valueOf

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

describe

public static String describe(SubscriptionMode mode)

isValidCounterMode

public static boolean isValidCounterMode(SubscriptionMode mode)

isValidSampleMode

public static boolean isValidSampleMode(SubscriptionMode mode)