org.openjdk.jmh.annotations

Annotation Type AuxCounters

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface AuxCounters

AuxCounters annotation can be used to mark State objects as the bearers of auxiliary secondary results. Marking the class with this annotation will enable JMH to look for public {int, long} fields, as well as public methods returning {int, long} values, and treat their values as the operation counts in current iteration.

This allows to override the default operations counter with the user-provided one. Instead of relying on JMH itself counting the number of Benchmark calls, users can tell JMH how many calls actually happened. Note that it might require modifying the counter at each Benchmark invocation.

THIS IS AN EXPERIMENTAL API, which means, among other things:

• It can be modified, deprecated, and/or removed in future
• It is not available for all BenchmarkMode-s
• It is currently allowed only at Scope.Thread level, because JMH metric aggregator expects the distinct counters coming from every measurement thread.
• You have to explicitly reset the state if you don't want the counters to be shared across the iterations.
• The counter names are plain field/method names. The namespace for counters is shared across all states participating in the run. JMH will fail to compile the benchmark if there is an ambiguity around what counter comes from what state class.