org.javasimon.callback.lastsplits

Class LastSplitsCallback

java.lang.Object

org.javasimon.callback.CallbackSkeleton

org.javasimon.callback.lastsplits.LastSplitsCallback

All Implemented Interfaces:

Callback

public class LastSplitsCallback
extends CallbackSkeleton

Callback retaining the last N stopwatch splits. Splits can be logged when buffer revolves.

Since:

3.2

Author:

gquintana

See Also:

LastSplits

Nested Class Summary

Nested classes/interfaces inherited from interface org.javasimon.callback.Callback

Callback.Event

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_NAME_LAST_SPLITS Simon attribute name of the LastSplit object stored in Simons.

Constructor Summary

Constructors

Constructor and Description
LastSplitsCallback() Default constructor with a buffer capacity of 10.
LastSplitsCallback(int capacity) Constructor with buffer capacity.

Method Summary

Modifier and Type	Method and Description
protected LogTemplate<Split>	createLogTemplate(Stopwatch stopwatch) Create log template for given stopwatch.
boolean	isLogEnabled()
void	onSimonCreated(Simon simon) When Stopwatch is created, a Last Splits attributes is added.
void	onStopwatchAdd(Stopwatch stopwatch, Split split, StopwatchSample sample) Stopwatch add split event.
void	onStopwatchStop(Split split, StopwatchSample sample) When a Splits is stopped, it is added to the stopwatch a Last Splits attribute.
void	setLogEnabled(boolean logEnabled)

Methods inherited from class org.javasimon.callback.CallbackSkeleton

cleanup, initialize, onCounterDecrease, onCounterIncrease, onCounterSet, onManagerClear, onManagerMessage, onManagerWarning, onSimonDestroyed, onStopwatchStart

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_LAST_SPLITS

public static final String ATTR_NAME_LAST_SPLITS

Simon attribute name of the LastSplit object stored in Simons.

See Also:

Constant Field Values

Constructor Detail

LastSplitsCallback

public LastSplitsCallback()

Default constructor with a buffer capacity of 10.

LastSplitsCallback

public LastSplitsCallback(int capacity)

Constructor with buffer capacity.

Parameters:

capacity - buffer capacity

Method Detail

onSimonCreated

public void onSimonCreated(Simon simon)

When Stopwatch is created, a Last Splits attributes is added.

Specified by:

onSimonCreated in interface Callback

Overrides:

onSimonCreated in class CallbackSkeleton

Parameters:

simon - created Simon

onStopwatchStop

public void onStopwatchStop(Split split,
                            StopwatchSample sample)

When a Splits is stopped, it is added to the stopwatch a Last Splits attribute.

Specified by:

onStopwatchStop in interface Callback

Overrides:

onStopwatchStop in class CallbackSkeleton

Parameters:

split - stopped Split

sample - stopwatch sampled after the stop

onStopwatchAdd

public void onStopwatchAdd(Stopwatch stopwatch,
                           Split split,
                           StopwatchSample sample)

Description copied from interface: Callback

Stopwatch add split event. StopwatchSample valid for the moment after the add is provided because the callback is executed out of synchronized block. It is guaranteed that Split.getStopwatch() will not return null.

Specified by:

onStopwatchAdd in interface Callback

Overrides:

onStopwatchAdd in class CallbackSkeleton

Parameters:

stopwatch - modified Stopwatch

split - added split object

sample - stopwatch sampled after the add

isLogEnabled

public boolean isLogEnabled()

setLogEnabled

public void setLogEnabled(boolean logEnabled)

createLogTemplate

protected LogTemplate<Split> createLogTemplate(Stopwatch stopwatch)

Create log template for given stopwatch. This method can be overridden to tune logging strategy. By default, when isLogEnabled() is set, last splits are logged at each buffer revolution.

Parameters:

stopwatch - Stopwatch

Returns:

Log template