Package io.codemodder.codetf

Interface CodeTFReportGenerator

public interface CodeTFReportGenerator

This type is responsible for generating a CodeTFReport based on the domain objects representing our inputs and outputs.

Method Summary

Modifier and Type	Method	Description
static CodeTFReportGenerator	createDefault()
CodeTFReport	createReport(Path repositoryRoot, String commandLine, List<Path> sarifs, List<CodeTFResult> results, long millisElapsed)	Creates the report.

Method Detail

createReport

CodeTFReport createReport(Path repositoryRoot,
                          String commandLine,
                          List<Path> sarifs,
                          List<CodeTFResult> results,
                          long millisElapsed)
                   throws IOException

Creates the report.

Parameters:

repositoryRoot - the root directory of the repository

commandLine - the command line that was used to run the tool

sarifs - the sarif files that were used as input

results - the results of the scan/fix

millisElapsed - how long the scan/fix took

Returns:

the CodeTFReport representing all the stuff above

Throws:

IOException

createDefault

static CodeTFReportGenerator createDefault()