org.arl.fjage.observer

Enum ObserverParam

java.lang.Object

java.lang.Enum<ObserverParam>

org.arl.fjage.observer.ObserverParam

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ObserverParam>, Parameter

public enum ObserverParam
extends java.lang.Enum<ObserverParam>
implements Parameter

Parameters supported by Observer, so that an observer can be inspected and controlled from a shell or over a gateway.

Enum Constant Summary

Enum Constants

Enum Constant and Description
connections Number of web clients currently connected.
count Number of messages published so far.
dropped Number of messages dropped by the rate limiter so far.
enabled Whether messages are being observed.
endpoints Endpoints (agents and topics) seen so far.
maxRate Maximum number of messages published per second, 0 for no limit.
url URL of the web interface.

Method Summary

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

Methods inherited from interface org.arl.fjage.param.Parameter

name, ordinal

Enum Constant Detail

enabled

public static final ObserverParam enabled

Whether messages are being observed.

count

public static final ObserverParam count

Number of messages published so far.

dropped

public static final ObserverParam dropped

Number of messages dropped by the rate limiter so far.

maxRate

public static final ObserverParam maxRate

Maximum number of messages published per second, 0 for no limit.

url

public static final ObserverParam url

URL of the web interface.

connections

public static final ObserverParam connections

Number of web clients currently connected.

endpoints

public static final ObserverParam endpoints

Endpoints (agents and topics) seen so far.

Method Detail

values

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

Returns:

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

valueOf

public static ObserverParam valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null