eu.cqse.check.base

Class CommentCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.CommentCheckBase

Direct Known Subclasses:

UnwantedExpressionInCommentCheckBase

public abstract class CommentCheckBase
extends CheckImplementationBase

Base class for checks which inspects all comments in a resource.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
CommentCheckBase()

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the custom check with the given context.
protected abstract 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.framework.core.CheckImplementationBase

createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFindingForSiblingEntities, createFindingForSiblings, createFindingOnFirstLine, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createInstance, createSelectionPattern, getCodeViewOption, initialize, 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

CommentCheckBase

public CommentCheckBase()

Method Detail

execute

public void execute()
             throws CheckException

Executes the custom check with the given context.

Specified by:

execute in class CheckImplementationBase

Throws:

CheckException

processComment

protected abstract 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.

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