org.springframework.metrics.instrument.internal

Class AbstractTimer

java.lang.Object

org.springframework.metrics.instrument.internal.AbstractTimer

All Implemented Interfaces:

Meter, Timer

Direct Known Subclasses:

PrometheusTimer, SimpleTimer, SpectatorTimer

public abstract class AbstractTimer
extends java.lang.Object
implements Timer

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.metrics.instrument.Timer

Timer.Builder

Nested classes/interfaces inherited from interface org.springframework.metrics.instrument.Meter

Meter.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock
protected MeterId	id

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTimer(MeterId id, Clock clock)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
java.lang.Iterable<Tag>	getTags()
void	record(java.lang.Runnable f) Executes the runnable `f` and records the time taken.
<T> T	record(java.util.function.Supplier<T> f) Executes the Supplier `f` and records the time taken.
<T> T	recordCallable(java.util.concurrent.Callable<T> f) Executes the callable `f` and records the time taken.
<T> java.util.concurrent.Callable<T>	wrap(java.util.concurrent.Callable<T> f) Wrap a Callable so that it is timed when invoked.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.metrics.instrument.Timer

count, getType, record, totalTime, totalTimeNanos, wrap

Methods inherited from interface org.springframework.metrics.instrument.Meter

measure

Field Detail

clock

protected Clock clock

id

protected MeterId id

Constructor Detail

AbstractTimer

protected AbstractTimer(MeterId id,
                        Clock clock)

Method Detail

recordCallable

public <T> T recordCallable(java.util.concurrent.Callable<T> f)
                     throws java.lang.Exception

Description copied from interface: Timer

Executes the callable `f` and records the time taken.

Specified by:

recordCallable in interface Timer

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

Throws:

java.lang.Exception

record

public <T> T record(java.util.function.Supplier<T> f)

Description copied from interface: Timer

Executes the Supplier `f` and records the time taken.

Specified by:

record in interface Timer

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

wrap

public <T> java.util.concurrent.Callable<T> wrap(java.util.concurrent.Callable<T> f)

Description copied from interface: Timer

Wrap a Callable so that it is timed when invoked.

Specified by:

wrap in interface Timer

Parameters:

f - The Callable to time when it is invoked.

Returns:

The wrapped Callable.

record

public void record(java.lang.Runnable f)

Description copied from interface: Timer

Executes the runnable `f` and records the time taken.

Specified by:

record in interface Timer

Parameters:

f - Function to execute and measure the execution time.

getName

public java.lang.String getName()

Specified by:

getName in interface Meter

getTags

public java.lang.Iterable<Tag> getTags()

Specified by:

getTags in interface Meter