Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	StopWatch.Split Stores a split as a label and duration.
private static enum	StopWatch.SplitState Enumeration type which indicates the split status of a StopWatch.
private static enum	StopWatch.State Enumeration type which indicates the status of a StopWatch.

Field Summary

Modifier and Type	Field and Description
private final String	message A message for string presentation.
private static final long	NANO_2_MILLIS
private StopWatch.State	runningState The current running state of this StopWatch.
private final List<StopWatch.Split>	splits The split list.
private StopWatch.SplitState	splitState Whether this StopWatch has a split time recorded.
private Instant	startInstant The start Instant.
private long	startTimeNanos The start time in nanoseconds.
private Instant	stopInstant The end Instant.
private long	stopTimeNanos The stop time in nanoseconds.

Constructor Summary

Access	Constructor and Description
public	StopWatch() Constructs a new instance.
public	StopWatch(final String A message for string presentation. message) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
public static StopWatch	Returns: StopWatch a StopWatch. create() Creates a StopWatch.
public static StopWatch	Returns: StopWatch a started StopWatch. createStarted() Creates and starts a StopWatch.
public String	Returns: the split time formatted by `DurationFormatUtils#formatDurationHMS`. formatSplitTime() Formats the split time with `DurationFormatUtils#formatDurationHMS`.
public String	Returns: the time formatted by `DurationFormatUtils#formatDurationHMS`. formatTime() Formats the time formatted with `DurationFormatUtils#formatDurationHMS`.
public < the type of results supplied by this supplier. T> T	Returns: a result from the given Supplier. get(final Supplier<T> The supplier to `Supplier#get()`. supplier) Delegates to `Supplier#get()` while recording the duration of the call.
public Duration	Returns: the Duration. getDuration() Gets the Duration on this StopWatch.
public String	Returns: the message for string presentation. getMessage() Gets the message for string presentation.
public long	Returns: the elapsed time in nanoseconds. getNanoTime() Gets the elapsed time in nanoseconds.
public Duration	Returns: the split Duration. getSplitDuration() Gets the split Duration on this StopWatch.
public long	Returns: the split time in nanoseconds. getSplitNanoTime() Gets the split time in nanoseconds.
public List<StopWatch.Split>	Returns: the list of splits. getSplits() Gets the split list.
public long	Returns: the split time in milliseconds. getSplitTime() Deprecated Use `getSplitDuration()`. Gets the split time on this StopWatch.
public Instant	Returns: the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC. getStartInstant() Gets the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC.
public long	Returns: the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC. getStartTime() Deprecated Use `getStartInstant()`. Gets the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC.
public Instant	Returns: the Instant this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC. getStopInstant() Gets the Instant this StopWatch was stopped, between the current time and midnight, January 1, 1970 UTC.
public long	Returns: the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC. getStopTime() Deprecated Use `getStopInstant()`. Gets the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.
public < the type of results supplied by this supplier. T, The kind of thrown exception or error. E extends Throwable> T	Returns: a result from the given Supplier. getT(final FailableSupplier<T, E> The supplier to `Supplier#get()`. supplier) Delegates to `FailableSupplier#get()` while recording the duration of the call.
public long	Returns: the time in milliseconds. getTime() Gets the time on this StopWatch.
public long	Returns: the time in the specified TimeUnit, rounded down. getTime(final TimeUnit the unit of time, not null. timeUnit) Gets the time in the specified TimeUnit.
public boolean	Returns: boolean If this StopWatch is started. isStarted() Tests whether this StopWatch is started.
public boolean	Returns: boolean If this StopWatch is stopped. isStopped() Tests whether StopWatch is stopped.
public boolean	Returns: boolean If this StopWatch is suspended. isSuspended() Tests whether this StopWatch is suspended.
private long	Returns: milliseconds conversion result. nanosToMillis(final long nanoseconds to convert. nanos) Converts nanoseconds to milliseconds.
public void	reset() Resets this StopWatch.
public void	resume() Resumes this StopWatch after a suspend.
public void	run(final Runnable The runnable to `Runnable#run()`. runnable) Delegates to `Runnable#run()` while recording the duration of the call.
public < The kind of `Throwable`. E extends Throwable> void	runT(final FailableRunnable<E> The runnable to `FailableRunnable#run()`. runnable) Delegates to `FailableRunnable#run()` while recording the duration of the call.
public void	split() Splits the time.
public void	split(final String A message for string presentation. label) Splits the time with a label.
public void	start() Starts this StopWatch.
private void	startResume() Starts or resumes this StopWatch.
public void	stop() Stops this StopWatch.
public void	suspend() Suspends this StopWatch for later resumption.
public String	Returns: the split time as a String. toSplitString() Gets a summary of the last split time that this StopWatch recorded as a string.
public String	Returns: the time as a String. toString() Overrides java.lang.Object.toString. Gets a summary of the time that this StopWatch recorded as a string.
public void	unsplit() Removes the split.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

