com.j256.simplemetrics.metric

Interface MetricValue<V,MV extends MetricValue<V,MV>>

Type Parameters:

V - Value type that we use to adjust this metric-value.

MV - MetricValue type that holds the metric-value information. We need this because of makePersisted() and makeAdjusted(Object) must be of the same type.

All Known Implementing Classes:

ControlledMetricAccum.AccumValue, ControlledMetricRatio.RatioValue, ControlledMetricValue.ValueCount

public interface MetricValue<V,MV extends MetricValue<V,MV>>

Metric values that wraps a raw metric value.

Method Summary

Modifier and Type	Method and Description
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.
MV	makeAdjusted(V value) Make a new entry adjusted by the value parameter.
MV	makePersisted() Make an entry that is suitable for persisting.

Method Detail

makePersisted

MV makePersisted()

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.

makeAdjusted

MV makeAdjusted(V value)

Make a new entry adjusted by the value parameter.

getValue

Number getValue()

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

getNumSamples

int getNumSamples()

Get the number of samples from the metric value.

getMin

Number getMin()

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

getMax

Number getMax()

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