MonitoredCallable (Performetrics 2.1.1 API)

java.lang.Object
- net.obvj.performetrics.monitors.MonitoredCallable<V>

Type Parameters:

V - the result type of method call

All Implemented Interfaces:

Callable<V>
```
public class MonitoredCallable<V>
extends Object
implements Callable<V>
```
A Callable wrapper that maintains one or more counters for monitoring the time spent by the Callable's call() method.

Specify a target Callable via constructor, then execute the call() method available in this wrapper. The target Callable's call() method will be executed and monitored. After the operation, call printStatistics(System.out) to print the statistics to the system console or elapsedTime(Counter.Type), to retrieve the elapsed time duration for a particular counter. E.g.:
```
 double cpuTimeNanos = monitoredRunnable.elapsedTime(Counter.Type.CPU_TIME, TimeUnit.NANOSECONDS);
 
```
By default, all available counter types will be measured, if no specific counter types are passed to the constructor. If required, an additional constructor may be used to set up one or more specific counters to be maintained. E.g.:
```
 new MonitoredCallable(callable); // maintains all available counter types
 new MonitoredCallable(callable, Counter.Type.WALL_CLOCK_TIME); // wall-clock time only
 
```
For a list of available counters, refer to Counter.Type.

Note: This class is not thread-safe. In a multi-thread context, different instances must be created for each thread.
Author:

oswaldo.bapvic.jr

See Also:

Counter, Counter.Type

Constructor Summary

Constructors
Constructor and Description
`MonitoredCallable(Callable<V> targetCallable)` Builds this monitored operation with a given `Callable`.
`MonitoredCallable(Callable<V> targetCallable, Counter.Type... types)` Builds this monitored operation with a given `Callable` and one or more specific counter types to be maintained.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V`	`call()` See `Callable.call()`.
`Duration`	`elapsedTime(Counter.Type type)` A convenient method that returns the elapsed time of a specific counter.
`double`	`elapsedTime(Counter.Type type, TimeUnit timeUnit)` A convenient method that returns the elapsed time of a specific counter, in the specified time unit.
`double`	`elapsedTime(Counter.Type type, TimeUnit timeUnit, ConversionMode conversionMode)` A convenient method that returns the elapsed time of a specific counter, in the specified time unit, by applying a custom `ConversionMode`.
`Counter`	`getCounter(Counter.Type type)` Returns the counter instance associated with a given type in this monitored operation.
`Collection<Counter>`	`getCounters()` Returns the counters maintained by this monitored operation.
`void`	`printStatistics(PrintStream printStream)` Prints operation statistics in the specified print stream.
`void`	`printStatistics(PrintStream printStream, TimeUnit timeUnit)` Prints operation statistics in the specified print stream, with a custom time unit.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MonitoredCallable
```
public MonitoredCallable(Callable<V> targetCallable)
```
    Builds this monitored operation with a given Callable. All available counter types will be maintained.
    
    Parameters:
    
    targetCallable - the Callable to be executed
  - MonitoredCallable
```
public MonitoredCallable(Callable<V> targetCallable,
                         Counter.Type... types)
```
    Builds this monitored operation with a given Callable and one or more specific counter types to be maintained.
    
    Parameters:
    
    targetCallable - the Callable to be executed
    
    types - the counter types to be maintained with the operation
- Method Detail
  - call
```
public V call()
       throws Exception
```
    See Callable.call().
    
    Specified by:
    
    call in interface Callable<V>
    
    Throws:
    
    Exception
  - getCounters
```
public Collection<Counter> getCounters()
```
    Returns the counters maintained by this monitored operation.
    
    Returns:
    
    all counters maintained by this monitored operation.
  - getCounter
```
public Counter getCounter(Counter.Type type)
```
    Returns the counter instance associated with a given type in this monitored operation.
    
    Parameters:
    
    type - the counter type to be fetched
    
    Returns:
    
    the counter instance associated with the given type in this monitored operation
    
    Throws:
    
    IllegalArgumentException - if the specified type is not available in this operation
  - elapsedTime
```
public Duration elapsedTime(Counter.Type type)
```
    A convenient method that returns the elapsed time of a specific counter.
    This has the same effect as calling: operation.getCounter(type).elapsedTime()
    
    Parameters:
    
    type - the counter type to be fetched
    
    Returns:
    
    the elapsed time for the specified counter
    
    Throws:
    
    IllegalArgumentException - if the specified type is not available in this operation
    
    Since:
    
    2.1.0
  - elapsedTime
```
public double elapsedTime(Counter.Type type,
                          TimeUnit timeUnit)
```
    A convenient method that returns the elapsed time of a specific counter, in the specified time unit.
    This has the same effect as calling: operation.getCounter(type).elapsedTime(timeUnit)
    
    Parameters:
    
    type - the counter type to be fetched
    
    timeUnit - the time unit to which the elapsed time will be converted
    
    Returns:
    
    the elapsed time for the specified counter, converted to the given time unit using the default conversion mode.
    
    Throws:
    
    IllegalArgumentException - if the specified type is not available in this operation
    
    Since:
    
    2.1.0
  - elapsedTime
```
public double elapsedTime(Counter.Type type,
                          TimeUnit timeUnit,
                          ConversionMode conversionMode)
```
    A convenient method that returns the elapsed time of a specific counter, in the specified time unit, by applying a custom ConversionMode.
    This has the same effect as calling: operation.getCounter(type).elapsedTime(timeUnit, conversionMode)
    
    Parameters:
    
    type - the counter type to be fetched
    
    timeUnit - the time unit to which the elapsed time will be converted
    
    conversionMode - the ConversionMode to be applied
    
    Returns:
    
    the elapsed time for the specified counter, converted to the given time unit using the given conversion mode.
    
    Throws:
    
    IllegalArgumentException - if the specified type is not available in this operation
    
    Since:
    
    2.1.0
  - printStatistics
```
public void printStatistics(PrintStream printStream)
```
    Prints operation statistics in the specified print stream.
    
    Parameters:
    
    printStream - the print stream to which statistics will be sent
  - printStatistics
```
public void printStatistics(PrintStream printStream,
                            TimeUnit timeUnit)
```
    Prints operation statistics in the specified print stream, with a custom time unit.
    
    Parameters:
    
    printStream - the print stream to which statistics will be sent
    
    timeUnit - the time unit for the elapsed times to be displayed

Class MonitoredCallable<V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonitoredCallable

MonitoredCallable

Method Detail

call

getCounters

getCounter

elapsedTime

elapsedTime

elapsedTime

printStatistics

printStatistics