sirius.kernel.health

Class Counter

java.lang.Object

sirius.kernel.health.Counter

public class Counter
extends Object

Represents a counter for statistical use. Overflows to 0 instead to Long.MIN_VALUE

Counts up to Long.MAX_VALUE - 1 starting at 0 and overflowing to 0.

Constructor Summary

Constructors

Constructor and Description
Counter() Creates a new counter up to Long.MAX.VALUE - 1
Counter(long max) Creates a new counter with the given max. value

Method Summary

Modifier and Type	Method and Description
long	add(long delta) Adds the given delta to the counter.
double	getAvgPer(TimeUnit unit) Computes the average raise per given unit of time.
long	getCount() Returns the current value of the counter
long	getDuration(TimeUnit unit) Returns the time since the counter was created.
long	inc() Increments the counter by one
void	reset() Resets the counter to zero
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Counter

public Counter(long max)

Creates a new counter with the given max. value

Parameters:

max - maximal value which will force to counter to overflow and reset to 0

Counter

public Counter()

Creates a new counter up to Long.MAX.VALUE - 1

Method Detail

inc

public long inc()

Increments the counter by one

Returns:

the update value of the counter

add

public long add(long delta)

Adds the given delta to the counter.

Parameters:

delta - the delta to add

Returns:

the update value of the counter

getAvgPer

public double getAvgPer(TimeUnit unit)

Computes the average raise per given unit of time.

Parameters:

unit - the unit of time to compute the average for.

Returns:

the average increment per given time unit

getCount

public long getCount()

Returns the current value of the counter

Returns:

the value of the counter

getDuration

public long getDuration(TimeUnit unit)

Returns the time since the counter was created.

Parameters:

unit - the time unit used for the return value

Returns:

the time since the creation of the counter in the given time unit

reset

public void reset()

Resets the counter to zero

toString

public String toString()

Overrides:

toString in class Object