Package io.delta.kernel.internal.metrics

Class Timer

Object

io.delta.kernel.internal.metrics.Timer

public class Timer
extends Object

A timer class for measuring the duration of operations in nanoseconds

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Timer.ThrowingSupplier<T,E extends Exception>	Times an operation that can throw a specific checked exception type.
static interface	Timer.Timed	A timing sample that carries internal state about the Timer's start position.

Constructor Summary

Constructors

Constructor	Description
Timer()

Method Summary

Modifier and Type	Method	Description
long	count()
void	record(long amount)	Records a custom amount.
Timer.Timed	start()	Starts the timer and returns a Timer.Timed instance.
void	time(Runnable runnable)
<T> T	time(Supplier<T> supplier)
<T> T	timeCallable(Callable<T> callable)
<T, E extends Exception> T	timeChecked(Timer.ThrowingSupplier<T,E> operation)	Times an operation that can throw a specific checked exception type.
String	toString()
Optional<Long>	totalDurationIfRecorded()
long	totalDurationMs()
long	totalDurationNs()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Timer

public Timer()

Method Details

count

public long count()

Returns:

the number of times this timer was used to record a duration.

totalDurationNs

public long totalDurationNs()

Returns:

the total duration that was recorded in nanoseconds

totalDurationMs

public long totalDurationMs()

Returns:

the total duration that was recorded in milliseconds

totalDurationIfRecorded

public Optional<Long> totalDurationIfRecorded()

Returns:

An optional storing the total duration recorded in the timer if the timer has been used to record a duration at least once. If the timer has not been used, returns empty.

start

public Timer.Timed start()

Starts the timer and returns a Timer.Timed instance. Call Timer.Timed.stop() to complete the timing.

Returns:

A Timer.Timed instance with the start time recorded.

record

public void record(long amount)

Records a custom amount.

Parameters:

amount - The amount to record in nanoseconds

time

public <T> T time(Supplier<T> supplier)

timeCallable

public <T> T timeCallable(Callable<T> callable)
                   throws Exception

Throws:

Exception

timeChecked

public <T,
E extends Exception> T timeChecked(Timer.ThrowingSupplier<T,E> operation)
                                       throws E

Times an operation that can throw a specific checked exception type.

Throws:

E

time

public void time(Runnable runnable)

toString

public String toString()

Overrides:

toString in class Object