de.ipcon.tools.progress

Class CounterWatchdog

java.lang.Object

de.ipcon.tools.progress.CounterWatchdog

public class CounterWatchdog
extends java.lang.Object

This class is intended for monitoring if something happened too often. Events can be counted with the increment method and if the counter exceeds a configured limit, warnings are logged to a given Logger.

Constructor Summary

Constructors

Constructor and Description
CounterWatchdog(java.lang.String _name, long _maxCount, org.apache.log4j.Logger _log)
CounterWatchdog(java.lang.String _name, long _maxCount, org.apache.log4j.Logger _log, long _minDelayBetweenLoggingInMs)
CounterWatchdog(java.lang.String _name, long _maxCount, org.apache.log4j.Logger _log, long _minDelayBetweenLoggingInMs, boolean _autoReset)

Method Summary

Modifier and Type	Method and Description
long	getCount()
long	getMaxCount()
long	getMinDelayBetweenLoggingInMs()
java.lang.String	getName()
long	increment() Increments the counter by one.
void	reset() Resets the counter watchdog to its initial state.
void	setCount(long $4)
void	setMaxCount(long $2)
void	setMinDelayBetweenLoggingInMs(long $3)
void	setName(java.lang.String $1)

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterWatchdog

public CounterWatchdog(java.lang.String _name,
                       long _maxCount,
                       org.apache.log4j.Logger _log)

Parameters:

_name - a name that will be output in the log messages to identify this counter watchdog

_maxCount - maximum number of increments allowed before warnings are logged

_log - the Logger to output warnings to

_minDelayBetweenLoggingInMs - the minimum number of milliseconds that must pass before another warning is issued; defaults to 10.000 (10 seconds)

_autoReset - if true the counter (not the whole watchdog!) will automatically be reset after the first warning has been issued; if false (the default) the counter will be kept and continue to increment.

CounterWatchdog

public CounterWatchdog(java.lang.String _name,
                       long _maxCount,
                       org.apache.log4j.Logger _log,
                       long _minDelayBetweenLoggingInMs)

CounterWatchdog

public CounterWatchdog(java.lang.String _name,
                       long _maxCount,
                       org.apache.log4j.Logger _log,
                       long _minDelayBetweenLoggingInMs,
                       boolean _autoReset)

Method Detail

increment

public long increment()

Increments the counter by one. If it exceeds the configured maximum limit and no warning has been logged until now or the last warning was in the past long enough, logs a warning message.

Returns:

the new count

reset

public void reset()

Resets the counter watchdog to its initial state.

getName

public java.lang.String getName()

setName

public void setName(java.lang.String $1)

getMaxCount

public long getMaxCount()

setMaxCount

public void setMaxCount(long $2)

getMinDelayBetweenLoggingInMs

public long getMinDelayBetweenLoggingInMs()

setMinDelayBetweenLoggingInMs

public void setMinDelayBetweenLoggingInMs(long $3)

getCount

public long getCount()

setCount

public void setCount(long $4)