com.github.rollingmetrics.counter

Class ResetPeriodicallyCounter

java.lang.Object

com.github.rollingmetrics.counter.ResetPeriodicallyCounter

All Implemented Interfaces:

WindowCounter

public class ResetPeriodicallyCounter
extends Object
implements WindowCounter

The counter which reset its state to zero each time when configured interval is elapsed.

Concurrency properties:

• Writing is lock-free.
• Sum reading is lock-free.

Usage recommendations:

• When you do not need in "rolling time window" semantic. Else use SmoothlyDecayingRollingCounter
• When you want to limit time which each increment takes affect to counter sum in order to avoid reporting of obsolete measurements.
• Only if you accept the fact that several increments can be never observed by reader(because rotation to zero can happen before reader seen the written values).

See Also:

SmoothlyDecayingRollingCounter

Constructor Summary

Constructors

Constructor and Description
ResetPeriodicallyCounter(Duration resetInterval) Constructs the counter which reset its state to zero each time when resetInterval is elapsed.
ResetPeriodicallyCounter(Duration resetInterval, Ticker ticker)

Method Summary

Modifier and Type	Method and Description
void	add(long delta) Increment the counter by delta.
long	getSum() Returns the counter's current value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResetPeriodicallyCounter

public ResetPeriodicallyCounter(Duration resetInterval)

Constructs the counter which reset its state to zero each time when resetInterval is elapsed.

Parameters:

resetInterval - the interval between counter resetting

ResetPeriodicallyCounter

public ResetPeriodicallyCounter(Duration resetInterval,
                                Ticker ticker)

Method Detail

add

public void add(long delta)

Description copied from interface: WindowCounter

Increment the counter by delta. If You want to decrement instead of increment then use negative delta.

Specified by:

add in interface WindowCounter

Parameters:

delta - the amount by which the counter will be increased

getSum

public long getSum()

Description copied from interface: WindowCounter

Returns the counter's current value.

Specified by:

getSum in interface WindowCounter

Returns:

the counter's current value

toString

public String toString()

Overrides:

toString in class Object