message	back to summary
private final String message A message for string presentation. Since 3.10

message

back to summary

private final String message

A message for string presentation.

Since: 3.10

NANO_2_MILLIS	back to summary
private static final long NANO_2_MILLIS

runningState	back to summary
private StopWatch.State runningState The current running state of this StopWatch.

splits	back to summary
private final List<StopWatch.Split> splits The split list.

splitState	back to summary
private StopWatch.SplitState splitState Whether this StopWatch has a split time recorded.

startInstant	back to summary
private Instant startInstant The start Instant. nanoTime is only for elapsed time so we need to also store the currentTimeMillis to maintain the old getStartTime API. On Java 8, Instant has millisecond precision, later versions use nanoseconds.

startInstant

back to summary

private Instant startInstant

The start Instant.

nanoTime is only for elapsed time so we need to also store the currentTimeMillis to maintain the old getStartTime API.

On Java 8, Instant has millisecond precision, later versions use nanoseconds.

startTimeNanos	back to summary
private long startTimeNanos The start time in nanoseconds. This field can be removed once we move off of Java 8.

stopInstant	back to summary
private Instant stopInstant The end Instant. nanoTime is only for elapsed time so we need to also store the currentTimeMillis to maintain the old getStartTime API. On Java 8, Instant has millisecond precision, later versions use nanoseconds.

stopInstant

back to summary

private Instant stopInstant

The end Instant.

nanoTime is only for elapsed time so we need to also store the currentTimeMillis to maintain the old getStartTime API.

On Java 8, Instant has millisecond precision, later versions use nanoseconds.

stopTimeNanos	back to summary
private long stopTimeNanos The stop time in nanoseconds. This field can be removed once we move off of Java 8.

Constructor Detail

StopWatch	back to summary
public StopWatch() Constructs a new instance.

StopWatch	back to summary
public StopWatch(final String message) Constructs a new instance. Parameters message:String A message for string presentation. Since 3.10

StopWatch

back to summary

public StopWatch(final String message)

Constructs a new instance.

Parameters

message:String: A message for string presentation.

Since

3.10

Method Detail

create	back to summary
public static StopWatch create() Creates a StopWatch. Returns:StopWatch StopWatch a StopWatch. Since 3.10

create

back to summary

public static StopWatch create()

Creates a StopWatch.

Returns:StopWatch: StopWatch a StopWatch.
Since: 3.10

createStarted	back to summary
public static StopWatch createStarted() Creates and starts a StopWatch. Returns:StopWatch StopWatch a started StopWatch. Since 3.5

createStarted

back to summary

public static StopWatch createStarted()

Creates and starts a StopWatch.

Returns:StopWatch: StopWatch a started StopWatch.
Since: 3.5

formatSplitTime back to summary

formatSplitTime	back to summary
public String formatSplitTime() Formats the split time with `DurationFormatUtils#formatDurationHMS`. Returns:String the split time formatted by `DurationFormatUtils#formatDurationHMS`. Since 3.10

public String formatSplitTime()

Formats the split time with DurationFormatUtils#formatDurationHMS.

Returns:String: the split time formatted by DurationFormatUtils#formatDurationHMS.
Since: 3.10

formatTime back to summary

formatTime	back to summary
public String formatTime() Formats the time formatted with `DurationFormatUtils#formatDurationHMS`. Returns:String the time formatted by `DurationFormatUtils#formatDurationHMS`. Since 3.10

