io.smallrye.metrics.app

Class SimpleTimerImpl

java.lang.Object

io.smallrye.metrics.app.SimpleTimerImpl

All Implemented Interfaces:

org.eclipse.microprofile.metrics.Counting, org.eclipse.microprofile.metrics.Metric, org.eclipse.microprofile.metrics.SimpleTimer

public class SimpleTimerImpl
extends Object
implements org.eclipse.microprofile.metrics.SimpleTimer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleTimerImpl.Context A timing context.

Constructor Summary

Constructors

Constructor and Description
SimpleTimerImpl() Creates a new SimpleTimerImpl using the default Clock.
SimpleTimerImpl(Clock clock) Creates a new SimpleTimerImpl that uses the given Clock.

Method Summary

Modifier and Type	Method and Description
long	getCount()
Duration	getElapsedTime()
SimpleTimerImpl.Context	time() Returns a new SimpleTimerImpl.Context.
<T> T	time(Callable<T> event) Times and records the duration of event.
void	time(Runnable event) Times and records the duration of event.
void	update(Duration duration) Adds a recorded duration.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTimerImpl

public SimpleTimerImpl()

Creates a new SimpleTimerImpl using the default Clock.

SimpleTimerImpl

public SimpleTimerImpl(Clock clock)

Creates a new SimpleTimerImpl that uses the given Clock.

Parameters:

clock - the Clock implementation the timer should use

Method Detail

update

public void update(Duration duration)

Adds a recorded duration.

Specified by:

update in interface org.eclipse.microprofile.metrics.SimpleTimer

Parameters:

duration - the length of the duration

time

public <T> T time(Callable<T> event)
           throws Exception

Times and records the duration of event.

Specified by:

time in interface org.eclipse.microprofile.metrics.SimpleTimer

Type Parameters:

T - the type of the value returned by event

Parameters:

event - a Callable whose Callable.call() method implements a process whose duration should be timed

Returns:

the value returned by event

Throws:

Exception - if event throws an Exception

time

public void time(Runnable event)

Times and records the duration of event.

Specified by:

time in interface org.eclipse.microprofile.metrics.SimpleTimer

Parameters:

event - a Runnable whose Runnable.run() method implements a process whose duration should be timed

time

public SimpleTimerImpl.Context time()

Returns a new SimpleTimerImpl.Context.

Specified by:

time in interface org.eclipse.microprofile.metrics.SimpleTimer

Returns:

a new SimpleTimerImpl.Context

See Also:

SimpleTimerImpl.Context

getElapsedTime

public Duration getElapsedTime()

Specified by:

getElapsedTime in interface org.eclipse.microprofile.metrics.SimpleTimer

getCount

public long getCount()

Specified by:

getCount in interface org.eclipse.microprofile.metrics.Counting

Specified by:

getCount in interface org.eclipse.microprofile.metrics.SimpleTimer