com.oracle.graal.debug

Interface DebugTimer

All Known Implementing Classes:

TimerImpl, TimerImpl.FlatTimer

public interface DebugTimer

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
 }
 

Method Summary

Modifier and Type	Method and Description
long	getCurrentValue() Gets the current value of this timer.
default DebugTimer	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.
boolean	isConditional() Determines if this timer is only enabled if timing is enabled.
void	setConditional(boolean flag) Sets a flag determining if this timer is only enabled if timing is enabled.
DebugCloseable	start() Starts this timer if timing is enabled or this is an unconditional timer.

Method Detail

start

DebugCloseable start()

Starts this timer if timing is enabled or this is an unconditional 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

setConditional

void setConditional(boolean flag)

Sets a flag determining if this timer is only enabled if timing is enabled.

isConditional

boolean isConditional()

Determines if this timer is only enabled if timing is enabled.

getCurrentValue

long getCurrentValue()

Gets the current value of this timer.

getTimeUnit

TimeUnit getTimeUnit()

Gets the time unit of this timer.

getFlat

default DebugTimer 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