io.rainfall.statistics

Class RainfallHistogramSink<E extends Enum<E>>

java.lang.Object

io.rainfall.statistics.RainfallHistogramSink<E>

public class RainfallHistogramSink<E extends Enum<E>>
extends Object

This is a thin facade on the Histogram class's recording functions. Per thread Histograms are created via a factory method. Other than the 3 record... methods, the reset(), marks the per thread histograms and resets the values, as dead, and fetchHistogram() method returns an aggregate Histogram of all the active histograms.

Author:

cschanck, Aurelien Broszniowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RainfallHistogramSink.Factory

Constructor Summary

Constructors

Constructor and Description
RainfallHistogramSink(RainfallHistogramSink.Factory factory)

Method Summary

Modifier and Type	Method and Description
org.HdrHistogram.Histogram	fetchHistogram(Enum<E> result)
void	recordValue(Enum result, long value)
void	recordValueWithCount(Enum<E> result, long value, long count)
void	recordValueWithExpectedInterval(Enum<E> result, long value, long expectedIntervalBetweenValueSamples)
void	reset()

Methods inherited from class java.lang.Object

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

Constructor Detail

RainfallHistogramSink

public RainfallHistogramSink(RainfallHistogramSink.Factory factory)

Method Detail

recordValueWithExpectedInterval

public void recordValueWithExpectedInterval(Enum<E> result,
                                            long value,
                                            long expectedIntervalBetweenValueSamples)

recordValueWithCount

public void recordValueWithCount(Enum<E> result,
                                 long value,
                                 long count)

recordValue

public void recordValue(Enum result,
                        long value)

fetchHistogram

public org.HdrHistogram.Histogram fetchHistogram(Enum<E> result)

reset

public void reset()