Package org.kiwiproject.beta.time

Class Timing

java.lang.Object

org.kiwiproject.beta.time.Timing

@Beta
public final class Timing
extends Object

Timing utilities that provide a convenient way to measure elapsed time of operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Timing.Timed	Represents an operation that is timed.
static final class	Timing.TimedNoResult	Represents an operation that is timed and returns no result.
static interface	Timing.TimedWithError	Represents an operation that is timed and may throw a runtime exception.
static final class	Timing.TimedWithErrorNoResult	Represents an operation that is timed and returns no result, but may throw an exception.
static final class	Timing.TimedWithErrorOrResult<R>	Represents an operation that is timed and returns a (possibly null) result, but may throw an exception.
static final class	Timing.TimedWithResult<R>	Represents an operation that is timed and returns a result.

Method Summary

Modifier and Type	Method	Description
static Timing.TimedWithErrorNoResult	timeNoResult(Runnable operation)	Time an operation that does not return a result, but may throw an exception.
static Timing.TimedNoResult	timeNoResult(org.apache.commons.lang3.time.StopWatch stopWatch, Runnable operation)	Time an operation that does not return a result using StopWatch.
static <R> Timing.TimedWithErrorOrResult<R>	timeWithResult(Supplier<R> operation)	Time an operation that returns a result or throws an exception.
static <R> Timing.TimedWithResult<R>	timeWithResult(org.apache.commons.lang3.time.StopWatch stopWatch, Supplier<R> operation)	Time an operation that returns a result using StopWatch.

Methods inherited from class java.lang.Object

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

Method Details

timeWithResult

@CheckReturnValue
public static <R> Timing.TimedWithResult<R> timeWithResult(org.apache.commons.lang3.time.StopWatch stopWatch,
 Supplier<R> operation)

Time an operation that returns a result using StopWatch. Any exception thrown by the Supplier is propagated (not caught).

The StopWatch is reset before starting. It is always stopped, even if the operation throws an exception.

If you need the elapsed time when an exception is thrown, you can simply call StopWatch.getDuration() or StopWatch.getNanoTime().

Since StopWatch is not thread-safe, callers are responsible for ensuring thread-safety. Passing it as an argument permits timing more than one sequential operation in the same method, but could lead to problems if callers are not careful. Typical use is to instantiate the StopWatch within a method and use it only within that method.

Type Parameters:

R - the type of result returned by the operation

Parameters:

stopWatch - the StopWatch to use

operation - the operation to time

Returns:

a Timing.TimedWithResult containing the elapsed time and the result of the operation

timeNoResult

@CheckReturnValue
public static Timing.TimedNoResult timeNoResult(org.apache.commons.lang3.time.StopWatch stopWatch,
 Runnable operation)

Time an operation that does not return a result using StopWatch. Any exception thrown by the Supplier is propagated (not caught).

The StopWatch is reset before starting. It is always stopped, even if the operation throws an exception.

If you need the elapsed time when an exception is thrown, you can simply call StopWatch.getDuration() or StopWatch.getNanoTime().

Since StopWatch is not thread-safe, callers are responsible for ensuring thread-safety. Passing it as an argument permits timing more than one sequential operation in the same method, but could lead to problems if callers are not careful. Typical use is to instantiate the StopWatch within a method and use it only within that method.

Parameters:

stopWatch - the StopWatch to use

operation - the operation to time

Returns:

a Timing.TimedNoResult containing the elapsed time of the operation

timeWithResult

@CheckReturnValue
public static <R> Timing.TimedWithErrorOrResult<R> timeWithResult(Supplier<R> operation)

Time an operation that returns a result or throws an exception. The return value should be inspected to determine whether the operation succeeded or failed.

Type Parameters:

R - the type of result returned by the operation

Parameters:

operation - the operation to time

Returns:

a Timing.TimedWithErrorOrResult containing the elapsed time and the result of the operation or an exception if the operation failed

timeNoResult

@CheckReturnValue
public static Timing.TimedWithErrorNoResult timeNoResult(Runnable operation)

Time an operation that does not return a result, but may throw an exception. The return value should be inspected to determine whether the operation succeeded or failed.

Parameters:

operation - the operation to time

Returns:

a Timing.TimedWithErrorNoResult containing the elapsed time of the operation and an exception if the operation failed