public String formatTime()

Formats the time formatted with DurationFormatUtils#formatDurationHMS.

Returns:String: the time formatted by DurationFormatUtils#formatDurationHMS.
Since: 3.10

get back to summary

get	back to summary
public <T> T get(final Supplier<T> supplier) Delegates to `Supplier#get()` while recording the duration of the call. Parameters <T> the type of results supplied by this supplier. supplier:Supplier<T> The supplier to `Supplier#get()`. Returns:T a result from the given Supplier. Since 3.18.0

public <T> T get(final Supplier<T> supplier)

Delegates to Supplier#get() while recording the duration of the call.

Parameters

<T>: the type of results supplied by this supplier.
supplier:Supplier<T>: The supplier to Supplier#get().

Returns:T

a result from the given Supplier.

Since

3.18.0

getDuration	back to summary
public Duration getDuration() Gets the Duration on this StopWatch. This is either the Duration between the start and the moment this method is called, or the Duration between start and stop. Returns:Duration the Duration. Since 3.16.0

getDuration

back to summary

public Duration getDuration()

Gets the Duration on this StopWatch.

This is either the Duration between the start and the moment this method is called, or the Duration between start and stop.

Returns:Duration: the Duration.
Since: 3.16.0

getMessage	back to summary
public String getMessage() Gets the message for string presentation. Returns:String the message for string presentation. Since 3.10

getMessage

back to summary

public String getMessage()

Gets the message for string presentation.

Returns:String: the message for string presentation.
Since: 3.10

getNanoTime back to summary

getNanoTime	back to summary
public long getNanoTime() Gets the elapsed time in nanoseconds. This is either the time between the start and the moment this method is called, or the amount of time between start and stop. Returns:long the elapsed time in nanoseconds. Since 3.0 See Also `System#nanoTime()`

public long getNanoTime()

Gets the elapsed time in nanoseconds.

This is either the time between the start and the moment this method is called, or the amount of time between start and stop.

Returns:long: the elapsed time in nanoseconds.
Since: 3.0
See Also: System#nanoTime()

getSplitDuration	back to summary
public Duration getSplitDuration() Gets the split Duration on this StopWatch. This is the Duration between start and latest split. Returns:Duration the split Duration. Exceptions IllegalStateException: if this StopWatch has not yet been split. Since 3.16.0

getSplitDuration

back to summary

public Duration getSplitDuration()

Gets the split Duration on this StopWatch.

This is the Duration between start and latest split.

Returns:Duration

the split Duration.

Exceptions

IllegalStateException:: if this StopWatch has not yet been split.

Since

3.16.0

getSplitNanoTime	back to summary
public long getSplitNanoTime() Gets the split time in nanoseconds. This is the time between start and latest split. Returns:long the split time in nanoseconds. Exceptions IllegalStateException: if this StopWatch has not yet been split. Since 3.0

getSplitNanoTime

back to summary

public long getSplitNanoTime()

Gets the split time in nanoseconds.

This is the time between start and latest split.

Returns:long

the split time in nanoseconds.

Exceptions

IllegalStateException:: if this StopWatch has not yet been split.

Since

3.0

getSplits	back to summary
public List<StopWatch.Split> getSplits() Gets the split list. Returns:List<StopWatch.Split> the list of splits. Since 3.20.0

getSplits

back to summary

public List<StopWatch.Split> getSplits()

Gets the split list.

Returns:List<StopWatch.Split>: the list of splits.
Since: 3.20.0

getSplitTime back to summary

getSplitTime	back to summary
public long getSplitTime() Deprecated Use `getSplitDuration()`. Gets the split time on this StopWatch. This is the time between start and latest split. Returns:long the split time in milliseconds. Annotations @Deprecated Exceptions IllegalStateException: if this StopWatch has not yet been split. Since 2.1

public long getSplitTime()

Deprecated

Use getSplitDuration().

Gets the split time on this StopWatch.

This is the time between start and latest split.

Returns:long

the split time in milliseconds.

Annotations

@Deprecated

Exceptions

