org.jboss.jrunit.controller
Interface IBenchmark

All Known Implementing Classes:

BenchmarkController

public interface IBenchmark

A BenchmarkMeasure controller controls the life cycle of a benchmarking. Basically you can have a benchmark, and a benchmark can have sub-benchmarks generating a graph-like infra-structure. The biggest differentiation to a profiler infra-structure, is that we can add more values than simply measuring time/cpu and memory. It is possible for example, o measure the number of produced bytes. Usually a implementation of this class requires the benchmark to be running in the same thread.

Author:

Clebert Suconic

Method Summary

void	addMeasure(java.lang.String measureName, java.lang.Number value) This will add a measure o the current Benchmark
void	closeBench(java.lang.String benchmarkName) This will basically send a sign to the Controller implementation that a new benchmark is being started.
void	openBench(java.lang.String benchmarkName) /** This will basically send a sign to the Controller implementation that a new benchmark is being stoped.

Method Detail

closeBench

public void closeBench(java.lang.String benchmarkName)
                throws java.lang.Exception

This will basically send a sign to the Controller implementation that a new benchmark is being started. Usually the implementation will capture information like current CPU state, memory state or any sort of resources associated with this Implementation.

Throws:

java.lang.Exception

openBench

public void openBench(java.lang.String benchmarkName)
               throws java.lang.Exception

/** This will basically send a sign to the Controller implementation that a new benchmark is being stoped. Usually the implementation will capture information like current CPU state, memory state or any sort of resources associated with this Implementation.

Throws:

java.lang.Exception

addMeasure

public void addMeasure(java.lang.String measureName,
                       java.lang.Number value)
                throws java.lang.Exception

This will add a measure o the current Benchmark

Throws:

java.lang.Exception