com.phloc.commons.timing

Class StopWatch

java.lang.Object

com.phloc.commons.timing.StopWatch

All Implemented Interfaces:

IStoppable, Serializable

@NotThreadSafe
public final class StopWatch
extends Object
implements IStoppable, Serializable

Simple stop watch based on System.nanoTime().

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_START By default the stop watch is not started automatically

Constructor Summary

Constructors

Constructor and Description
StopWatch() Create a new stop watch that is not yet started.
StopWatch(boolean bStart) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
long	getMillis()
long	getNanos()
long	getSeconds()
boolean	isStarted()
boolean	isStopped()
EChange	reset() Reset all saved durations, in case this stop watch is to be used in a loop.
void	restart() Stops, resets and starts the stop watch.
EChange	start() Start the stop watch.
EChange	stop() Stop the stop watch.
long	stopAndGetMillis() Stop the stop watch and get the elapsed milliseconds since the start.
long	stopAndGetNanos() Stop the stop watch and get the elapsed nanoseconds since the start.
long	stopAndGetSeconds() Stop the stop watch and get the elapsed seconds since the start.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_START

public static final boolean DEFAULT_START

By default the stop watch is not started automatically

See Also:

Constant Field Values

Constructor Detail

StopWatch

public StopWatch()

Create a new stop watch that is not yet started.

StopWatch

public StopWatch(boolean bStart)

Constructor.

Parameters:

bStart - if true the stop watch is directly started!

Method Detail

reset

@Nonnull
public EChange reset()

Reset all saved durations, in case this stop watch is to be used in a loop. Does not change the start/stop state.

Returns:

EChange.

start

@Nonnull
public EChange start()

Start the stop watch.

Returns:

EChange.

stop

@Nonnull
public EChange stop()

Stop the stop watch.

Specified by:

stop in interface IStoppable

Returns:

EChange.CHANGED if the stop watch was previously running and is now stopped, and EChange.UNCHANGED if the stop watch was already stopped.

restart

public void restart()

Stops, resets and starts the stop watch.

See Also:

stop(), reset(), start()

isStarted

public boolean isStarted()

Returns:

true if the stop watch is currently started (running), false otherwise.

isStopped

public boolean isStopped()

Returns:

true if the stop watch is currently stopped (not running), false otherwise.

getNanos

public long getNanos()

Returns:

The elapsed nano seconds (1000 nano seconds = 1 milli second).

getMillis

public long getMillis()

Returns:

The elapsed milli seconds.

getSeconds

public long getSeconds()

Returns:

The elapsed seconds.

stopAndGetNanos

public long stopAndGetNanos()

Stop the stop watch and get the elapsed nanoseconds since the start. If the stop watch was started and stopped multiple times, the duration is added.

Returns:

The elapsed nano seconds or 0 if the stop watch was never started.

stopAndGetMillis

public long stopAndGetMillis()

Stop the stop watch and get the elapsed milliseconds since the start. If the stop watch was started and stopped multiple times, the duration is added.

Returns:

The elapsed milli seconds or 0 if the stop watch was never started.

stopAndGetSeconds

public long stopAndGetSeconds()

Stop the stop watch and get the elapsed seconds since the start. If the stop watch was started and stopped multiple times, the duration is added.

Returns:

The elapsed seconds or 0 if the stop watch was never started.

toString

public String toString()

Overrides:

toString in class Object