com.atlassian.instrumentation.operations

Class SimpleOpTimer

java.lang.Object

com.atlassian.instrumentation.operations.SimpleOpTimer

All Implemented Interfaces:

OpTimer

public class SimpleOpTimer
extends Object
implements OpTimer

A new instance of this class will begin a profiling operation, one that can count how long an operation takes and how much CPU it used.

These are ONE TIME USE objects.

Once end() has been called they cannot be called again and WILL throw IllegalStateException if you try.

You can however ask for a snapshot() at any time if you want but that is a secondary use case.

The cpu time is based on the Java JMX ThreadMXBean.getCurrentThreadCpuTime() and hence this object should not be shared amongst multiple threads otherwise the value is meaningless.

Since:

v4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.instrumentation.operations.OpTimer

OpTimer.HeisenburgResultSetCalculator, OpTimer.OnEndCallback

Constructor Summary

Constructors

Constructor and Description
SimpleOpTimer(String name) Once you construct a SimpleOpTimer, the timer is started.
SimpleOpTimer(String name, boolean captureCPUCost, OpTimer.OnEndCallback onEndCallback)

Method Summary

Modifier and Type	Method and Description
OpSnapshot	end() Call this in a finally{} block or at the end of the operation to stop the clock
OpSnapshot	end(long resultSetSize) Call this in a finally{} block or at the end of the operation to stop the clock
OpSnapshot	end(OpTimer.HeisenburgResultSetCalculator heisenburgResultSetCalculator) Call this in a finally{} block or at the end of the operation to stop the clock
OpSnapshot	endWithTime(long timeInMillis) Call this in a finally{} block or at the end of the operation with the time taken by the operation
String	getName() The name of the timer.
OpSnapshot	snapshot() This will return a snap shot of how long the timer has been running for.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOpTimer

public SimpleOpTimer(String name)

Once you construct a SimpleOpTimer, the timer is started. GO!

Parameters:

name - the name of the operation being timed

SimpleOpTimer

public SimpleOpTimer(String name,
                     boolean captureCPUCost,
                     OpTimer.OnEndCallback onEndCallback)

Method Detail

getName

public String getName()

Description copied from interface: OpTimer

The name of the timer. This should be the same name as returned on the OpSnapshot objects created by this interface.

Specified by:

getName in interface OpTimer

Returns:

the name of the operation being timed

snapshot

public OpSnapshot snapshot()

Description copied from interface: OpTimer

This will return a snap shot of how long the timer has been running for. This can be called many times. If end() has not been called, then OpSnapshot returned reflects how long the timer has been running for. If end() has been called, then it MUST return the same value as the end() method returned.

Specified by:

snapshot in interface OpTimer

Returns:

a new OpSnapshot object will the invocation count = 1, the resultSetSize of Double.NAN and the milliseconds set to how long this timer has been running for.

end

public OpSnapshot end(long resultSetSize)

Description copied from interface: OpTimer

Call this in a finally{} block or at the end of the operation to stop the clock

Specified by:

end in interface OpTimer

Parameters:

resultSetSize - the size of the operations result.

Returns:

a new OpSnapshot representing this operation timing

end

public OpSnapshot end()

Description copied from interface: OpTimer

Call this in a finally{} block or at the end of the operation to stop the clock

The result set size will be set to Double.NAN.

Specified by:

end in interface OpTimer

Returns:

a new OpSnapshot representing this operation timing

end

public OpSnapshot end(OpTimer.HeisenburgResultSetCalculator heisenburgResultSetCalculator)

Description copied from interface: OpTimer

Call this in a finally{} block or at the end of the operation to stop the clock

Specified by:

end in interface OpTimer

Parameters:

heisenburgResultSetCalculator - a class to calculate the time

Returns:

a new OpSnapshot representing this operation timing

endWithTime

public OpSnapshot endWithTime(long timeInMillis)

Description copied from interface: OpTimer

Call this in a finally{} block or at the end of the operation with the time taken by the operation

Specified by:

endWithTime in interface OpTimer

Parameters:

timeInMillis - Time taken by the operation

Returns:

a new OpSnapshot representing this operation timing