IllegalStateException:: if this StopWatch has not yet been split.

Since

2.1

getStartInstant	back to summary
public Instant getStartInstant() Gets the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC. Returns:Instant the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC. Exceptions IllegalStateException: if this StopWatch has not been started. Since 3.16.0

getStartInstant

back to summary

public Instant getStartInstant()

Gets the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC.

Returns:Instant

the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC.

Exceptions

IllegalStateException:: if this StopWatch has not been started.

Since

3.16.0

getStartTime back to summary

getStartTime	back to summary
public long getStartTime() Deprecated Use `getStartInstant()`. Gets the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC. Returns:long the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC. Annotations @Deprecated Exceptions IllegalStateException: if this StopWatch has not been started. Since 2.4

public long getStartTime()

Deprecated

Use getStartInstant().

Gets the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Returns:long

the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Annotations

@Deprecated

Exceptions

IllegalStateException:: if this StopWatch has not been started.

Since

2.4

getStopInstant	back to summary
public Instant getStopInstant() Gets the Instant this StopWatch was stopped, between the current time and midnight, January 1, 1970 UTC. Returns:Instant the Instant this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC. Exceptions IllegalStateException: if this StopWatch has not been started. Since 3.16.0

getStopInstant

back to summary

public Instant getStopInstant()

Gets the Instant this StopWatch was stopped, between the current time and midnight, January 1, 1970 UTC.

Returns:Instant

the Instant this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Exceptions

IllegalStateException:: if this StopWatch has not been started.

Since

3.16.0

getStopTime back to summary

getStopTime	back to summary
public long getStopTime() Deprecated Use `getStopInstant()`. Gets the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC. Returns:long the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC. Annotations @Deprecated Exceptions IllegalStateException: if this StopWatch has not been started. Since 3.12.0

public long getStopTime()

Deprecated

Use getStopInstant().

Gets the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Returns:long

the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Annotations

@Deprecated

Exceptions

IllegalStateException:: if this StopWatch has not been started.

Since

3.12.0

getT back to summary

getT	back to summary
public <T, E extends Throwable> T getT(final FailableSupplier<T, E> supplier) throws Throwable Delegates to `FailableSupplier#get()` while recording the duration of the call. Parameters <T> the type of results supplied by this supplier. <E> The kind of thrown exception or error. supplier:FailableSupplier<T, E> The supplier to `Supplier#get()`. Returns:T a result from the given Supplier. Exceptions Throwable: if the supplier fails. Since 3.18.0

public <T, E extends Throwable> T getT(final FailableSupplier<T, E> supplier) throws Throwable

Delegates to FailableSupplier#get() while recording the duration of the call.

Parameters

<T>: the type of results supplied by this supplier.
<E>: The kind of thrown exception or error.
supplier:FailableSupplier<T, E>: The supplier to Supplier#get().

Returns:T

a result from the given Supplier.

Exceptions

Throwable:: if the supplier fails.

Since

3.18.0

getTime back to summary

getTime	back to summary
public long getTime() Gets the time on this StopWatch. This is either the time between the start and the moment this method is called, or the amount of time between start and stop. Returns:long the time in milliseconds. See Also `getDuration()`

public long getTime()

Gets the time on this StopWatch.

This is either the time between the start and the moment this method is called, or the amount of time between start and stop.

Returns:long: the time in milliseconds.
See Also: getDuration()

getTime back to summary

getTime	back to summary
public long getTime(final TimeUnit timeUnit) Gets the time in the specified TimeUnit. This is either the time between the start and the moment this method is called, or the amount of time between start and stop. The resulting time will be expressed in the desired TimeUnit with any remainder rounded down. For example, if the specified unit is `TimeUnit.HOURS` and this StopWatch time is 59 minutes, then the result returned will be `0`. Parameters timeUnit:TimeUnit the unit of time, not null. Returns:long the time in the specified TimeUnit, rounded down. Since 3.5

public long getTime(final TimeUnit timeUnit)

Gets the time in the specified TimeUnit.

This is either the time between the start and the moment this method is called, or the amount of time between start and stop. The resulting time will be expressed in the desired TimeUnit with any remainder rounded down. For example, if the specified unit is TimeUnit.HOURS and this StopWatch time is 59 minutes, then the result returned will be 0.

