org.myire.quill.scent

Interface ScentRunner

All Known Implementing Classes:

ScentRunnerImpl

public interface ScentRunner

A ScentRunner collects source code metrics from a collection of files using the Scent library, and writes an XML report with the collected metrics.

Method Summary

Modifier and Type	Method and Description
void	collectMetricsAsXml(java.util.Collection<java.io.File> pFiles, java.nio.charset.Charset pCharset, int pLanguageLevel, boolean pEnableLanguagePreviews, java.io.File pReportFile) Collect source code metrics from a collection of files and write an XML report.

Method Detail

collectMetricsAsXml

void collectMetricsAsXml(java.util.Collection<java.io.File> pFiles,
                         java.nio.charset.Charset pCharset,
                         int pLanguageLevel,
                         boolean pEnableLanguagePreviews,
                         java.io.File pReportFile)
                  throws java.io.IOException

Collect source code metrics from a collection of files and write an XML report.

Parameters:

pFiles - The files and/or directories to collect Java file metrics from.

pCharset - The charset the Java files are encoded in.

pLanguageLevel - The Java language level to use when parsing the source files. Pass 0 to use the default language level.

pEnableLanguagePreviews - If true, language feature previews at the specified language level will be enabled.

pReportFile - The file to write the XML report to.

Throws:

java.io.IOException - if writing the report file fails.

java.lang.NullPointerException - if any of the parameters is null.