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

java.org.codenarc.rule
[Java] Interface Rule

public interface Rule

Represents a source code analysis rule .

Authors:
Chris Mair

Method Summary
List applyTo(SourceCode sourceCode)

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

@return the required compiler phase (as in org.codehaus.groovy.control.Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)
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

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

getCompilerPhase

public int getCompilerPhase()
Returns:
the required compiler phase (as in org.codehaus.groovy.control.Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)

getName

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

getPriority

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

 

Groovy Documentation