Parameters

timeUnit:TimeUnit: the unit of time, not null.

Returns:long

the time in the specified TimeUnit, rounded down.

Since

3.5

isStarted	back to summary
public boolean isStarted() Tests whether this StopWatch is started. A suspended StopWatch is also started watch. Returns:boolean boolean If this StopWatch is started. Since 3.2

isStarted

back to summary

public boolean isStarted()

Tests whether this StopWatch is started. A suspended StopWatch is also started watch.

Returns:boolean: boolean If this StopWatch is started.
Since: 3.2

isStopped	back to summary
public boolean isStopped() Tests whether StopWatch is stopped. this StopWatch which's not yet started and explicitly stopped StopWatch is considered as stopped. Returns:boolean boolean If this StopWatch is stopped. Since 3.2

isStopped

back to summary

public boolean isStopped()

Tests whether StopWatch is stopped. this StopWatch which's not yet started and explicitly stopped StopWatch is considered as stopped.

Returns:boolean: boolean If this StopWatch is stopped.
Since: 3.2

isSuspended	back to summary
public boolean isSuspended() Tests whether this StopWatch is suspended. Returns:boolean boolean If this StopWatch is suspended. Since 3.2

isSuspended

back to summary

public boolean isSuspended()

Tests whether this StopWatch is suspended.

Returns:boolean: boolean If this StopWatch is suspended.
Since: 3.2

nanosToMillis	back to summary
private long nanosToMillis(final long nanos) Converts nanoseconds to milliseconds. Parameters nanos:long nanoseconds to convert. Returns:long milliseconds conversion result.

nanosToMillis

back to summary

private long nanosToMillis(final long nanos)

Converts nanoseconds to milliseconds.

Parameters

nanos:long: nanoseconds to convert.

Returns:long

milliseconds conversion result.

reset	back to summary
public void reset() Resets this StopWatch. Stops it if need be. This method clears the internal values to allow the object to be reused.

reset

back to summary

public void reset()

Resets this StopWatch. Stops it if need be.

This method clears the internal values to allow the object to be reused.

resume	back to summary
public void resume() Resumes this StopWatch after a suspend. This method resumes the watch after it was suspended. The watch will not include time between the suspend and resume calls in the total time. Exceptions IllegalStateException: if this StopWatch has not been suspended.

resume

back to summary

public void resume()

Resumes this StopWatch after a suspend.

This method resumes the watch after it was suspended. The watch will not include time between the suspend and resume calls in the total time.

Exceptions

IllegalStateException:: if this StopWatch has not been suspended.

run back to summary

run	back to summary
public void run(final Runnable runnable) Delegates to `Runnable#run()` while recording the duration of the call. Parameters runnable:Runnable The runnable to `Runnable#run()`. Since 3.18.0

public void run(final Runnable runnable)

Delegates to Runnable#run() while recording the duration of the call.

Parameters

runnable:Runnable: The runnable to Runnable#run().

Since

3.18.0

runT back to summary

runT	back to summary
public <E extends Throwable> void runT(final FailableRunnable<E> runnable) throws Throwable Delegates to `FailableRunnable#run()` while recording the duration of the call. Parameters <E> The kind of `Throwable`. runnable:FailableRunnable<E> The runnable to `FailableRunnable#run()`. Exceptions Throwable: Thrown by `FailableRunnable#run()`. Since 3.18.0

public <E extends Throwable> void runT(final FailableRunnable<E> runnable) throws Throwable

Delegates to FailableRunnable#run() while recording the duration of the call.

Parameters

<E>: The kind of Throwable.
runnable:FailableRunnable<E>: The runnable to FailableRunnable#run().

Exceptions

Throwable:: Thrown by FailableRunnable#run().

Since

3.18.0

split back to summary

split	back to summary
public void split() Splits the time. This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling `unsplit()` to continue the timing from the original start point. Exceptions IllegalStateException: if this StopWatch is not running.

public void split()

Splits the time.

This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling unsplit() to continue the timing from the original start point.

Exceptions

