org.codenarc.rule

Interface Rule

All Known Implementing Classes:

AbstractAstVisitorRule, AbstractRule, AbstractSharedAstVisitorRule

public interface Rule

Represents a source code analysis rule .

Author:

Chris Mair

Method Summary

Modifier and Type	Method and Description
List<Violation>	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<Violation> applyTo(SourceCode sourceCode)
                 throws 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:

Throwable - could throw anything

getPriority

int getPriority()

Returns:

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

getName

String getName()

Returns:

the unique id for this rule