org.codenarc.rule

Interface Rule

All Known Implementing Classes:

AbstractAstVisitorRule, AbstractRule, AbstractSharedAstVisitorRule

public interface Rule

Represents a source code analysis rule .

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<org.codenarc.rule.Violation>	applyTo(org.codenarc.source.SourceCode sourceCode) Apply this rule to the specified source and return a list of violations (or an empty List)
int	getCompilerPhase()
java.lang.String	getName()
int	getPriority()

Method Detail

applyTo

java.util.List<org.codenarc.rule.Violation> applyTo(org.codenarc.source.SourceCode sourceCode)
                                                    throws java.lang.Throwable

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

Parameters:

sourceCode - - the source to apply this rule to

Returns:

the List of violations; may be empty

Throws:

java.lang.Throwable - could throw anything

getPriority

int getPriority()

Returns:

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

getName

java.lang.String getName()

Returns:

the unique id for this rule

getCompilerPhase

int getCompilerPhase()

Returns:

the required compiler phase (as in Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)