eu.cqse.check.base

Class EntityTokenPatternCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.EntityCheckBase

eu.cqse.check.base.EntityTokenCheckBase

eu.cqse.check.base.EntityTokenPatternCheckBase

Direct Known Subclasses:

ThrowExceptionCheckBase

public abstract class EntityTokenPatternCheckBase
extends EntityTokenCheckBase

Base class for tokens that create findings if a token pattern matches the processed tokens.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
EntityTokenPatternCheckBase()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getFindingMessage(java.util.List<IToken> tokens) Creates a finding messages for the given tokens.
protected abstract TokenPattern	getFindingPattern() Returns the pattern that the processed tokens are matched against.
protected void	processTokens(java.util.List<IToken> tokens) Process the start or end tokens for a selected entity.

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

processEntity

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

execute, filterEntities, getXPathSelectionString

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

EntityTokenPatternCheckBase

public EntityTokenPatternCheckBase()

Method Detail

processTokens

protected void processTokens(java.util.List<IToken> tokens)
                      throws CheckException

Process the start or end tokens for a selected entity.

Specified by:

processTokens in class EntityTokenCheckBase

Throws:

CheckException

getFindingPattern

protected abstract TokenPattern getFindingPattern()

Returns the pattern that the processed tokens are matched against. The pattern must define the group index 0 with TokenPattern.group(int). All tokens that are matched within this group are passed to getFindingMessage(List) and a finding will be created for them.

getFindingMessage

protected abstract java.lang.String getFindingMessage(java.util.List<IToken> tokens)

Creates a finding messages for the given tokens.