com.yahoo.statistics

Class Counter

java.lang.Object

com.yahoo.statistics.Handle

com.yahoo.statistics.Counter

public class Counter
extends Handle

A single integer value which can be incremented.

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicLong	current
private boolean	resetCounter

Constructor Summary

Constructors

Modifier	Constructor and Description
	Counter(String name, Statistics manager, boolean fetchParametersFromConfig) A monotonically increasing 64 bit integer value.
	Counter(String name, Statistics manager, boolean fetchParametersFromConfig, Callback callback, boolean resetCounter) A monotonically increasing 64 bit integer value.
private	Counter(String name, Statistics manager, boolean fetchParametersFromConfig, Callback callback, boolean resetCounter, boolean register) A monotonically increasing 64 bit integer value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	get()
(package private) CounterProxy	getProxyAndReset()
boolean	getResetCounter() The reset counter is true if this is counter is reset to 0 between each logging interval.
private static boolean	getResetCounter(String name, com.yahoo.container.StatisticsConfig config) If this Counter is set up to read config, configure it according to the config given.
int	hashCode()
void	increment() Increment by 1.
void	increment(long n) Increment by n.
(package private) static Counter	intializeUnregisteredCounter(String name, boolean resetCounter) Get a Counter instance not registered in the statistics manager.
void	reset() If this counter should be set to 0 between each logging interval, do that.
void	runHandle() Log current state and reset.
String	toString()

Methods inherited from class com.yahoo.statistics.Handle

cancel, getName, isCancelled, makeTask, run, runCallback

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

current

private AtomicLong current

resetCounter

private final boolean resetCounter

Constructor Detail

Counter

public Counter(String name,
               Statistics manager,
               boolean fetchParametersFromConfig)

A monotonically increasing 64 bit integer value.

Parameters:

name - The name of this counter, for use in logging.

manager - the statistics manager acquired by injection

fetchParametersFromConfig - Whether or not this counter should be initialized from config.

Counter

public Counter(String name,
               Statistics manager,
               boolean fetchParametersFromConfig,
               Callback callback,
               boolean resetCounter)

A monotonically increasing 64 bit integer value.

Parameters:

name - The name of this counter, for use in logging.

manager - the statistics manager acquired by injection

fetchParametersFromConfig - Whether or not this counter should be initialized from config.

callback - will be invoked each time this counter is written to the log

resetCounter - Control for if this Counter should be reset between each logging interval.

Counter

private Counter(String name,
                Statistics manager,
                boolean fetchParametersFromConfig,
                Callback callback,
                boolean resetCounter,
                boolean register)

A monotonically increasing 64 bit integer value. Do not make this constructor public, it is used for creating unregistered counters.

Parameters:

name - The name of this counter, for use in logging.

manager - the statistics manager acquired by injection

fetchParametersFromConfig - Whether or not this counter should be initialized from config.

callback - will be invoked each time this counter is written to the log

resetCounter - Control for if this Counter should be reset between each logging interval.

register - Whether to register the counter in the statistics manager

Method Detail

intializeUnregisteredCounter

static Counter intializeUnregisteredCounter(String name,
                                            boolean resetCounter)

Get a Counter instance not registered in the statistics manager. This is used by CounterGroup and should not be made public.

Parameters:

name - The name of this counter, for use in logging.

resetCounter - Control for if this Counter should be reset between each logging interval.

getResetCounter

private static boolean getResetCounter(String name,
                                       com.yahoo.container.StatisticsConfig config)

If this Counter is set up to read config, configure it according to the config given.

increment

public void increment()

Increment by 1.

increment

public void increment(long n)

Increment by n.

get

public long get()

Returns:

current value of this counter

getResetCounter

public boolean getResetCounter()

The reset counter is true if this is counter is reset to 0 between each logging interval.

Returns:

whether this counter is reset between each logging interval.

reset

public void reset()

If this counter should be set to 0 between each logging interval, do that.

runHandle

public void runHandle()

Log current state and reset.

Specified by:

runHandle in class Handle

toString

public String toString()

Overrides:

toString in class Object

getProxyAndReset

CounterProxy getProxyAndReset()

equals

public boolean equals(Object o)

Specified by:

equals in class Handle

hashCode

public int hashCode()

Specified by:

hashCode in class Handle