Package com.helger.commons.statistics

Class StatisticsHandlerKeyedCounter

java.lang.Object

com.helger.commons.statistics.StatisticsHandlerKeyedCounter

All Implemented Interfaces:

IMutableStatisticsHandlerKeyedCounter, IStatisticsHandler, IStatisticsHandlerKeyed, IStatisticsHandlerKeyedCounter

@ThreadSafe
public class StatisticsHandlerKeyedCounter
extends Object
implements IMutableStatisticsHandlerKeyedCounter

Default implementation of IMutableStatisticsHandlerKeyedCounter

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
StatisticsHandlerKeyedCounter()

Method Summary

Modifier and Type	Method	Description
ICommonsSet<String>	getAllKeys()
long	getCount(String sKey)	Get the count of a certain key.
int	getInvocationCount()
int	getInvocationCount(String sKey)	Get the invocation count for a single key.
void	increment(String sKey, long nByHowMany)	Increment by n

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.statistics.IMutableStatisticsHandlerKeyedCounter

increment

Constructor Detail

StatisticsHandlerKeyedCounter

public StatisticsHandlerKeyedCounter()

Method Detail

getInvocationCount

@Nonnegative
public int getInvocationCount()

Specified by:

getInvocationCount in interface IStatisticsHandler

Returns:

The number of times this statistics hander was invoked.

increment

public void increment(@Nullable
                      String sKey,
                      long nByHowMany)

Description copied from interface: IMutableStatisticsHandlerKeyedCounter

Increment by n

Specified by:

increment in interface IMutableStatisticsHandlerKeyedCounter

Parameters:

sKey - The key to be incremented.

nByHowMany - The amount to increment. May be negative as well

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.

getCount

@CheckForSigned
public long getCount(@Nullable
                     String sKey)

Description copied from interface: IStatisticsHandlerKeyedCounter

Get the count of a certain key.

Specified by:

getCount in interface IStatisticsHandlerKeyedCounter

Parameters:

sKey - The key to retrieve the count from

Returns:

CGlobal.ILLEGAL_ULONG if no such key is present.

getInvocationCount

@CheckForSigned
public 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