IllegalStateException:: if this StopWatch is not running.

split back to summary

split	back to summary
public void split(final String label) Splits the time with a label. This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling `unsplit()` to continue the timing from the original start point. Parameters label:String A message for string presentation. Exceptions IllegalStateException: if the StopWatch is not running. Since 3.20.0

public void split(final String label)

Splits the time with a label.

This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling unsplit() to continue the timing from the original start point.

Parameters

label:String: A message for string presentation.

Exceptions

IllegalStateException:: if the StopWatch is not running.

Since

3.20.0

start	back to summary
public void start() Starts this StopWatch. This method starts a new timing session, clearing any previous values. Exceptions IllegalStateException: if this StopWatch is already running.

start

back to summary

public void start()

Starts this StopWatch.

This method starts a new timing session, clearing any previous values.

Exceptions

IllegalStateException:: if this StopWatch is already running.

startResume	back to summary
private void startResume() Starts or resumes this StopWatch.

stop	back to summary
public void stop() Stops this StopWatch. This method ends a new timing session, allowing the time to be retrieved. Exceptions IllegalStateException: if this StopWatch is not running.

stop

back to summary

public void stop()

Stops this StopWatch.

This method ends a new timing session, allowing the time to be retrieved.

Exceptions

IllegalStateException:: if this StopWatch is not running.

suspend	back to summary
public void suspend() Suspends this StopWatch for later resumption. This method suspends the watch until it is resumed. The watch will not include time between the suspend and resume calls in the total time. Exceptions IllegalStateException: if this StopWatch is not currently running.

suspend

back to summary

public void suspend()

Suspends this StopWatch for later resumption.

This method suspends the watch until it is resumed. The watch will not include time between the suspend and resume calls in the total time.

Exceptions

IllegalStateException:: if this StopWatch is not currently running.

toSplitString back to summary

toSplitString	back to summary
public String toSplitString() Gets a summary of the last split time that this StopWatch recorded as a string. The format used is ISO 8601-like, [message ]hours:minutes:seconds.milliseconds. Returns:String the split time as a String. Since 2.1, 3.10 Returns the prefix `"message "` if the message is set.

public String toSplitString()

Gets a summary of the last split time that this StopWatch recorded as a string.

The format used is ISO 8601-like, [message ]hours:minutes:seconds.milliseconds.

Returns:String: the split time as a String.
Since: 2.1, 3.10 Returns the prefix "message " if the message is set.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Gets a summary of the time that this StopWatch recorded as a string. The format used is ISO 8601-like, [message ]hours:minutes:seconds.milliseconds. Returns:String the time as a String. Annotations @Override Since 3.10 Returns the prefix `"message "` if the message is set.

public String toString()

Overrides java.lang.Object.toString.

Gets a summary of the time that this StopWatch recorded as a string.

The format used is ISO 8601-like, [message ]hours:minutes:seconds.milliseconds.

Returns:String

the time as a String.

Annotations

@Override

Since

3.10 Returns the prefix "message " if the message is set.

unsplit

back to summary

public void unsplit()

Removes the split.

This method clears the stop time. The start time is unaffected, enabling timing from the original start point to continue.

Exceptions

IllegalStateException:: if this StopWatch has not been split.

org.apache.commons.lang3.time back to summary

public final Class StopWatch.Split

Class Inheritance

extends ImmutablePair<String, Duration>

java.lang.Object
org.apache.commons.lang3.tuple.Pair
org.apache.commons.lang3.tuple.ImmutablePair
org.apache.commons.lang3.time.StopWatch.Split

Stores a split as a label and duration.

Since: 3.20.0

Field Summary

Inherited from org.apache.commons.lang3.tuple.ImmutablePair:: EMPTY_ARRAY left right

Constructor Summary

Access	Constructor and Description
public	Split(String Label for this split. label, Duration Duration for this split. duration) Constructs a Split object with label and duration.

Method Summary

Modifier and Type	Method and Description
public Duration	Returns: The duration of this split.. getDuration() Gets the duration of this split.
public String	Returns: The label of this split. getLabel() Gets the label of this split.
public String	Returns: this instance to a string. toString() Overrides org.apache.commons.lang3.tuple.Pair.toString. Converts this instance to a string.

