org.graalvm.compiler.debug

Interface TimerKey

All Superinterfaces:

MetricKey

public interface TimerKey
extends MetricKey

A timer for some activity of interest. A timer should be deployed using the try-with-resources pattern:

 try (TimerCloseable a = timer.start()) {
     // the code to time
 }
 

Field Summary

Fields inherited from interface org.graalvm.compiler.debug.MetricKey

NAME_COMPARATOR

Method Summary

Modifier and Type	Method and Description
TimerKey	doc(String string) Sets the documentation for this key.
long	getCurrentValue(DebugContext debug) Gets the current value of this timer.
default TimerKey	getFlat() Gets the timer recording the amount time spent within a timed scope minus the time spent in any nested timed scopes.
TimeUnit	getTimeUnit() Gets the time unit of this timer.
DebugCloseable	start(DebugContext debug) Starts this timer.

Methods inherited from interface org.graalvm.compiler.debug.MetricKey

getDoc, getDocName, getName, toCSVFormat, toHumanReadableFormat

Method Detail

start

DebugCloseable start(DebugContext debug)

Starts this timer.

Returns:

an object that must be closed once the activity has completed to add the elapsed time since this call to the total for this timer

getCurrentValue

long getCurrentValue(DebugContext debug)

Gets the current value of this timer.

getTimeUnit

TimeUnit getTimeUnit()

Gets the time unit of this timer.

doc

TimerKey doc(String string)

Description copied from interface: MetricKey

Sets the documentation for this key.

Specified by:

doc in interface MetricKey

getFlat

default TimerKey getFlat()

Gets the timer recording the amount time spent within a timed scope minus the time spent in any nested timed scopes.

Returns:

null if this timer does not support flat timing