CodeNarcRunner (CodeNarc 3.0.0 API)

org.codenarc.CodeNarcRunner

```
class CodeNarcRunner
extends java.lang.Object
```
Helper class to run CodeNarc.
The following properties must be configured before invoking the execute() method:
- ruleSetFiles - The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a single file path, or multiple paths separated by commas.
- sourceAnalyzer - An instance of a org.codenarc.analyzer.SourceAnalyzer implementation.
- reportWriters - The list of ReportWriter instances. A report is generated for each element in this list. At least one ReportWriter must be configured.
NOTE: This is an internal class. Its API is subject to change.
Authors:
Chris Mair

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`PLUGINS_PROPERTY`
`static java.lang.String`	`STANDARD_PLUGIN_CLASSES`
`protected java.util.List<CodeNarcPlugin>`	`plugins`
`protected RuleSetConfigurer`	`ruleSetConfigurer`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`propertiesFilename`
`java.util.List<ReportWriter>`	`reportWriters`
`java.lang.String`	`ruleSetFiles`
`java.lang.String`	`ruleSetString`
`SourceAnalyzer`	`sourceAnalyzer`

Constructor Summary

Constructors
Constructor and description
`CodeNarcRunner ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected RuleSet`	`createInitialRuleSet()` Create and return the RuleSet that provides the source of Rules to be applied.
	`Results`	`execute()` The main entry point for this class.
	`java.util.List<CodeNarcPlugin>`	`getPlugins()`
	`void`	`registerPlugin(CodeNarcPlugin plugin)`
	`void`	`registerPluginsForClassNames(java.lang.String pluginClassNames)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String PLUGINS_PROPERTY
  - public static final java.lang.String STANDARD_PLUGIN_CLASSES
  - protected final java.util.List<CodeNarcPlugin> plugins
  - protected RuleSetConfigurer ruleSetConfigurer
- Property Detail
  - java.lang.String propertiesFilename
  - java.util.List<ReportWriter> reportWriters
  - java.lang.String ruleSetFiles
  - java.lang.String ruleSetString
  - SourceAnalyzer sourceAnalyzer
- Constructor Detail
  - CodeNarcRunner()
- Method Detail
  - protected RuleSet createInitialRuleSet()
    
    Create and return the RuleSet that provides the source of Rules to be applied. The returned RuleSet may aggregate multiple underlying RuleSets.
    Returns:
    a single RuleSet
  - @java.lang.SuppressWarnings(value: Println) Results execute()
    
    The main entry point for this class. Runs CodeNarc and returns the results. Processing steps include:
    1. Register standard CodeNarcPlugins.
    2. Register any CodeNarcPlugins specified by the "org.codenarc.plugins" system property.
    3. Call initialize() for each registered CodeNarcPlugin.
    4. Parse the ruleSetFiles or ruleSetString property to create a RuleSet. - ruleSetFiles: Each path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute filesystem path), or "http:". If it is a URL, its path may be optionally URL-encoded. That can be useful if the path contains any problematic characters, such as comma (',') or hash ('#'). See URLEncoder#encode(java.lang.String, java.lang.String). - ruleSetString: string containing a ruleSet in JSON format (if set, ruleSetFiles will be ignored)
    5. Call processRules(List) for each registered CodeNarcPlugin
    6. Call PropertiesFileRuleSetConfigurer to configure the RuleSet from the "codenarc.properties" file (or propertiesFilename if set).
    7. Apply the configured SourceAnalyzer.
    8. Call processViolationsForFile(FileViolations) for each file with violations
    9. Call processReports(List) for each registered CodeNarcPlugin
    10. Generate a report for each configured ReportWriter.
    11. Return the Results object representing the analysis results.
    returns:
    the Results object containing the results of the CodeNarc analysis.
  - java.util.List<CodeNarcPlugin> getPlugins()
  - void registerPlugin(CodeNarcPlugin plugin)
  - void registerPluginsForClassNames(java.lang.String pluginClassNames)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class CodeNarcRunner

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String PLUGINS_PROPERTY

public static final java.lang.String STANDARD_PLUGIN_CLASSES

protected final java.util.List<CodeNarcPlugin> plugins

protected RuleSetConfigurer ruleSetConfigurer

Property Detail

java.lang.String propertiesFilename

java.util.List<ReportWriter> reportWriters

java.lang.String ruleSetFiles

java.lang.String ruleSetString

SourceAnalyzer sourceAnalyzer

Constructor Detail

CodeNarcRunner()

Method Detail

protected RuleSet createInitialRuleSet()

@java.lang.SuppressWarnings(value: Println) Results execute()

java.util.List<CodeNarcPlugin> getPlugins()

void registerPlugin(CodeNarcPlugin plugin)

void registerPluginsForClassNames(java.lang.String pluginClassNames)