SimonSuperMXBean (Java Simon 4.2.0 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

CounterMXBean, StopwatchMXBean

All Known Implementing Classes:

AbstractSimonMXBeanImpl, CounterMXBeanImpl, StopwatchMXBeanImpl
```
public interface SimonSuperMXBean
extends Serializable
```
Interface with common methods for JMX beans for a single Simon that corresponds to AbstractSimon in the core package.

Author:

Richard "Virgo" Richter

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<String>`	`getChildrenNames()` Returns list of children names.
`long`	`getFirstUsage()` Returns ms timestamp of the first usage of this Simon.
`String`	`getFirstUsageAsString()` Returns nicely formatted timestamp of the first usage of this Simon.
`long`	`getLastUsage()` Returns ms timestamp of the last usage of this Simon.
`String`	`getLastUsageAsString()` Returns nicely formatted timestamp of the last usage of this Simon.
`String`	`getName()` Returns Simon name.
`String`	`getNote()` Returns note for the Simon.
`String`	`getParentName()` Returns name of the parent Simon.
`String`	`getState()` Returns state of the Simon that can be ENABLED, DISABLED or INHERITED.
`String`	`getType()` Returns Simon type used as a property in the `ObjectName`.
`boolean`	`isEnabled()` Returns true, if the Simon is enabled or if the enabled state is inherited.
`Sample`	`sample()` Samples Simon values and returns them in a Java Bean derived from Sample interface.
`Sample`	`sampleIncrement(String key)` Samples increment in Simon values since the previous call of this method with the same key.
`void`	`setNote(String note)` Sets note for the Simon.
`void`	`setState(String state, boolean overrule)` Sets the state of the Simon.
`boolean`	`stopIncrementalSampling(String key)` Stops incremental sampling for the key, removing any internal information for the key.

- Method Detail
  - getName
```
String getName()
```
    Returns Simon name. While Simon names can be null for anonymous Simons, such Simons are never registered hence this method never returns null.
    
    Returns:
    
    name of the Simon
  - getParentName
```
String getParentName()
```
    Returns name of the parent Simon.
    
    Returns:
    
    name of the parent Simon
  - getChildrenNames
```
List<String> getChildrenNames()
```
    Returns list of children names.
    
    Returns:
    
    list of children names
  - getState
```
String getState()
```
    Returns state of the Simon that can be ENABLED, DISABLED or INHERITED. State is returned as a String that matches values of the SimonState enumeration.
    
    Returns:
    
    state of the Simon as a String
  - setState
```
void setState(String state,
              boolean overrule)
```
    Sets the state of the Simon. It must be specified whether to propagate the change and overrule states of all sub-simons which effectively sets the same state to the whole subtree. If subtree is not overruled, some Simons (with their subtrees) may not be affected by this change.
    
    Parameters:
    
    state - a new state as a valid String for SimonState.valueOf(String)
    
    overrule - specifies whether this change is forced to the whole subtree.
  - isEnabled
```
boolean isEnabled()
```
    Returns true, if the Simon is enabled or if the enabled state is inherited.
    
    Returns:
    
    true, if the Simon is effectively enabled
  - getNote
```
String getNote()
```
    Returns note for the Simon. Note enables Simon with an additional information in human readable form.
    
    Returns:
    
    note for the Simon.
  - setNote
```
void setNote(String note)
```
    Sets note for the Simon. Note enables Simon with an additional information in human readable form.
    
    Parameters:
    
    note - note for the Simon.
  - getFirstUsage
```
long getFirstUsage()
```
    Returns ms timestamp of the first usage of this Simon. First and last usage are updated when monitor performs the measuring (start/stop/count/etc). They are not updated when values are obtained from the monitor.
    
    Returns:
    
    ms timestamp of the first usage
  - getFirstUsageAsString
```
String getFirstUsageAsString()
```
    Returns nicely formatted timestamp of the first usage of this Simon.
    
    Returns:
    
    formatted date and time of the first usage
  - getLastUsage
```
long getLastUsage()
```
    Returns ms timestamp of the last usage of this Simon. First and last usage are updated when monitor performs the measuring (start/stop/count/etc). They are not updated when values are obtained from the monitor.
    
    Returns:
    
    ms timestamp of the last usage
  - getLastUsageAsString
```
String getLastUsageAsString()
```
    Returns nicely formatted timestamp of the last usage of this Simon.
    
    Returns:
    
    formatted date and time of the last usage
  - sample
```
Sample sample()
```
    Samples Simon values and returns them in a Java Bean derived from Sample interface.
    
    Returns:
    
    sample containing all Simon values
  - sampleIncrement
```
Sample sampleIncrement(String key)
```
    Samples increment in Simon values since the previous call of this method with the same key. When the method is called the first time for the key, current values are returned (same like from sample(). Any subsequent calls with the key provide increments.
    Clients should use a unique key (GUID, host name, etc.), to avoid interference with other clients.
    
    Parameters:
    
    key - key used to access incremental sample
    
    Returns:
    
    Sample with value increments
  - getType
```
String getType()
```
    Returns Simon type used as a property in the ObjectName.
    
    Returns:
    
    Simon type
  - stopIncrementalSampling
```
boolean stopIncrementalSampling(String key)
```
    Stops incremental sampling for the key, removing any internal information for the key. Next call to sampleIncrement(String) for the key will be considered the first call for the key.
    
    Parameters:
    
    key - key used to access incremental sample
    
    Returns:
    
    true if incremental information for the key existed, false otherwise

Interface SimonSuperMXBean

Method Summary

Method Detail

getName

getParentName

getChildrenNames

getState

setState

isEnabled

getNote

setNote

getFirstUsage

getFirstUsageAsString

getLastUsage

getLastUsageAsString

sample

sampleIncrement

getType

stopIncrementalSampling