org.myire.quill.scent.impl

Class ScentRunnerImpl

java.lang.Object

org.myire.quill.scent.impl.ScentRunnerImpl

All Implemented Interfaces:

ScentRunner

public class ScentRunnerImpl
extends java.lang.Object
implements ScentRunner

Delegate class for running Scent and converting the collected metrics to XML. This class encapsulates all dependencies on the Scent library, making it possible to easily control when those classes are first referenced and loaded.

Constructor Summary

Constructors

Constructor and Description
ScentRunnerImpl()

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) Scan the directories and files in a collection of Java files, collect source code metrics for them, and create an XML report from the collected metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScentRunnerImpl

public ScentRunnerImpl()

Method Detail

collectMetricsAsXml

public 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

Scan the directories and files in a collection of Java files, collect source code metrics for them, and create an XML report from the collected metrics.

Specified by:

collectMetricsAsXml in interface ScentRunner

Parameters:

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

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.

pCharset - The charset the Java files are encoded with.

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.