com.carrotsearch.junitbenchmarks.annotation.BenchmarkHistoryChart Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-benchmarks Show documentation

A framework for writing performance micro-benchmarks using JUnit4 annotations, forked from https://github.com/carrotsearch/junit-benchmarks.

There is a newer version: 0.7.4-scijava

Show newest version

package com.carrotsearch.junitbenchmarks.annotation;

import java.lang.annotation.*;


/**
 * Generate a graphical summary of the historical and current run of a given
 * set of methods. 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Inherited
public @interface BenchmarkHistoryChart
{
    /**
     * Chart file prefix override. If empty, class name is used.
     * Any substring CLASSNAME is replaced with a fully qualified 
     * class name of the annotated test's class.
     */
    String filePrefix() default "";

    /**
     * Maximum number of historical runs to take into account.
     */
    int maxRuns() default Integer.MAX_VALUE;

    /**
     * Use custom keys for X-axis label. If false, run ID is used.
     */
    LabelType labelWith() default LabelType.RUN_ID;
}