org.myire.quill.cpd

Interface CpdRunner

All Known Implementing Classes:

CpdRunnerImpl

public interface CpdRunner

A CpdRunner performs copy-paste analysis on a collection of files using the CPD tool, and writes a report with the result of the analysis.

Method Summary

Modifier and Type	Method and Description
void	runCpd(java.util.Collection<java.io.File> pFiles, java.io.File pReportFile, java.lang.String pReportFormat, CpdParameters pParameters) Perform copy-paste analysis on a collection of files and write a report with the result.

Method Detail

runCpd

void runCpd(java.util.Collection<java.io.File> pFiles,
            java.io.File pReportFile,
            java.lang.String pReportFormat,
            CpdParameters pParameters)
     throws java.io.IOException

Perform copy-paste analysis on a collection of files and write a report with the result.

Parameters:

pFiles - The files to analyze.

pReportFile - The file to write the report to.

pReportFormat - The format of the report, see CpdReports.

pParameters - The parameters to configure CPD with.

Throws:

java.io.IOException - if accessing the files to analyze fails, or if the report cannot be written.