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

org.codenarc.rule
Interface Rule

interface Rule

Represents a source code analysis rule

author:
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()

int getPriority()

 

Method Detail

applyTo

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

getName

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

getPriority

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

 

Groovy Documentation