tools.gsf.time

Interface Stopwatch

All Known Implementing Classes:

LoggerStopwatch, NoopStopwatch

public interface Stopwatch

Stateful stopwatch object used for measuring elapsed time. Can be used to record cumulative time as well as split times. Very lightweight. After creation, start() must be called to start the stopwatch. split() records the time since the last split() call (or start() call if split() has not yet been called). elapsed() records the total time elapsed since the timer was started. Elapsed() does not reset the stopwatch or save the latest split. The stopwatch can be restarted by calling start().

Since:

2016-07-17

Author:

Tony Field

Method Summary

Modifier and Type	Method and Description
void	elapsed(String message) Record the elapsed time since the stopwatch was started/restarted.
void	elapsed(String message, Object... arguments) Record the elapsed time since the stopwatch was started/restarted.
void	split(String message) Record time elapsed since the last interval measurement or since started/restarted.
void	split(String message, Object... arguments) Record time elapsed since the last interval measurement or since started/restarted.
void	start() Starts the stopwatch.

Method Detail

start

void start()

Starts the stopwatch. Must be called before taking a split or elapsed time.

split

void split(String message)

Record time elapsed since the last interval measurement or since started/restarted. Resets the interval timer.

Parameters:

message - message to record (typically a description of the functionality measured, like a component name.)

split

void split(String message,
           Object... arguments)

Record time elapsed since the last interval measurement or since started/restarted. Resets the interval timer.

Parameters:

message - message to record (typically a description of the functionality measured, like a component name.)

arguments - arguments to be substituted into the message. Parameterization operates as in slf4j: http://www.slf4j.org/faq.html#logging_performance

elapsed

void elapsed(String message)

Record the elapsed time since the stopwatch was started/restarted. Does not reset either the interval timer or the cumulative timer.

Parameters:

message - message to record (typically a description of the functionality measured, like a component name.)

elapsed

void elapsed(String message,
             Object... arguments)

Record the elapsed time since the stopwatch was started/restarted. Does not reset either the interval timer or the cumulative timer.

Parameters:

message - message to record (typically a description of the functionality measured, like a component name.)

arguments - arguments to be substituted into the message. Parameterization operates as in slf4j: http://www.slf4j.org/faq.html#logging_performance