io.github.resilience4j.metrics

Interface Timer

All Known Implementing Classes:

TimerImpl

public interface Timer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Timer.Context
static interface	Timer.Metrics

Method Summary

Modifier and Type	Method and Description
Timer.Context	context() Creates a Timer context and starts the timer
static <T> java.util.concurrent.Callable<T>	decorateCallable(Timer timer, java.util.concurrent.Callable<T> callable) Creates a timed Callable.
static <T,R> io.vavr.CheckedFunction1<T,R>	decorateCheckedFunction(Timer timer, io.vavr.CheckedFunction1<T,R> function) Creates a timed function.
static io.vavr.CheckedRunnable	decorateCheckedRunnable(Timer timer, io.vavr.CheckedRunnable runnable) Creates a timed runnable.
static <T> io.vavr.CheckedFunction0<T>	decorateCheckedSupplier(Timer timer, io.vavr.CheckedFunction0<T> supplier) Creates a timed checked supplier.
static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>>	decorateCompletionStageSupplier(Timer timer, java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> stageSupplier)
static <T,R> java.util.function.Function<T,R>	decorateFunction(Timer timer, java.util.function.Function<T,R> function) Creates a timed function.
static java.lang.Runnable	decorateRunnable(Timer timer, java.lang.Runnable runnable) Creates a timed runnable.
static <T> java.util.function.Supplier<T>	decorateSupplier(Timer timer, java.util.function.Supplier<T> supplier) Creates a timed checked supplier.
default <T> T	executeCallable(java.util.concurrent.Callable<T> callable) Decorates and executes the decorated Callable.
default <T> java.util.concurrent.CompletionStage<T>	executeCompletionStageSupplier(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier) Decorates and executes the decorated CompletionStage Supplier.
default void	executeRunnable(java.lang.Runnable runnable) Decorates and executes the decorated Runnable.
default <T> T	executeSupplier(java.util.function.Supplier<T> supplier) Decorates and executes the decorated Supplier.
com.codahale.metrics.MetricRegistry	getMetricRegistry() Returns the MetricRegistry of this Timer.
Timer.Metrics	getMetrics() Returns the Metrics of this Timer.
java.lang.String	getName() Returns the name of this Timer.
static Timer	of(java.lang.String name) Creates a timer of a default MetricRegistry
static Timer	ofMetricRegistry(java.lang.String name, com.codahale.metrics.MetricRegistry metricRegistry) Creates a timer of a provided MetricRegistry

Method Detail

ofMetricRegistry

static Timer ofMetricRegistry(java.lang.String name,
                              com.codahale.metrics.MetricRegistry metricRegistry)

Creates a timer of a provided MetricRegistry

Parameters:

name - the name of the timer

metricRegistry - the MetricRegistry

Returns:

a Timer instance

of

static Timer of(java.lang.String name)

Creates a timer of a default MetricRegistry

Parameters:

name - the name of the timer

Returns:

a Timer instance

decorateCheckedSupplier

static <T> io.vavr.CheckedFunction0<T> decorateCheckedSupplier(Timer timer,
                                                               io.vavr.CheckedFunction0<T> supplier)

Creates a timed checked supplier.

Parameters:

timer - the timer to use

supplier - the original supplier

Returns:

a timed supplier

decorateCheckedRunnable

static io.vavr.CheckedRunnable decorateCheckedRunnable(Timer timer,
                                                       io.vavr.CheckedRunnable runnable)

Creates a timed runnable.

Parameters:

timer - the timer to use

runnable - the original runnable

Returns:

a timed runnable

decorateSupplier

static <T> java.util.function.Supplier<T> decorateSupplier(Timer timer,
                                                           java.util.function.Supplier<T> supplier)

Creates a timed checked supplier.

Parameters:

timer - the timer to use

supplier - the original supplier

Returns:

a timed supplier

decorateCallable

static <T> java.util.concurrent.Callable<T> decorateCallable(Timer timer,
                                                             java.util.concurrent.Callable<T> callable)

Creates a timed Callable.

Parameters:

timer - the timer to use

callable - the original Callable

Returns:

a timed Callable

decorateRunnable

static java.lang.Runnable decorateRunnable(Timer timer,
                                           java.lang.Runnable runnable)

Creates a timed runnable.

Parameters:

timer - the timer to use

runnable - the original runnable

Returns:

a timed runnable

decorateFunction

static <T,R> java.util.function.Function<T,R> decorateFunction(Timer timer,
                                                               java.util.function.Function<T,R> function)

Creates a timed function.

Parameters:

timer - the timer to use

function - the original function

Returns:

a timed function

decorateCheckedFunction

static <T,R> io.vavr.CheckedFunction1<T,R> decorateCheckedFunction(Timer timer,
                                                                   io.vavr.CheckedFunction1<T,R> function)

Creates a timed function.

Parameters:

timer - the timer to use

function - the original function

Returns:

a timed function

decorateCompletionStageSupplier

static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> decorateCompletionStageSupplier(Timer timer,
                                                                                                                java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> stageSupplier)

Parameters:

timer - the timer to use

stageSupplier - the CompletionStage Supplier

Returns:

a decorated completion stage

context

Timer.Context context()

Creates a Timer context and starts the timer

Returns:

the Timer context

getName

java.lang.String getName()

Returns the name of this Timer.

Returns:

the name of this Timer

getMetricRegistry

com.codahale.metrics.MetricRegistry getMetricRegistry()

Returns the MetricRegistry of this Timer.

Returns:

the MetricRegistry of this Timer

getMetrics

Timer.Metrics getMetrics()

Returns the Metrics of this Timer.

Returns:

the Metrics of this Timer

executeRunnable

default void executeRunnable(java.lang.Runnable runnable)

Decorates and executes the decorated Runnable.

Parameters:

runnable - the original Callable

executeCallable

default <T> T executeCallable(java.util.concurrent.Callable<T> callable)
                       throws java.lang.Exception

Decorates and executes the decorated Callable.

Type Parameters:

T - the type of results supplied by this Callable

Parameters:

callable - the original Callable

Returns:

the result of the decorated Callable.

Throws:

java.lang.Exception

executeSupplier

default <T> T executeSupplier(java.util.function.Supplier<T> supplier)

Decorates and executes the decorated Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the original Supplier

Returns:

the result of the decorated Supplier.

executeCompletionStageSupplier

default <T> java.util.concurrent.CompletionStage<T> executeCompletionStageSupplier(java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)

Decorates and executes the decorated CompletionStage Supplier.

Type Parameters:

T - the type of results supplied by this supplier

Parameters:

supplier - the CompletionStage Supplier

Returns:

the result of the decorated Supplier.