OpTimer (Atlassian Instrumentation Aggregation

All Known Implementing Classes:

SimpleOpTimer
```
public interface OpTimer
```
OpTimer is an interface to represent the "timing" of a particular computing operation.
The construction of an OpTimer object sets the timer running. There is no "start" method.
Once the end() method has been called, the OpTimer must not be called again. It is a one short object.

Since:

v4.0

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`OpTimer.HeisenburgResultSetCalculator` This interface can be used to avoid HEISENBERG effects when trying to time how long an operation takes.
`static interface`	`OpTimer.OnEndCallback` This interface can be provided to `OpTimerFactory` are creation time to have a call back when `end(long)` is called

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - getName
```
String getName()
```
    The name of the timer. This should be the same name as returned on the OpSnapshot objects created by this interface.
    
    Returns:
    
    the name of the operation being timed
  - snapshot
```
OpSnapshot snapshot()
```
    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.
    
    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.
  - endWithTime
```
OpSnapshot endWithTime(long timeInMillis)
```
    Call this in a finally{} block or at the end of the operation with the time taken by the operation
    
    Parameters:
    
    timeInMillis - Time taken by the operation
    
    Returns:
    
    a new OpSnapshot representing this operation timing
  - end
```
OpSnapshot end(long resultSetSize)
```
    Call this in a finally{} block or at the end of the operation to stop the clock
    
    Parameters:
    
    resultSetSize - the size of the operations result.
    
    Returns:
    
    a new OpSnapshot representing this operation timing
  - end
```
OpSnapshot end()
```
    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.
    
    Returns:
    
    a new OpSnapshot representing this operation timing
  - end
```
OpSnapshot end(OpTimer.HeisenburgResultSetCalculator heisenburgResultSetCalculator)
```
    Call this in a finally{} block or at the end of the operation to stop the clock
    
    Parameters:
    
    heisenburgResultSetCalculator - a class to calculate the time
    
    Returns:
    
    a new OpSnapshot representing this operation timing

Interface OpTimer

Nested Class Summary

Method Summary

Method Detail

getName

snapshot

endWithTime

end

end

end