Inherited from org.apache.commons.lang3.tuple.ImmutablePair:: emptyArray getLeft getRight left nullPair of of ofNonNull right setValue

Constructor Detail

Split

back to summary

public Split(String label, Duration duration)

Constructs a Split object with label and duration.

Parameters

label:String: Label for this split.
duration:Duration: Duration for this split.

Method Detail

getDuration

back to summary

public Duration getDuration()

Gets the duration of this split.

Returns:Duration: The duration of this split..

getLabel

back to summary

public String getLabel()

Gets the label of this split.

Returns:String: The label of this split.

toString

back to summary

public String toString()

Overrides org.apache.commons.lang3.tuple.Pair.toString.

Converts this instance to a string.

Returns:String

this instance to a string.

Annotations

@Override

org.apache.commons.lang3.time back to summary

private final Enum StopWatch.SplitState

Class Inheritance

extends Enum<StopWatch.SplitState>

java.lang.Object
java.lang.Enum
org.apache.commons.lang3.time.StopWatch.SplitState

Enumeration type which indicates the split status of a StopWatch.

Field Summary

Modifier and Type	Field and Description
public static final StopWatch.SplitState	SPLIT
public static final StopWatch.SplitState	UNSPLIT

Constructor Summary

Access	Constructor and Description
private	SplitState()

Method Summary

Modifier and Type	Method and Description
public static StopWatch.SplitState	valueOf(String name)
public static StopWatch.SplitState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

SPLIT	back to summary
public static final StopWatch.SplitState SPLIT

UNSPLIT	back to summary
public static final StopWatch.SplitState UNSPLIT

Constructor Detail

SplitState	back to summary
private SplitState()

Method Detail

valueOf	back to summary
public static StopWatch.SplitState valueOf(String name)

values	back to summary
public static StopWatch.SplitState[] values()

org.apache.commons.lang3.time back to summary

private sealed Enum StopWatch.State

Class Inheritance

extends Enum<StopWatch.State>

java.lang.Object
java.lang.Enum
org.apache.commons.lang3.time.StopWatch.State

Enumeration type which indicates the status of a StopWatch.

Field Summary

Modifier and Type	Field and Description
public static final StopWatch.State	RUNNING
public static final StopWatch.State	STOPPED
public static final StopWatch.State	SUSPENDED
public static final StopWatch.State	UNSTARTED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
pack-priv abstract boolean	Returns: boolean If this StopWatch is started. isStarted() Tests whether this StopWatch is started.
pack-priv abstract boolean	Returns: boolean If this StopWatch is stopped. isStopped() Tests whether this StopWatch is stopped.
pack-priv abstract boolean	Returns: boolean If this StopWatch is suspended. isSuspended() Tests whether this StopWatch is suspended.
public static StopWatch.State	valueOf(String name)
public static StopWatch.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

RUNNING	back to summary
public static final StopWatch.State RUNNING

STOPPED	back to summary
public static final StopWatch.State STOPPED

SUSPENDED	back to summary
public static final StopWatch.State SUSPENDED

UNSTARTED	back to summary
public static final StopWatch.State UNSTARTED

Constructor Detail

State	back to summary
private State()

Method Detail

isStarted

back to summary

pack-priv abstract boolean isStarted()

Tests whether this StopWatch is started. A suspended StopWatch is also started.

Returns:boolean: boolean If this StopWatch is started.

isStopped

back to summary

pack-priv abstract boolean isStopped()

Tests whether this StopWatch is stopped. A StopWatch which is not yet started and explicitly stopped is considered stopped.

Returns:boolean: boolean If this StopWatch is stopped.

isSuspended

back to summary

pack-priv abstract boolean isSuspended()

Tests whether this StopWatch is suspended.

Returns:boolean: boolean If this StopWatch is suspended.

valueOf	back to summary
public static StopWatch.State valueOf(String name)

values	back to summary
public static StopWatch.State[] values()

public Class StopWatch

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class StopWatch.Split

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Enum StopWatch.SplitState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private sealed Enum StopWatch.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail