com.google.code.tempusfugit.temporal

Class ThreadLocalTimer

java.lang.Object

com.google.code.tempusfugit.temporal.ThreadLocalTimer

All Implemented Interfaces:

StopWatch

@ThreadSafe
public class ThreadLocalTimer
extends Object
implements StopWatch

The ThreadLocal based stop watch is safe to use with multiple threads as it will time each thread's call between reset() (or construction) and lap(). It is intended to use one shared Clock. For example, RealClock but you could use a clock based on ThreadLocal if you need to provide different clocks per thread (although, outside of a testing context, I'm not sure why you'd want to).

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
ThreadLocalTimer(Clock clock)

Method Summary

Modifier and Type	Method and Description
Duration	elapsedTime()
void	lap() mark a lap, this method can be invoked multiple times but should be called before making a call to the StopWatch.elapsedTime() method.
void	reset() start or reset the stop watch starting position.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalTimer

public ThreadLocalTimer(Clock clock)

Method Detail

reset

public void reset()

Description copied from interface: StopWatch

start or reset the stop watch starting position. This should be called before called StopWatch.lap().

Specified by:

reset in interface StopWatch

lap

public void lap()

Description copied from interface: StopWatch

mark a lap, this method can be invoked multiple times but should be called before making a call to the StopWatch.elapsedTime() method.

Specified by:

lap in interface StopWatch

elapsedTime

public Duration elapsedTime()

Specified by:

elapsedTime in interface StopWatch

Returns:

the difference between construction (or reset time) and lap time.