StopwatchMXBean (Java Simon 4.2.0 API)

All Superinterfaces:

Serializable, SimonSuperMXBean

All Known Implementing Classes:

StopwatchMXBeanImpl
```
public interface StopwatchMXBean
extends SimonSuperMXBean
```
Interface for MX Bean representing a particular Stopwatch. It is not created by default when JMX is activated - it must be created explicitly. JmxRegisterCallback can be used to automate this.

Author:

Richard "Virgo" Richter

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getActive()` Returns current number of measured splits (concurrently running).
`long`	`getCounter()` Returns usage count of the stopwatch.
`long`	`getLast()` Returns value of the last added split - whether it was added directly or with stop method.
`String`	`getLastAsString()` Returns value of the last added split as formatted string.
`long`	`getMax()` Returns maximal time split value in nanoseconds.
`long`	`getMaxActive()` Returns peek value of active concurrent splits.
`long`	`getMaxActiveTimestamp()` Returns ms timestamp when the last peek of the active split count occurred.
`long`	`getMaxTimestamp()` Returns ms timestamp when the max value was measured.
`double`	`getMean()` Returns mean value (average) of all measured values.
`long`	`getMin()` Returns minimal time split value in nanoseconds.
`long`	`getMinTimestamp()` Returns ms timestamp when the min value was measured.
`double`	`getStandardDeviation()` Returns standard deviation for all measured values.
`long`	`getTotal()` Returns total sum of all split times in nanoseconds.
`double`	`getVariance()` Returns unbiased estimate of the population variance.
`double`	`getVarianceN()` Returns variance value of all measured values (entire population).
`StopwatchSample`	`sample()` Samples Simon values and returns them in a Java Bean derived from Sample interface.
`StopwatchSample`	`sampleIncrement(String key)` Samples increment in Simon values since the previous call of this method with the same key.

Methods inherited from interface org.javasimon.jmx.SimonSuperMXBean
getChildrenNames, getFirstUsage, getFirstUsageAsString, getLastUsage, getLastUsageAsString, getName, getNote, getParentName, getState, getType, isEnabled, setNote, setState, stopIncrementalSampling

- Method Detail
  - getTotal
```
long getTotal()
```
    Returns total sum of all split times in nanoseconds.
    
    Returns:
    
    total time of the stopwatch in nanoseconds
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getTotal()
  - getLast
```
long getLast()
```
    Returns value of the last added split - whether it was added directly or with stop method.
    
    Returns:
    
    value of the last added split
    
    See Also:
    
    Stopwatch.getLast()
  - getLastAsString
```
String getLastAsString()
```
    Returns value of the last added split as formatted string.
    
    Returns:
    
    value of the last added split as string
  - getCounter
```
long getCounter()
```
    Returns usage count of the stopwatch. Counter is increased by addTime and stop - that means that it's updated every time the next time split is added.
    
    Returns:
    
    count of time splits
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getCounter()
  - getMax
```
long getMax()
```
    Returns maximal time split value in nanoseconds.
    
    Returns:
    
    maximal time split in nanoseconds
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMax()
  - getMin
```
long getMin()
```
    Returns minimal time split value in nanoseconds.
    
    Returns:
    
    minimal time split in nanoseconds
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMin()
  - getMaxTimestamp
```
long getMaxTimestamp()
```
    Returns ms timestamp when the max value was measured.
    
    Returns:
    
    ms timestamp of the max value measurement
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMaxTimestamp()
  - getMinTimestamp
```
long getMinTimestamp()
```
    Returns ms timestamp when the min value was measured.
    
    Returns:
    
    ms timestamp of the min value measurement
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMinTimestamp()
  - getActive
```
long getActive()
```
    Returns current number of measured splits (concurrently running).
    
    Returns:
    
    current number of active splits
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getActive()
  - getMaxActive
```
long getMaxActive()
```
    Returns peek value of active concurrent splits.
    
    Returns:
    
    maximum reached value of active splits
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMaxActive()
  - getMaxActiveTimestamp
```
long getMaxActiveTimestamp()
```
    Returns ms timestamp when the last peek of the active split count occurred.
    
    Returns:
    
    ms timestamp of the last peek of the active split count
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMaxActiveTimestamp()
  - getMean
```
double getMean()
```
    Returns mean value (average) of all measured values.
    
    Returns:
    
    mean value
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getMean()
  - getStandardDeviation
```
double getStandardDeviation()
```
    Returns standard deviation for all measured values.
    
    Returns:
    
    standard deviation
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getStandardDeviation()
  - getVariance
```
double getVariance()
```
    Returns unbiased estimate of the population variance.
    
    Returns:
    
    unbiased estimated variance
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getVariance()
  - getVarianceN
```
double getVarianceN()
```
    Returns variance value of all measured values (entire population).
    
    Returns:
    
    entire population variance
    
    Since:
    
    3.3
    
    See Also:
    
    Stopwatch.getVarianceN()
  - sample
```
StopwatchSample sample()
```
    Description copied from interface: SimonSuperMXBean
    
    Samples Simon values and returns them in a Java Bean derived from Sample interface.
    
    Specified by:
    
    sample in interface SimonSuperMXBean
    
    Returns:
    
    sample containing all Simon values
  - sampleIncrement
```
StopwatchSample sampleIncrement(String key)
```
    Description copied from interface: SimonSuperMXBean
    
    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 SimonSuperMXBean.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.
    
    Specified by:
    
    sampleIncrement in interface SimonSuperMXBean
    
    Parameters:
    
    key - key used to access incremental sample
    
    Returns:
    
    Sample with value increments

Interface StopwatchMXBean

Method Summary

Methods inherited from interface org.javasimon.jmx.SimonSuperMXBean

Method Detail

getTotal

getLast

getLastAsString

getCounter

getMax

getMin

getMaxTimestamp

getMinTimestamp

getActive

getMaxActive

getMaxActiveTimestamp

getMean

getStandardDeviation

getVariance

getVarianceN

sample

sampleIncrement