eu.cqse.check.base

Class UnwantedExpressionInCommentCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.CommentCheckBase

eu.cqse.check.base.UnwantedExpressionInCommentCheckBase

public abstract class UnwantedExpressionInCommentCheckBase
extends CommentCheckBase

Base class for checks which find unwanted expressions in any comment in a resource.

Field Summary

Fields inherited from class eu.cqse.check.framework.core.CheckImplementationBase

context

Constructor Summary

Constructors

Constructor and Description
UnwantedExpressionInCommentCheckBase()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getFindingText(IToken token, java.util.regex.MatchResult matchResult) Gets the text for the finding.
protected abstract java.util.regex.Pattern	getUnwantedRegex() Provides the Regex pattern that specifies which expressions are unwanted in comments.
void	initialize() Initializes the custom check.
protected void	processComment(IToken token, int startLine, int endLine) When implemented in a subclass, processes the specified comment token, which runs from the provided start line to the provided end line.

Methods inherited from class eu.cqse.check.base.CommentCheckBase

execute

Methods inherited from class eu.cqse.check.framework.core.CheckImplementationBase

createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFindingForSiblingEntities, createFindingForSiblings, createFindingOnFirstLine, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createInstance, createSelectionPattern, getCodeViewOption, isCpp, select, select, selectUnfilteredPreProcessed, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UnwantedExpressionInCommentCheckBase

public UnwantedExpressionInCommentCheckBase()

Method Detail

initialize

public void initialize()
                throws CheckException

Initializes the custom check. This is called after the parameters have been set, but before the check is executed and before the context is set. This method is called only once for a batch of files that need to be analyzed. Since the context is file-specific it can't be accessed here. This method is intended for preprocessing or parsing of the parameters.

Overrides:

initialize in class CheckImplementationBase

Throws:

CheckException - can be thrown by subclasses

processComment

protected void processComment(IToken token,
                              int startLine,
                              int endLine)
                       throws CheckException

When implemented in a subclass, processes the specified comment token, which runs from the provided start line to the provided end line.

Specified by:

processComment in class CommentCheckBase

Parameters:

token - the comment token to process

startLine - the 1-based start line of the comment token in the analyzed resource.

endLine - the 1-based end line of the comment token in the analyzed resource.

Throws:

CheckException

getUnwantedRegex

protected abstract java.util.regex.Pattern getUnwantedRegex()

Provides the Regex pattern that specifies which expressions are unwanted in comments. Note that this method is only called once at the initialization of the check for performance reasons.

getFindingText

protected abstract java.lang.String getFindingText(IToken token,
                                                   java.util.regex.MatchResult matchResult)

Gets the text for the finding.

Parameters:

token - The token where the unwanted pattern was found.

matchResult - The MatchResult which allows providing more details in the findings text.

Returns:

The finding text.