Package com.codingchili.core.benchmarking.reporting

Class BenchmarkHTMLReport

java.lang.Object

com.codingchili.core.benchmarking.reporting.BenchmarkHTMLReport

All Implemented Interfaces:

BenchmarkReport

public class BenchmarkHTMLReport
extends Object
implements BenchmarkReport

Generates a HTML benchmark report with Jade.

Constructor Summary

Constructors

Constructor	Description
BenchmarkHTMLReport(BenchmarkGroup result)	Parses the benchmark results of a single benchmark group.
BenchmarkHTMLReport(List<BenchmarkGroup> results)	Parses the benchmarking results of a benchmark group.

Method Summary

Modifier and Type	Method	Description
BenchmarkReport	display()	displays the results of the report by opening the browser, printing to terminal or any other means specified by the implementation.
BenchmarkReport	saveTo(String path)	saves the results to file.
String	saveToFile()	saves the report to file using a generated filename.
BenchmarkReport	template(String template)	Sets the jade template to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BenchmarkHTMLReport

public BenchmarkHTMLReport(BenchmarkGroup result)

Parses the benchmark results of a single benchmark group.

Parameters:

result - a benchmark group to create a report for.

BenchmarkHTMLReport

public BenchmarkHTMLReport(List<BenchmarkGroup> results)

Parses the benchmarking results of a benchmark group.

Parameters:

results - a list of benchmarking groups to create a report for.

Method Details

template

public BenchmarkReport template(String template)

Sets the jade template to use.

Specified by:

template in interface BenchmarkReport

Parameters:

template - a path to jade on the classpath or filesystem.

Returns:

fluent.

display

public BenchmarkReport display()

Description copied from interface: BenchmarkReport

displays the results of the report by opening the browser, printing to terminal or any other means specified by the implementation.

Specified by:

display in interface BenchmarkReport

Returns:

fluent

saveTo

public BenchmarkReport saveTo(String path)

Description copied from interface: BenchmarkReport

saves the results to file.

Specified by:

saveTo in interface BenchmarkReport

Parameters:

path - where the report is written

Returns:

fluent

saveToFile

public String saveToFile()

Description copied from interface: BenchmarkReport

saves the report to file using a generated filename.

Specified by:

saveToFile in interface BenchmarkReport

Returns:

path to the report file that was saved