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

org.codenarc.ant
[Groovy] Class CodeNarcTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.codenarc.ant.CodeNarcTask

class CodeNarcTask
extends org.apache.tools.ant.Task

Ant Task for running CodeNarc.

The ruleSetFiles property specifies 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. It is required.

The maxPriority1Violations property specifies the maximum number of priority 1 violations allowed before failing the build (throwing a BuildException). Likewise, maxPriority2Violations and maxPriority3Violations specifiy the thresholds for violations of priority 2 and 3.

At least one nested fileset element is required, and is used to specify the source files to be analyzed. This is the standard Ant FileSet, and is quite powerful and flexible. See the Apache Ant Manual for more information on FileSets.

The report nested element defines the format and output file for the analysis report. Currently, HTML (type="html") and XML (type="xml") are the only supported formats. Each report is configured using nested option elements, with name, and value attributes.

Authors:
Chris Mair
Version:
\$Revision: 439 \$ - \$Date: 2010-11-08 15:16:30 -0500 (Mon, 08 Nov 2010) \$
See Also:

Field Summary
protected def createCodeNarcRunner

protected List fileSets

protected List reportWriters

protected def ruleSet

 
Property Summary
int maxPriority1Violations

int maxPriority2Violations

int maxPriority3Violations

String ruleSetFiles

The path to the Groovy or XML RuleSet definition files, relative to the classpath.

 
Method Summary
void addConfiguredReport(Report report)

Ant-defined method (by convention), called with each instance of a nested element within this task.
void addFileset(org.apache.tools.ant.types.FileSet fileSet)

protected SourceAnalyzer createSourceAnalyzer()

Create and return the SourceAnalyzer
void execute()

Execute this Ant Task
 
Methods inherited from class org.apache.tools.ant.Task
org.apache.tools.ant.Task#log(java.lang.String), org.apache.tools.ant.Task#log(java.lang.String, int), org.apache.tools.ant.Task#log(java.lang.Throwable, int), org.apache.tools.ant.Task#log(java.lang.String, java.lang.Throwable, int), org.apache.tools.ant.Task#init(), org.apache.tools.ant.Task#execute(), org.apache.tools.ant.Task#maybeConfigure(), org.apache.tools.ant.Task#getTaskName(), org.apache.tools.ant.Task#getOwningTarget(), org.apache.tools.ant.Task#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable), org.apache.tools.ant.Task#getTaskType(), org.apache.tools.ant.Task#setTaskType(java.lang.String), org.apache.tools.ant.Task#setTaskName(java.lang.String), org.apache.tools.ant.Task#setOwningTarget(org.apache.tools.ant.Target), org.apache.tools.ant.Task#getRuntimeConfigurableWrapper(), org.apache.tools.ant.Task#reconfigure(), org.apache.tools.ant.Task#perform(), org.apache.tools.ant.Task#bindToOwner(org.apache.tools.ant.Task), org.apache.tools.ant.Task#clone(), org.apache.tools.ant.Task#getLocation(), org.apache.tools.ant.Task#getDescription(), org.apache.tools.ant.Task#setLocation(org.apache.tools.ant.Location), org.apache.tools.ant.Task#getProject(), org.apache.tools.ant.Task#setDescription(java.lang.String), org.apache.tools.ant.Task#setProject(org.apache.tools.ant.Project), org.apache.tools.ant.Task#wait(long), org.apache.tools.ant.Task#wait(long, int), org.apache.tools.ant.Task#wait(), org.apache.tools.ant.Task#equals(java.lang.Object), org.apache.tools.ant.Task#toString(), org.apache.tools.ant.Task#hashCode(), org.apache.tools.ant.Task#getClass(), org.apache.tools.ant.Task#notify(), org.apache.tools.ant.Task#notifyAll()
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.ProjectComponent#clone(), org.apache.tools.ant.ProjectComponent#log(java.lang.String), org.apache.tools.ant.ProjectComponent#log(java.lang.String, int), org.apache.tools.ant.ProjectComponent#getLocation(), org.apache.tools.ant.ProjectComponent#getDescription(), org.apache.tools.ant.ProjectComponent#setLocation(org.apache.tools.ant.Location), org.apache.tools.ant.ProjectComponent#getProject(), org.apache.tools.ant.ProjectComponent#setDescription(java.lang.String), org.apache.tools.ant.ProjectComponent#setProject(org.apache.tools.ant.Project), org.apache.tools.ant.ProjectComponent#wait(long), org.apache.tools.ant.ProjectComponent#wait(long, int), org.apache.tools.ant.ProjectComponent#wait(), org.apache.tools.ant.ProjectComponent#equals(java.lang.Object), org.apache.tools.ant.ProjectComponent#toString(), org.apache.tools.ant.ProjectComponent#hashCode(), org.apache.tools.ant.ProjectComponent#getClass(), org.apache.tools.ant.ProjectComponent#notify(), org.apache.tools.ant.ProjectComponent#notifyAll()
 

Field Detail

createCodeNarcRunner

protected def createCodeNarcRunner

fileSets

protected List fileSets

reportWriters

protected List reportWriters

ruleSet

protected def ruleSet

 
Property Detail

maxPriority1Violations

int maxPriority1Violations

maxPriority2Violations

int maxPriority2Violations

maxPriority3Violations

int maxPriority3Violations

ruleSetFiles

String 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.

 
Method Detail

addConfiguredReport

void addConfiguredReport(Report report)
Ant-defined method (by convention), called with each instance of a nested element within this task.

addFileset

void addFileset(org.apache.tools.ant.types.FileSet fileSet)

createSourceAnalyzer

protected SourceAnalyzer createSourceAnalyzer()
Create and return the SourceAnalyzer
Returns:
a configured SourceAnalyzer instance

execute

void execute()
Execute this Ant Task

 

Groovy Documentation