de.larssh.utils.time

Class Stopwatch

java.lang.Object

de.larssh.utils.time.Stopwatch

Direct Known Subclasses:

CloseableStopwatch

public class Stopwatch
extends Object

Implementation of a synchronized stopwatch starting at Instant.now(). sinceStart() can be used to retrieve the duration since the stopwatch started.

checkpoint(String) adds a new checkpoint. It might be used for split or lap times. sinceLast() can be used to retrieve the duration since the last checkpoint was created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stopwatch.Checkpoint Implementation of a stopwatches checkpoint.

Constructor Summary

Constructors

Constructor and Description
Stopwatch()

Method Summary

Modifier and Type	Method and Description
Stopwatch.Checkpoint	checkpoint(String name) Adds a new checkpoint referenced by name.
List<Stopwatch.Checkpoint>	getCheckpoints() List of checkpoints
Optional<Stopwatch.Checkpoint>	getLastCheckpoint() The last created Stopwatch.Checkpoint or empty if no checkpoint was created
Instant	getLastInstant() Instant of the last created Stopwatch.Checkpoint or the stopwatches starting time if no checkpoint was created
Instant	getStartInstant() Instant at the stopwatches start
Duration	sinceLast() Duration since the last created Stopwatch.Checkpoint or the stopwatches starting time if no checkpoint was created
Duration	sinceStart() Duration since the stopwatches start
Stream<Stopwatch.Checkpoint>	stream() Sequential Stream with the checkpoints as its source
String	toString()
boolean	waitFor(Duration duration, Duration timeoutSinceStart) Waits for duration using Thread#sleep(long).
boolean	waitFor(Duration duration, Duration timeoutSinceStart, Consumer<Duration> wait) Waits for duration using wait.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stopwatch

public Stopwatch()

Method Detail

checkpoint

public Stopwatch.Checkpoint checkpoint(String name)

Adds a new checkpoint referenced by name.

name does not need to be unique. Multiple checkpoints with the same name might exist.

Parameters:

name - name to reference the checkpoint

Returns:

the new checkpoint

getCheckpoints

public List<Stopwatch.Checkpoint> getCheckpoints()

List of checkpoints

Returns:

the list of checkpoints

getLastCheckpoint

public Optional<Stopwatch.Checkpoint> getLastCheckpoint()

The last created Stopwatch.Checkpoint or empty if no checkpoint was created

Returns:

the last created checkpoint

getLastInstant

public Instant getLastInstant()

Instant of the last created Stopwatch.Checkpoint or the stopwatches starting time if no checkpoint was created

Returns:

the last created instant or the stopwatches starting time

sinceLast

public Duration sinceLast()

Duration since the last created Stopwatch.Checkpoint or the stopwatches starting time if no checkpoint was created

Returns:

the duration since last checkpoints instant or the stopwatches starting time

sinceStart

public Duration sinceStart()

Duration since the stopwatches start

Returns:

the duration since the stopwatches start

waitFor

public boolean waitFor(Duration duration,
                       Duration timeoutSinceStart)
                throws InterruptedException

Waits for duration using Thread#sleep(long). If reached, it times out at timeoutSinceStart after the Stopwatch start.

Parameters:

duration - duration to wait

timeoutSinceStart - timeout duration since the Stopwatch start

Returns:

true if the timeout was not reached and false if the timeout has been reached

Throws:

InterruptedException - if any thread has interrupted the current thread

waitFor

public boolean waitFor(Duration duration,
                       Duration timeoutSinceStart,
                       Consumer<Duration> wait)

Waits for duration using wait. If reached, it times out at timeoutSinceStart after the Stopwatch start.

Note: The Duration given to wait might be less than duration to handle timeoutSinceStart more precisely.

Parameters:

duration - duration to wait

timeoutSinceStart - timeout duration since the Stopwatch start

wait - method to use for waiting

Returns:

true if the timeout was not reached and false if the timeout has been reached

stream

public Stream<Stopwatch.Checkpoint> stream()

Sequential Stream with the checkpoints as its source

Returns:

a sequential Stream over the checkpoints

getStartInstant

public Instant getStartInstant()

Instant at the stopwatches start

Returns:

the instant at the stopwatches start time

toString

@NonNull
public String toString()

Overrides:

toString in class Object