org.codenarc.ant

Class AntFileSetSourceAnalyzer

java.lang.Object

org.codenarc.analyzer.AbstractSourceAnalyzer

org.codenarc.ant.AntFileSetSourceAnalyzer

All Implemented Interfaces:

groovy.lang.GroovyObject, org.codenarc.analyzer.SourceAnalyzer

public class AntFileSetSourceAnalyzer
extends org.codenarc.analyzer.AbstractSourceAnalyzer

SourceAnalyzer implementation that gets source files from one or more Ant FileSets.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.apache.tools.ant.types.FileSet>	fileSets

Fields inherited from class org.codenarc.analyzer.AbstractSourceAnalyzer

ruleProcessingTimes

Constructor Summary

Constructors

Constructor and Description
AntFileSetSourceAnalyzer(org.apache.tools.ant.Project project, org.apache.tools.ant.types.FileSet fileSet) Construct a new instance on the specified Ant FileSet.

Method Summary

Modifier and Type	Method and Description
org.codenarc.results.Results	analyze(org.codenarc.ruleset.RuleSet ruleSet) Analyze all source code using the specified RuleSet and return the report results.
java.util.List	getSourceDirectories()

Methods inherited from class org.codenarc.analyzer.AbstractSourceAnalyzer

collectViolations, getMetaClass, getProperty, invokeMethod, measureRuleProcessingTime, printRuleProcessingTimes, setMetaClass, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

fileSets

protected final java.util.List<org.apache.tools.ant.types.FileSet> fileSets

Constructor Detail

AntFileSetSourceAnalyzer

public AntFileSetSourceAnalyzer(org.apache.tools.ant.Project project,
                                org.apache.tools.ant.types.FileSet fileSet)

Construct a new instance on the specified Ant FileSet.

Parameters:

project - - the Ant Project; must not be null

fileSet - - the Ant FileSet; must not be null

Method Detail

analyze

public org.codenarc.results.Results analyze(org.codenarc.ruleset.RuleSet ruleSet)

Analyze all source code using the specified RuleSet and return the report results.

Parameters:

ruleSet - - the RuleSet to apply to each source component; must not be null.

Returns:

the results from applying the RuleSet to all of the source

getSourceDirectories

public java.util.List getSourceDirectories()