Package com.codingchili.core.benchmarking.reporting

Class BenchmarkConsoleReport

java.lang.Object

com.codingchili.core.benchmarking.reporting.BenchmarkConsoleReport

All Implemented Interfaces:

BenchmarkReport

public class BenchmarkConsoleReport
extends Object
implements BenchmarkReport

Crates benchmark reports in the terminal.

Constructor Summary

Constructors

Constructor	Description
BenchmarkConsoleReport(List<BenchmarkGroup> groups)

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 string)	Sets the template to use.

Methods inherited from class java.lang.Object

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

Constructor Details

BenchmarkConsoleReport

public BenchmarkConsoleReport(List<BenchmarkGroup> groups)

Method Details

template

public BenchmarkReport template(String string)

Description copied from interface: BenchmarkReport

Sets the template to use. May be a path to a file or a template.

Specified by:

template in interface BenchmarkReport

Parameters:

string - path or template to use

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