Package com.helger.commons.statistics

Class AbstractStatisticsHandlerKeyedNumeric

java.lang.Object

com.helger.commons.statistics.AbstractStatisticsHandlerKeyedNumeric

All Implemented Interfaces:

IStatisticsHandler, IStatisticsHandlerKeyed, IStatisticsHandlerKeyedNumeric

Direct Known Subclasses:

StatisticsHandlerKeyedSize, StatisticsHandlerKeyedTimer

@ThreadSafe
public abstract class AbstractStatisticsHandlerKeyedNumeric
extends Object
implements IStatisticsHandlerKeyedNumeric

Abstract base class for a keyed numeric statistic handler

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
AbstractStatisticsHandlerKeyedNumeric()

Method Summary

Modifier and Type	Method	Description
protected void	addValue(String sKey, long nValue)
ICommonsSet<String>	getAllKeys()
long	getAverage(String sKey)
int	getInvocationCount()
int	getInvocationCount(String sKey)	Get the invocation count for a single key.
long	getMax(String sKey)
long	getMin(String sKey)
BigInteger	getSum(String sKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStatisticsHandlerKeyedNumeric

public AbstractStatisticsHandlerKeyedNumeric()

Method Detail

getInvocationCount

@Nonnegative
public final int getInvocationCount()

Specified by:

getInvocationCount in interface IStatisticsHandler

Returns:

The number of times this statistics hander was invoked.

getAllKeys

@Nonnull
@ReturnsMutableCopy
public ICommonsSet<String> getAllKeys()

Specified by:

getAllKeys in interface IStatisticsHandlerKeyed

Returns:

A collection of all keys that have a value assigned. Never null.

addValue

protected final void addValue(@Nullable
                              String sKey,
                              long nValue)

getInvocationCount

@CheckForSigned
public final int getInvocationCount(@Nullable
                                    String sKey)

Description copied from interface: IStatisticsHandlerKeyed

Get the invocation count for a single key.

Specified by:

getInvocationCount in interface IStatisticsHandlerKeyed

Parameters:

sKey - The key to be queried. May be null.

Returns:

The invocation count for a single key or CGlobal.ILLEGAL_UINT if no such key exists

getSum

@Nullable
public final BigInteger getSum(@Nullable
                               String sKey)

Specified by:

getSum in interface IStatisticsHandlerKeyedNumeric

Parameters:

sKey - The key to be queried.

Returns:

The sum of aggregated values. null if no such key exists.

getMin

@CheckForSigned
public final long getMin(@Nullable
                         String sKey)

Specified by:

getMin in interface IStatisticsHandlerKeyedNumeric

Parameters:

sKey - The key to be queried.

Returns:

The smallest value. Returns CGlobal.ILLEGAL_ULONG if no such key exists.

getAverage

@CheckForSigned
public final long getAverage(@Nullable
                             String sKey)

Specified by:

getAverage in interface IStatisticsHandlerKeyedNumeric

Parameters:

sKey - The key to be queried.

Returns:

The average value (=sum/invocationCount). Returns CGlobal.ILLEGAL_ULONG if no such key exists.

getMax

@CheckForSigned
public long getMax(@Nullable
                   String sKey)

Specified by:

getMax in interface IStatisticsHandlerKeyedNumeric

Parameters:

sKey - The key to be queried.

Returns:

The biggest value. Returns CGlobal.ILLEGAL_ULONG if no such key exists.