Package com.codingchili.core.benchmarking

Interface BenchmarkReport

All Known Implementing Classes:
BenchmarkConsoleReport, BenchmarkHTMLReport
public interface BenchmarkReport
Interface for benchmarking report creation.

  • Method Details

    • template

      BenchmarkReport template​(String string)
      Sets the template to use. May be a path to a file or a template.
      Parameters:
      string - path or template to use
      Returns:
      fluent

    • display

      BenchmarkReport display()
      displays the results of the report by opening the browser, printing to terminal or any other means specified by the implementation.
      Returns:
      fluent

    • saveTo

      BenchmarkReport saveTo​(String path)
      saves the results to file.
      Parameters:
      path - where the report is written
      Returns:
      fluent

    • saveToFile

      String saveToFile()
      saves the report to file using a generated filename.
      Returns:
      path to the report file that was saved