org.hsqldb.lib
Class StopWatch

java.lang.Object
  org.hsqldb.lib.StopWatch

public class StopWatch

extends Object

Provides the programatic analog of a physical stop watch.

The watch can be started, stopped and zeroed and can be queried for elapsed running time. The watch accumulates elapsed time over starts and stops such that only the time actually spent running is recorded. If the watch is zeroed, then the accumulated time is discarded and the watch starts again with zero acumulated time.

Since:

1.7.2

Version:

1.7.2

Author:

boucherb@users.sourceforge.net

Constructor Summary

StopWatch()
Creates, zeros, and starts a new StopWatch

StopWatch(boolean start)
Creates, zeros, and starts a new StopWatch

Method Summary

long	currentElapsedTime() Retrieves the accumulated time this object has spent running since it was last started.
String	currentElapsedTimeToMessage(String prefix) Retrieves prefix + " in " + elapsedTime() + " ms."
long	elapsedTime() Retrieves the accumulated time this object has spent running since it was last zeroed.
String	elapsedTimeToMessage(String prefix) Retrieves prefix + " in " + elapsedTime() + " ms."
void	mark()
void	start() Ensures that this object is in the running state.
void	stop() Ensures that this object is in the stopped state.
String	toString() Retrieves the internal state of this object, as a String.
void	zero() Zeros accumulated running time and restarts this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StopWatch

public StopWatch()

Creates, zeros, and starts a new StopWatch

StopWatch

public StopWatch(boolean start)

Creates, zeros, and starts a new StopWatch

Method Detail

elapsedTime

public long elapsedTime()

Retrieves the accumulated time this object has spent running since it was last zeroed.

Returns:

the accumulated time this object has spent running since it was last zeroed.

currentElapsedTime

public long currentElapsedTime()

Retrieves the accumulated time this object has spent running since it was last started.

Returns:

the accumulated time this object has spent running since it was last started.

zero

public void zero()

Zeros accumulated running time and restarts this object.

start

public void start()

Ensures that this object is in the running state. If this object is not running, then the call has the effect of setting the startTime attribute to the current value of System.currentTimeMillis() and setting the running attribute to true.

stop

public void stop()

Ensures that this object is in the stopped state. If this object is in the running state, then this has the effect of adding to the total attribute the elapsed time since the last transition from stopped to running state and sets the running attribute to false. If this object is not in the running state, this call has no effect.

mark

public void mark()

elapsedTimeToMessage

public String elapsedTimeToMessage(String prefix)

Retrieves prefix + " in " + elapsedTime() + " ms."

Parameters:

prefix - The string to use as a prefix

Returns:

prefix + " in " + elapsedTime() + " ms."

currentElapsedTimeToMessage

public String currentElapsedTimeToMessage(String prefix)

Retrieves prefix + " in " + elapsedTime() + " ms."

Parameters:

prefix - The string to use as a prefix

Returns:

prefix + " in " + elapsedTime() + " ms."

toString

public String toString()

Retrieves the internal state of this object, as a String. The retreived value is:

    super.toString() +
    "[running=" +
    running +
    ", startTime=" +
    startTime +
    ", total=" +
    total + "]";
 

Returns:

the state of this object, as a String