Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.codenarc.analyzer
[Groovy] Interface SourceAnalyzer

interface SourceAnalyzer

The interface for objects that can analyze the source files within one or more directory trees using a specified RuleSet and produce report results.

Authors:
Chris Mair
Version:
\$Revision: 270 \$ - \$Date: 2010-01-02 16:06:39 -0500 (Sat, 02 Jan 2010) \$

Method Summary
Results analyze(RuleSet ruleSet)

Analyze all source code using the specified RuleSet and return the report results.
List getSourceDirectories()

Return the List of source directories to be analyzed.

 

Method Detail

analyze

Results analyze(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

List getSourceDirectories()
Return the List of source directories to be analyzed. May be empty; may not be null.

 

Groovy Documentation