cz.ues.platform.commons.utils

Class StopWatch

java.lang.Object

cz.ues.platform.commons.utils.StopWatch

Direct Known Subclasses:

StopWatch.SimpleStopWatch

public class StopWatch
extends java.lang.Object

Allows to measure time spent in a business logic.

Since:

UES8-07

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StopWatch.SimpleStopWatch This implementation do nothing (it is introduced because performance reason).

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	CREATE_STOPWATCH Determines whether to use a simple stop watch which do nothing (for performance reasons).
private static UESLogger	logger Logger instance.
private static StopWatch	SIMPLE_STOPWATCH StopWatch instance which contains no business logic.
private long	start Start time.
private long	totalDuration Total measured time.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StopWatch() Creates a new instance of StopWatch.

Method Summary

Methods

Modifier and Type	Method and Description
void	nextStart() Starts a new time measuring.
static long	now() Returns current time.
void	setStartTime(long time) Time setter.
static StopWatch	start() Creates an instance of this class and sets the start time.
long	stop() Returns time difference between invocation StopWatch.stop() and StopWatch.start() method.
void	stop(java.lang.String businessLogicName) Determines current time, calculates the difference between calling this method and StopWatch.start() method and the result will be written to the log (at info level).
void	stop(UESLogger customLogger, java.lang.String businessLogicName) Determines current time, calculates the difference between calling this method and StopWatch.start() method and the result will be written to the log (at info level).

Methods inherited from class java.lang.Object

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

Field Detail

totalDuration

private totalDuration

Total measured time.

SIMPLE_STOPWATCH

private static final SIMPLE_STOPWATCH

StopWatch instance which contains no business logic.

logger

private static logger

Logger instance.

start

private start

Start time.

CREATE_STOPWATCH

private static final CREATE_STOPWATCH

Determines whether to use a simple stop watch which do nothing (for performance reasons).

Constructor Detail

StopWatch

private StopWatch()

Creates a new instance of StopWatch.

Since:

UES8-07

Method Detail

start

public static StopWatch start()

Creates an instance of this class and sets the start time.

Returns:

StopWatch instance.

Since:

UES8-07

nextStart

public void nextStart()

Starts a new time measuring.

Since:

UES8-07

stop

public long stop()

Returns time difference between invocation StopWatch.stop() and StopWatch.start() method.

Returns:

Time difference in nanoseconds.

Since:

UES8-07

stop

public void stop(java.lang.String businessLogicName)

Determines current time, calculates the difference between calling this method and StopWatch.start() method and the result will be written to the log (at info level).

Logged message: Time spent in {0} is {1} ns. [Total measured time: {2} ns.]

Parameters:

businessLogicName - Identifies measured business logic in the log file.

Since:

UES8-07

stop

public void stop(UESLogger customLogger,
java.lang.String businessLogicName)

Determines current time, calculates the difference between calling this method and StopWatch.start() method and the result will be written to the log (at info level).

Logged message: Time spent in {0} is {1} ns. [Total measured time: {2} ns.]

Parameters:

customLogger - Logger used for tracing message.

businessLogicName - Identifies measured business logic in the log file.

Since:

UES8-07

setStartTime

public void setStartTime(long time)

Time setter.

Parameters:

time - Time.

Since:

UES8-07

now

public static long now()

Returns current time.

Returns:

current time.

Since:

UES8-07