org.openbase.jul.schedule

Class Stopwatch

java.lang.Object

org.openbase.jul.schedule.Stopwatch

public class Stopwatch
extends Object

Author:

Divine Threepwood This class implements a general purpose stopwatch. This implementation should be thread safe.

Constructor Summary

Constructors

Constructor and Description
Stopwatch() Constructor initializes a new Stopwatch.

Method Summary

Modifier and Type	Method and Description
long	getEndTime() Method returns the timestamp of the last Stopwatch stop.
long	getStartTime() Method returns the timestamp of the Stopwatch start.
long	getTime() This method returns the time interval between the start- and end timestamps.
boolean	isRunning() Method checks if the Stopwatch was started after reset.
void	reset() This method resets the Stopwatch by clearing the internally stored start and end timestamps.
void	restart() This method restarts the Stopwatch.
void	start() This method starts the Stopwatch by setting the start timestamp.
long	stop() This method stops the Stopwatch and returns the time result.
void	waitForStart() Method blocks until the Stopwatch start.
void	waitForStart(long timeout) Method blocks until the Stopwatch start or the given timeout expired.
void	waitForStop() Method blocks until the Stopwatch stop.
void	waitForStop(long timeout) Method blocks until the Stopwatch stop or the given timeout expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stopwatch

public Stopwatch()

Constructor initializes a new Stopwatch.

Method Detail

reset

public final void reset()

This method resets the Stopwatch by clearing the internally stored start and end timestamps.

start

public void start()

This method starts the Stopwatch by setting the start timestamp.

restart

public void restart()

This method restarts the Stopwatch. Internally the reset() and start() methods are called.

getTime

public long getTime()
             throws NotAvailableException

This method returns the time interval between the start- and end timestamps. In case the the Stopwatch is still running, the elapsed time since Stopwatch start will be returned.

Returns:

the time interval in milliseconds.

Throws:

NotAvailableException - This exception will thrown in case the timer was never started.

isRunning

public boolean isRunning()

Method checks if the Stopwatch was started after reset. Even after calling the stop method the Stopwatch is still running until reset() is called.

Returns:

true if the Stopwatch was started.

stop

public long stop()
          throws CouldNotPerformException

This method stops the Stopwatch and returns the time result. The internal timestamps are not cleared by this method so the result can still queried by the getTime() method afterwards. Additionally this method can be called multiply times but only the last stop timestamp will be stored and handled by the getTime() method.

Returns:

the elapsed time interval since start.

Throws:

CouldNotPerformException - is thrown in case the Stopwatch was never started.

getStartTime

public long getStartTime()
                  throws NotAvailableException

Method returns the timestamp of the Stopwatch start.

Returns:

the timestamp in milliseconds.

Throws:

NotAvailableException - is thrown in case the Stopwatch was never started.

getEndTime

public long getEndTime()
                throws NotAvailableException

Method returns the timestamp of the last Stopwatch stop.

Returns:

the timestamp in milliseconds.

Throws:

NotAvailableException - is thrown in case the Stopwatch was never started.

waitForStart

public void waitForStart(long timeout)
                  throws InterruptedException

Method blocks until the Stopwatch start or the given timeout expired.

Parameters:

timeout - max time to wait.

Throws:

InterruptedException - is thrown in case the current thread was externally interrupted.

waitForStart

public void waitForStart()
                  throws InterruptedException

Method blocks until the Stopwatch start.

Throws:

InterruptedException - is thrown in case the current thread was externally interrupted.

waitForStop

public void waitForStop(long timeout)
                 throws InterruptedException

Method blocks until the Stopwatch stop or the given timeout expired.

Parameters:

timeout - max time to wait.

Throws:

InterruptedException - is thrown in case the current thread was externally interrupted.

waitForStop

public void waitForStop()
                 throws InterruptedException

Method blocks until the Stopwatch stop.

Throws:

InterruptedException - is thrown in case the current thread was externally interrupted.