Package com.arpnetworking.metrics.mad.model.statistics

Interface Accumulator<T>

Type Parameters:

T - The type of supporting data.

All Superinterfaces:

Calculator<T>

All Known Implementing Classes:

MaxStatistic.MaxAccumulator, MinStatistic.MinAccumulator, SumStatistic.SumAccumulator

public interface Accumulator<T>
extends Calculator<T>

Specialization of Calculator directly supporting streaming calculations over Quantity and CalculatedValue streams.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Method Summary

Modifier and Type	Method	Description
Accumulator<T>	accumulate(Quantity quantity)	Add the specified Quantity to the accumulated value.
Accumulator<T>	accumulate(CalculatedValue<T> calculatedValue)	Add the specified CalculatedValue to the accumulated value.
Accumulator<T>	accumulateAny(CalculatedValue<?> calculatedValue)	Add the specified CalculatedValue to the accumulated value.

Methods inherited from interface com.arpnetworking.metrics.mad.model.statistics.Calculator

calculate, getStatistic

Method Details

accumulate

Accumulator<T> accumulate(Quantity quantity)

Add the specified Quantity to the accumulated value. It is permissible to mix calls to accumulate with Quantity and CalculatedValue.

Parameters:

quantity - The Quantity to include in the accumulated value.

Returns:

This Accumulator.

accumulate

Accumulator<T> accumulate(CalculatedValue<T> calculatedValue)

Add the specified CalculatedValue to the accumulated value. The CalculatedValue was produced by this Accumulator in a different context. For example, for a different time period or a different host. It is permissible to mix calls to accumulate with Quantity and CalculatedValue.

Parameters:

calculatedValue - The CalculatedValue to include in the accumulated value.

Returns:

This Accumulator.

accumulateAny

Accumulator<T> accumulateAny(CalculatedValue<?> calculatedValue)

Add the specified CalculatedValue to the accumulated value. The CalculatedValue was produced by this Accumulator in a different context. For example, for a different time period or a different host. It is permissible to mix calls to accumulate with Quantity and CalculatedValue. If the CalculatedValue's supporting data is of an unsupported type then an IllegalArgumentException will be thrown.

Parameters:

calculatedValue - The CalculatedValue to include in the accumulated value.

Returns:

This Accumulator.