org.javasimon.callback.logging

Class PeriodicLogTemplate<C>

java.lang.Object

org.javasimon.callback.logging.LogTemplate<C>

org.javasimon.callback.logging.DelegateLogTemplate<C>

org.javasimon.callback.logging.PeriodicLogTemplate<C>

public class PeriodicLogTemplate<C>
extends DelegateLogTemplate<C>

Log template that logs something after every N milliseconds. The isEnabled(Object) is only true after N milliseconds from the last log.

Author:

gquintana

Constructor Summary

Constructors

Constructor and Description
PeriodicLogTemplate(LogTemplate<C> delegate, long period) Constructor with other template and the required period in ms.
PeriodicLogTemplate(LogTemplate<C> delegate, long period, SimonClock clock)

Method Summary

Methods

Modifier and Type	Method and Description
long	getNextTime() Get next invocation time time.
protected boolean	isEnabled(C context) Tells whether logging is enabled.
boolean	isNextTimePassed() Indicates whether next timestamp is in past.
protected void	log(String message) Logs a message.

Methods inherited from class org.javasimon.callback.logging.DelegateLogTemplate

getDelegate

Methods inherited from class org.javasimon.callback.logging.LogTemplate

log

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodicLogTemplate

public PeriodicLogTemplate(LogTemplate<C> delegate,
                   long period)

Constructor with other template and the required period in ms.

Parameters:

delegate - concrete log template

period - logging period in milliseconds

PeriodicLogTemplate

public PeriodicLogTemplate(LogTemplate<C> delegate,
                   long period,
                   SimonClock clock)

Method Detail

getNextTime

public long getNextTime()

Get next invocation time time.

Returns:

next time

isNextTimePassed

public boolean isNextTimePassed()

Indicates whether next timestamp is in past.

isEnabled

protected boolean isEnabled(C context)

Tells whether logging is enabled.

Overrides:

isEnabled in class DelegateLogTemplate<C>

Returns:

true if delegate is true and enough time passed since last log

log

protected void log(String message)

Logs a message.

Next time is updated after delegate log is called.

Overrides:

log in class DelegateLogTemplate<C>