com.j256.simplemetrics.metric

Class ControlledMetricValue.ValueCount

java.lang.Object

com.j256.simplemetrics.metric.ControlledMetricValue.ValueCount

All Implemented Interfaces:

MetricValue<Double,ControlledMetricValue.ValueCount>

Enclosing class:

ControlledMetricValue

public static class ControlledMetricValue.ValueCount
extends Object
implements MetricValue<Double,ControlledMetricValue.ValueCount>

Wrapper around a current value and count so we can calculate averages internally.

Method Summary

Modifier and Type	Method and Description
static ControlledMetricValue.ValueCount	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.
ControlledMetricValue.ValueCount	makeAdjusted(Double value) Make a new entry adjusted by the value parameter.
ControlledMetricValue.ValueCount	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 ControlledMetricValue.ValueCount createInitialValue()

makePersisted

public ControlledMetricValue.ValueCount 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<Double,ControlledMetricValue.ValueCount>

makeAdjusted

public ControlledMetricValue.ValueCount makeAdjusted(Double value)

Description copied from interface: MetricValue

Make a new entry adjusted by the value parameter.

Specified by:

makeAdjusted in interface MetricValue<Double,ControlledMetricValue.ValueCount>

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<Double,ControlledMetricValue.ValueCount>

getNumSamples

public int getNumSamples()

Description copied from interface: MetricValue

Get the number of samples from the metric value.

Specified by:

getNumSamples in interface MetricValue<Double,ControlledMetricValue.ValueCount>

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<Double,ControlledMetricValue.ValueCount>

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<Double,ControlledMetricValue.ValueCount>