Result.java

package com.carrotsearch.junitbenchmarks;

import org.junit.runners.model.FrameworkMethod;

import java.lang.reflect.Method;

/**
 * A result of a single benchmark test.
 */
public final class Result
{
    private final Object target;
    private final FrameworkMethod method;

    public final int benchmarkRounds, warmupRounds;
    public final long warmupTime, benchmarkTime;
    public final Average roundAverage;
    public final Average gcAverage;
    public final GCSnapshot gcInfo;
    public final long units;

    /**
     * @param target Target object (test).
     * @param method Target tested method.
     * @param benchmarkRounds Number of executed benchmark rounds.
     * @param warmupRounds Number of warmup rounds.
     * @param warmupTime Total warmup time, includes benchmarking and GC overhead.
     * @param benchmarkTime Total benchmark time, includes benchmarking and GC overhead.
     * @param roundAverage Average and standard deviation from benchmark rounds.
     * @param gcAverage Average and standard deviation from GC cleanups.
     * @param gcInfo Extra information about GC activity.
     */
    public Result(
        Object target, 
        FrameworkMethod method, 
        int benchmarkRounds,
        int warmupRounds, 
        long warmupTime, 
        long benchmarkTime,
        Average roundAverage, 
        Average gcAverage, 
        GCSnapshot gcInfo,
        long units)
    {
        this.target = target;
        this.method = method;
        this.benchmarkRounds = benchmarkRounds;
        this.warmupRounds = warmupRounds;
        this.warmupTime = warmupTime;
        this.benchmarkTime = benchmarkTime;
        this.roundAverage = roundAverage;
        this.gcAverage = gcAverage;
        this.gcInfo = gcInfo;
        this.units = units;
    }
    
    /**
     * Returns the short version of the test's class.
     */
    public String getShortTestClassName()
    {
        return target.getClass().getSimpleName();
    }
    
    /**
     * Returns the long version of the test's class.
     */
    public String getTestClassName()
    {
        return target.getClass().getName();
    }

    /**
     * @return Return the test method's name.
     */
    public String getTestMethodName()
    {
        return method.getName();
    }

    /**
     * Returns the class under test.
     */
    public Class<?> getTestClass()
    {
        return method.getMethod().getDeclaringClass();
    }

    /**
     * Returns the method under test. 
     */
    public Method getTestMethod()
    {
        return method.getMethod();
    }
}