FilesystemSourceAnalyzer (CodeNarc 3.0.0 API)

org.codenarc.analyzer.FilesystemSourceAnalyzer

```
class FilesystemSourceAnalyzer
extends AbstractSourceAnalyzer
```
SourceAnalyzer implementation that recursively processes files from the file system.
Authors:
Chris Mair

Inherited fields
Fields inherited from class	Fields
`class AbstractSourceAnalyzer`	`ruleProcessingTimes`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`baseDirectory` The base (root) directory.
`java.lang.String`	`excludes` The ant-style pattern of files to exclude from the analysis.
`boolean`	`failOnError` Whether to throw an exception if errors occur parsing source files (true), or just log the errors (false)
`java.lang.String`	`includes` The ant-style pattern of files to include in the analysis.

Constructor Summary

Constructors
Constructor and description
`FilesystemSourceAnalyzer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Results`	`analyze(RuleSet ruleSet)` Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
	`java.util.List`	`getSourceDirectories()`
	`protected void`	`initializeWildcardPatterns()`
	`protected boolean`	`matches(SourceCode sourceFile)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractSourceAnalyzer`	`collectViolations, measureRuleProcessingTime, printRuleProcessingTimes`

- Property Detail
  - java.lang.String baseDirectory
    
    The base (root) directory. Must not be null or empty.
  - java.lang.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.
  - boolean failOnError
    
    Whether to throw an exception if errors occur parsing source files (true), or just log the errors (false)
  - java.lang.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.
- Constructor Detail
  - FilesystemSourceAnalyzer()
- Method Detail
  - @java.lang.Override 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
  - @java.lang.Override java.util.List getSourceDirectories()
  - protected void initializeWildcardPatterns()
  - protected boolean matches(SourceCode sourceFile)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class FilesystemSourceAnalyzer

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String baseDirectory

java.lang.String excludes

boolean failOnError

java.lang.String includes

Constructor Detail

FilesystemSourceAnalyzer()

Method Detail

@java.lang.Override Results analyze(RuleSet ruleSet)

@java.lang.Override java.util.List getSourceDirectories()

protected void initializeWildcardPatterns()

protected boolean matches(SourceCode sourceFile)