StopWatch (ph-commons 9.3.3 API)

java.lang.Object
- com.helger.commons.timing.StopWatch

All Implemented Interfaces:

IStoppable, Serializable
```
@NotThreadSafe
public class StopWatch
extends Object
implements IStoppable, Serializable
```
Simple stop watch based on System.nanoTime().

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected StopWatch(boolean bStart)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`StopWatch(boolean bStart)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StopWatch`	`createdStarted()`
`static StopWatch`	`createdStopped()`
`protected long`	`getCurrentNanoTime()`
`Duration`	`getDuration()`
`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.
`static TimeValue`	`runMeasured(Runnable aRunnable)` Run the passed runnable and measure the time.
`EChange`	`start()` Start the stop watch.
`EChange`	`stop()` Stop the stop watch.
`Duration`	`stopAndGetDuration()` Stop the stop watch and get the duration since the start.
`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

- Constructor Detail
  - StopWatch
```
protected 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.
  - getCurrentNanoTime
```
protected final long getCurrentNanoTime()
```
    Returns:
    
    The current time in nano seconds.
  - start
```
@Nonnull
public final 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
```
@Nonnegative
public long getNanos()
```
    Returns:
    
    The elapsed nano seconds (1000 nano seconds = 1 milli second).
  - getMillis
```
@Nonnegative
public long getMillis()
```
    Returns:
    
    The elapsed milli seconds.
  - getSeconds
```
@Nonnegative
public long getSeconds()
```
    Returns:
    
    The elapsed seconds.
  - getDuration
```
@Nonnull
public Duration getDuration()
```
    Returns:
    
    The elapsed duration. Never null.
  - stopAndGetNanos
```
@Nonnegative
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
```
@Nonnegative
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
```
@Nonnegative
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.
  - stopAndGetDuration
```
@Nonnull
public Duration stopAndGetDuration()
```
    Stop the stop watch and get the duration since the start. If the stop watch was started and stopped multiple times, the duration is added.
    
    Returns:
    
    The elapsed duration or 0 if the stop watch was never started.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createdStarted
```
@Nonnull
 @ReturnsMutableCopy
public static StopWatch createdStarted()
```
    Returns:
    
    A new StopWatch object that is started. Never null.
  - createdStopped
```
@Nonnull
 @ReturnsMutableCopy
public static StopWatch createdStopped()
```
    Returns:
    
    A new StopWatch object that is NOT started. Never null.
  - runMeasured
```
@Nonnull
public static TimeValue runMeasured(@Nonnull
                                              Runnable aRunnable)
```
    Run the passed runnable and measure the time.
    
    Parameters:
    
    aRunnable - The runnable to be executed. May not be null.
    
    Returns:
    
    The elapsed time. Never null.

Class StopWatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StopWatch

Method Detail

reset

getCurrentNanoTime

start

stop

restart

isStarted

isStopped

getNanos

getMillis

getSeconds

getDuration

stopAndGetNanos

stopAndGetMillis

stopAndGetSeconds

stopAndGetDuration

toString

createdStarted

createdStopped

runMeasured