org.codenarc.rule

Class AbstractRule

java.lang.Object

org.codenarc.rule.AbstractRule

All Implemented Interfaces:

Rule

Direct Known Subclasses:

AbstractAstVisitorRule

public abstract class AbstractRule
extends java.lang.Object
implements Rule

Abstract superclass for Rules.

Each subclass must define an name property (String) and a priority property (integer 1..3).

Constructor Summary

Constructors

Constructor and Description
AbstractRule()

Method Summary

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).
abstract void	applyTo(org.codenarc.source.SourceCode sourceCode, java.util.List<org.codenarc.rule.Violation> violations) Apply this rule to the specified source and return a list of violations (or an empty List)
protected org.codenarc.rule.Violation	createViolation(java.lang.Integer lineNumber, java.lang.String sourceLine, java.lang.String message) Create and return a new Violation for this rule and the specified values
protected org.codenarc.rule.Violation	createViolation(org.codenarc.source.SourceCode sourceCode, org.codehaus.groovy.ast.ASTNode node, java.lang.String message) Create a new Violation for the AST node.
protected org.codenarc.rule.Violation	createViolationForImport(org.codenarc.source.SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode, java.lang.String message) Create and return a new Violation for this rule and the specified import
protected org.codenarc.rule.Violation	createViolationForImport(org.codenarc.source.SourceCode sourceCode, java.lang.String className, java.lang.String alias, java.lang.String violationMessage) Create and return a new Violation for this rule and the specified import className and alias
java.lang.String	getApplyToFileNames()
java.lang.String	getApplyToFilesMatching()
int	getCompilerPhase()
java.lang.String	getDescription()
java.lang.String	getDoNotApplyToFileNames()
java.lang.String	getDoNotApplyToFilesMatching()
abstract java.lang.String	getName()
abstract int	getPriority()
java.lang.String	getViolationMessage()
boolean	isEnabled()
boolean	isReady() Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.
void	setApplyToFileNames(java.lang.String applyToFileNames)
void	setApplyToFilesMatching(java.lang.String applyToFilesMatching)
void	setDescription(java.lang.String description)
void	setDoNotApplyToFileNames(java.lang.String doNotApplyToFileNames)
void	setDoNotApplyToFilesMatching(java.lang.String doNotApplyToFilesMatching)
void	setEnabled(boolean enabled)
abstract void	setName(java.lang.String name) Set the unique name for this rule
abstract void	setPriority(int priority) Set the priority for this rule
void	setViolationMessage(java.lang.String violationMessage)
java.lang.String	toString()
void	validate() Allows rules to perform validation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractRule

public AbstractRule()

Method Detail

getName

public abstract java.lang.String getName()

Specified by:

getName in interface Rule

Returns:

the unique name for this rule

setName

public abstract void setName(java.lang.String name)

Set the unique name for this rule

Parameters:

name - - the name for this rule; this should be unique

getPriority

public abstract int getPriority()

Specified by:

getPriority in interface Rule

Returns:

the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

setPriority

public abstract void setPriority(int priority)

Set the priority for this rule

Parameters:

priority - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

getCompilerPhase

public int getCompilerPhase()

Specified by:

getCompilerPhase in interface Rule

Returns:

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

applyTo

public abstract void applyTo(org.codenarc.source.SourceCode sourceCode,
                             java.util.List<org.codenarc.rule.Violation> violations)

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

violations - - the List of violations to which new violations from this rule are to be added

applyTo

public 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). This implementation delegates to the abstract applyCode(SourceCode,List), provided by concrete subclasses. This template method simplifies subclass implementations and also enables common handling of enablement logic.

Specified by:

applyTo in interface Rule

Parameters:

sourceCode - - the source to apply this rule to

Returns:

the List of violations; may be empty

Throws:

java.lang.Throwable - could throw anything

isReady

public boolean isReady()

Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied. Return true by default. This method is provided as a placeholder so subclasses can optionally override.

Returns:

true if all preconditions for this rule are satisfied

validate

public void validate()

Allows rules to perform validation. Do nothing by default. This method is provided as a placeholder so subclasses can optionally override. Subclasses will typically use assert calls to verify required preconditions.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createViolation

protected org.codenarc.rule.Violation createViolation(java.lang.Integer lineNumber,
                                                      java.lang.String sourceLine,
                                                      java.lang.String message)

Create and return a new Violation for this rule and the specified values

Parameters:

lineNumber - - the line number for the violation; may be null

sourceLine - - the source line for the violation; may be null

message - - the message for the violation; may be null

Returns:

a new Violation object

createViolation

protected org.codenarc.rule.Violation createViolation(org.codenarc.source.SourceCode sourceCode,
                                                      org.codehaus.groovy.ast.ASTNode node,
                                                      java.lang.String message)

Create a new Violation for the AST node.

Parameters:

sourceCode - - the SourceCode

node - - the Groovy AST Node

message - - the message for the violation; defaults to null

createViolationForImport

protected org.codenarc.rule.Violation createViolationForImport(org.codenarc.source.SourceCode sourceCode,
                                                               org.codehaus.groovy.ast.ImportNode importNode,
                                                               java.lang.String message)

Create and return a new Violation for this rule and the specified import

Parameters:

sourceCode - - the SourceCode

importNode - - the ImportNode for the import triggering the violation

Returns:

a new Violation object

createViolationForImport

protected org.codenarc.rule.Violation createViolationForImport(org.codenarc.source.SourceCode sourceCode,
                                                               java.lang.String className,
                                                               java.lang.String alias,
                                                               java.lang.String violationMessage)

Create and return a new Violation for this rule and the specified import className and alias

Parameters:

sourceCode - - the SourceCode

className - - the class name (as specified within the import statement)

alias - - the alias for the import statement

violationMessage - - the violation message; may be null

Returns:

a new Violation object

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getApplyToFilesMatching

public java.lang.String getApplyToFilesMatching()

setApplyToFilesMatching

public void setApplyToFilesMatching(java.lang.String applyToFilesMatching)

getDoNotApplyToFilesMatching

public java.lang.String getDoNotApplyToFilesMatching()

setDoNotApplyToFilesMatching

public void setDoNotApplyToFilesMatching(java.lang.String doNotApplyToFilesMatching)

getApplyToFileNames

public java.lang.String getApplyToFileNames()

setApplyToFileNames

public void setApplyToFileNames(java.lang.String applyToFileNames)

getDoNotApplyToFileNames

public java.lang.String getDoNotApplyToFileNames()

setDoNotApplyToFileNames

public void setDoNotApplyToFileNames(java.lang.String doNotApplyToFileNames)

getViolationMessage

public java.lang.String getViolationMessage()

setViolationMessage

public void setViolationMessage(java.lang.String violationMessage)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)