de.larssh.utils.time

Class CloseableStopwatch

java.lang.Object

de.larssh.utils.time.Stopwatch

de.larssh.utils.time.CloseableStopwatch

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

LoggingStopwatch

public abstract class CloseableStopwatch
extends Stopwatch
implements AutoCloseable

Abstract and synchronized implementation of a closeable Stopwatch. Once a CloseableStopwatch is closed no more checkpoints can be created and sinceStart() and sinceLast() return durations based on the stopwatches stopping time.

Extending class are meant to be used inside try-with-resource blocks.

close() can be called multiple times while all but the first call are ignored.

Nested Class Summary

Nested classes/interfaces inherited from class de.larssh.utils.time.Stopwatch

Stopwatch.Checkpoint

Constructor Summary

Constructors

Constructor and Description
CloseableStopwatch() Abstract and synchronized implementation of a closeable Stopwatch.

Method Summary

Modifier and Type	Method and Description
Stopwatch.Checkpoint	checkpoint(String name) Adds a new checkpoint referenced by name.
void	close()
Optional<Instant>	getStopInstant() Instant at the stopwatches stopping or empty if the stopwatch is not stopped, yet.
boolean	isStopped() Returns true if the stopwatch is stopped.
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
String	toString()

Methods inherited from class de.larssh.utils.time.Stopwatch

getCheckpoints, getLastCheckpoint, getLastInstant, getStartInstant, stream, waitFor, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseableStopwatch

public CloseableStopwatch()

Abstract and synchronized implementation of a closeable Stopwatch. Once a CloseableStopwatch is closed no more checkpoints can be created and sinceStart() and sinceLast() return durations based on the stopwatches stopping time.

Extending class are meant to be used inside try-with-resource blocks.

close() can be called multiple times while all but the first call are ignored.

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.

Overrides:

checkpoint in class Stopwatch

Parameters:

name - name to reference the checkpoint

Returns:

the new checkpoint

Throws:

CompletedException - Once the CloseableStopwatch is closed no more checkpoints can be added.

close

public void close()

Specified by:

close in interface AutoCloseable

isStopped

public boolean isStopped()

Returns true if the stopwatch is stopped.

Returns:

true if the stopwatch is stopped

sinceLast

public Duration sinceLast()

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

Overrides:

sinceLast in class Stopwatch

Returns:

the duration since last checkpoints instant or the stopwatches starting time

sinceStart

public Duration sinceStart()

Duration since the stopwatches start

Overrides:

sinceStart in class Stopwatch

Returns:

the duration since the stopwatches start

getStopInstant

public Optional<Instant> getStopInstant()

Instant at the stopwatches stopping or empty if the stopwatch is not stopped, yet.

Returns:

the instant at the stopwatches stopping or empty

toString

@NonNull
public String toString()

Overrides:

toString in class Stopwatch