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

org.codenarc.analyzer
[Groovy] Class FilesystemSourceAnalyzer

java.lang.Object
  org.codenarc.analyzer.FilesystemSourceAnalyzer
All Implemented Interfaces:
SourceAnalyzer
class FilesystemSourceAnalyzer

SourceAnalyzer implementation that recursively processes files from the file system.

Authors:
Chris Mair
Version:
\$Revision: 602 \$ - \$Date: 2011-02-08 16:37:40 -0500 (Tue, 08 Feb 2011) \$

Property Summary
static def DEFAULT_INCLUDES

static def SEP

String baseDirectory

The base (root) directory.

String excludes

The ant-style pattern of files to exclude from the analysis.

String includes

The ant-style pattern of files to include in the analysis.

 
Method Summary
Results analyze(RuleSet ruleSet)

Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
List getSourceDirectories()

protected void initializeWildcardPatterns()

protected boolean matches(SourceCode sourceFile)

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

DEFAULT_INCLUDES

static final def DEFAULT_INCLUDES

SEP

static final def SEP

baseDirectory

String baseDirectory
The base (root) directory. Must not be null or empty.

excludes

String excludes
The ant-style pattern of files to exclude from the analysis. If null, exclude no files/directories. This pattern can optionally contain wildcards: '**', '*' and '?'. All file separators within paths are normalized to the standard '/' separator, so use the '/' separator within this pattern where necessary. Example: "**/*.groovy". If both includes and excludes are specified, then only files/directories that match at least one of the includes and none of the excludes are analyzed.

includes

String includes
The ant-style pattern of files to include in the analysis. Defaults to match all files with names ending with '.groovy'. If null, match all files/directories. This pattern can optionally contain wildcards: '**', '*' and '?'. All file separators within paths are normalized to the standard '/' separator, so use the '/' separator within this pattern where necessary. Example: "**/*.groovy". If both includes and excludes are specified, then only files/directories that match at least one of the includes and none of the excludes are analyzed.

 
Method Detail

analyze

Results analyze(RuleSet ruleSet)
Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
Parameters:
ruleset - - the RuleSet to apply to each of the (applicable) files in the source directories
Returns:
the results from applying the RuleSet to all of the files in the source directories

getSourceDirectories

List getSourceDirectories()

initializeWildcardPatterns

protected void initializeWildcardPatterns()

matches

protected boolean matches(SourceCode sourceFile)

 

Groovy Documentation