CodeNarcRunner (Groovy Documentation)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD

DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.codenarc
[Groovy] Class CodeNarcRunner

java.lang.Object
  org.codenarc.CodeNarcRunner

class CodeNarcRunner

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.

Version:: \$Revision: 619 \$ - \$Date: 2011-02-27 15:38:33 -0500 (Sun, 27 Feb 2011) \$

Method Summary
`protected RuleSet`	`createRuleSet()` Create and return the RuleSet that provides the source of Rules to be applied.
`Results`	`execute()` The main entry point for this class.

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

Property Detail

List reportWriters

String ruleSetFiles

SourceAnalyzer sourceAnalyzer

Method Detail

protected RuleSet createRuleSet()

Create and return the RuleSet that provides the source of Rules to be applied. The returned RuleSet may aggregate multiple underlying RuleSets.

Results execute()

The main entry point for this class. Runs CodeNarc and returns the results. Processing steps include:

Parse the ruleSetFiles property to create a RuleSet.
Configure the RuleSet from the "codenarc.properties" file, if that file is found on the classpath.
Apply the configured SourceAnalyzer.
Generate a report for each configured ReportWriter.
Return the Results object representing the analysis results.

returns:: the Results object containing the results of the CodeNarc analysis.

Groovy Documentation