com.j256.simplemetrics.metric

Class ControlledMetricAccum.AccumValue

java.lang.Object

com.j256.simplemetrics.metric.ControlledMetricAccum.AccumValue

All Implemented Interfaces:

MetricValue<Long,ControlledMetricAccum.AccumValue>

Enclosing class:

ControlledMetricAccum

public static class ControlledMetricAccum.AccumValue
extends Object
implements MetricValue<Long,ControlledMetricAccum.AccumValue>

Wrapper around a long counter and a reset flag.

Method Summary

Modifier and Type	Method and Description
static ControlledMetricAccum.AccumValue	createInitialValue()
Number	getMax() Get the maximum value of the metric since the last persist.
Number	getMin() Get the minimum value of the metric since the last persist.
int	getNumSamples() Get the number of samples from the metric value.
Number	getValue() Get the number value from this metric value.
ControlledMetricAccum.AccumValue	makeAdjusted(Long newValue) Make a new entry adjusted by the value parameter.
ControlledMetricAccum.AccumValue	makePersisted() Make an entry that is suitable for persisting.

Methods inherited from class java.lang.Object

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

Method Detail

createInitialValue

public static ControlledMetricAccum.AccumValue createInitialValue()

makePersisted

public ControlledMetricAccum.AccumValue makePersisted()

Description copied from interface: MetricValue

Make an entry that is suitable for persisting. We do this so the metric retains its value and doesn't immediately drop to 0 or something immediately after a persist event. The next time we adjust the value or we persist it again, the value will be reset beforehand.

Specified by:

makePersisted in interface MetricValue<Long,ControlledMetricAccum.AccumValue>

makeAdjusted

public ControlledMetricAccum.AccumValue makeAdjusted(Long newValue)

Description copied from interface: MetricValue

Make a new entry adjusted by the value parameter.

Specified by:

makeAdjusted in interface MetricValue<Long,ControlledMetricAccum.AccumValue>

getValue

public Number getValue()

Description copied from interface: MetricValue

Get the number value from this metric value. This is a transient value good for JMX or other direct monitoring of the metric. Use MetricValue.makePersisted() if you want to save the value to disk.

Specified by:

getValue in interface MetricValue<Long,ControlledMetricAccum.AccumValue>

getNumSamples

public int getNumSamples()

Description copied from interface: MetricValue

Get the number of samples from the metric value.

Specified by:

getNumSamples in interface MetricValue<Long,ControlledMetricAccum.AccumValue>

getMin

public Number getMin()

Description copied from interface: MetricValue

Get the minimum value of the metric since the last persist. Will be 0 if num-samples is 0.

Specified by:

getMin in interface MetricValue<Long,ControlledMetricAccum.AccumValue>

getMax

public Number getMax()

Description copied from interface: MetricValue

Get the maximum value of the metric since the last persist. Will be 0 if num-samples is 0.

Specified by:

getMax in interface MetricValue<Long,ControlledMetricAccum.AccumValue>