org.jboss.byteman.sample.helper

Class KeyInfo

java.lang.Object

org.jboss.byteman.sample.helper.KeyInfo

public class KeyInfo
extends Object

Auxiliary class used by the rule set to provide information about which counters the rule system will be updating and how it wants them to be presented in the JMX bean display

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_TYPE_CUMULATIVE type value identifying a counter whose value should be treated as a running total.
static int	KEY_TYPE_MEAN type value identifying a counter whose value should be used to compute a running average by dividing the running total for the last N samples by N where N is 5.
static int	KEY_TYPE_RATE type value identifying a counter whose value should be used to compute a rate by dividing the sampled count by the time in seconds over which the sample was obtained.

Constructor Summary

Constructors

Constructor and Description
KeyInfo()
KeyInfo(String label)
KeyInfo(String label, String[] keyNames)
KeyInfo(String label, String[] keyNames, int[] keyTypes)
KeyInfo(String label, String[] keyNames, int[] keyTypes, String[] keyLabels)
KeyInfo(String label, String[] keyNames, String[] keyLabels)

Method Summary

Methods

Modifier and Type	Method and Description
void	addKey(String keyName)
KeyInfo	addKey(String keyName, int keyType)
KeyInfo	addKey(String keyName, int keyType, String keyLabel)
int	getKeyCount()
String[]	getKeyLabels()
String[]	getKeyNames()
int[]	getKeyTypes()
String	getLabel()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_TYPE_CUMULATIVE

public static final int KEY_TYPE_CUMULATIVE

type value identifying a counter whose value should be treated as a running total. the value is displayed as an int.

See Also:

Constant Field Values

KEY_TYPE_RATE

public static final int KEY_TYPE_RATE

type value identifying a counter whose value should be used to compute a rate by dividing the sampled count by the time in seconds over which the sample was obtained. the value is displayed as a float.

See Also:

Constant Field Values

KEY_TYPE_MEAN

public static final int KEY_TYPE_MEAN

type value identifying a counter whose value should be used to compute a running average by dividing the running total for the last N samples by N where N is 5. the value is displayed as a float.

See Also:

Constant Field Values

Constructor Detail

KeyInfo

public KeyInfo()

KeyInfo

public KeyInfo(String label)

KeyInfo

public KeyInfo(String label,
       String[] keyNames)

KeyInfo

public KeyInfo(String label,
       String[] keyNames,
       String[] keyLabels)

KeyInfo

public KeyInfo(String label,
       String[] keyNames,
       int[] keyTypes)

KeyInfo

public KeyInfo(String label,
       String[] keyNames,
       int[] keyTypes,
       String[] keyLabels)

Method Detail

getLabel

public String getLabel()

getKeyCount

public int getKeyCount()

getKeyNames

public String[] getKeyNames()

getKeyTypes

public int[] getKeyTypes()

getKeyLabels

public String[] getKeyLabels()

addKey

public void addKey(String keyName)

addKey

public KeyInfo addKey(String keyName,
             int keyType)

addKey

public KeyInfo addKey(String keyName,
             int keyType,
             String keyLabel)