Groovy Documentation

org.codenarc.rule
[Groovy] Interface Rule


interface Rule

Represents a source code analysis rule

Authors:
Chris Mair
Version:
\$Revision: 24 \$ - \$Date: 2009-01-31 07:47:09 -0500 (Sat, 31 Jan 2009) \$


Method Summary
List applyTo(SourceCode sourceCode)

Apply this rule to the specified source and return a list of violations (or an empty List)

String getName()

@return the unique id for this rule

int getPriority()

@return the priority of this rule; must be 1, 2 or 3

 

Method Detail

applyTo

List applyTo(SourceCode sourceCode)
Apply this rule to the specified source and return a list of violations (or an empty List)
Parameters:
source - - the source to apply this rule to
Returns:
the List of violations; may be empty


getName

String getName()
Returns:
the unique id for this rule


getPriority

int getPriority()
Returns:
the priority of this rule; must be 1, 2 or 3


 

Groovy Documentation