com.fillumina.performance.consumer.PerformanceConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of performance-tools Show documentation

Configurable tool to easily compare performances of different code snippets and to take performance telemetry of a running application.

The newest version!

package com.fillumina.performance.consumer;

import com.fillumina.performance.producer.LoopPerformances;

/**
 * Consumes a named {@link LoopPerformances} to accomplish various tasks such as:
 * 
 * 
 * Assert something about the performances
 * (i.e. {@link com.fillumina.performance.consumer.assertion.AssertPerformance});
 * 
 * 
 * Print out the performances
 * (i.e. {@link com.fillumina.performance.consumer.viewer.StringTableViewer},
 * {@link com.fillumina.performance.consumer.viewer.StringCsvViewer}).
 * 
 * 
 *
 * @author Francesco Illuminati
 */
public interface PerformanceConsumer {

    /**
     * Consumes a {@link LoopPerformances} with an associated message.
     *
     * @param message           it's the test's name or description
     *                          possibly {@code null}.
     * @param loopPerformances  the performances. {@code null} should be
     *                          expected with a do-nothing semantic.
     */
    void consume(final String message, final LoopPerformances loopPerformances);
}