eu.cqse.check.base

Class EntityTokenSequenceFindingCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.EntityCheckBase

eu.cqse.check.base.EntityTokenCheckBase

eu.cqse.check.base.EntityTokenSequenceFindingCheckBase

public abstract class EntityTokenSequenceFindingCheckBase
extends EntityTokenCheckBase

Base class for checks that create findings on occurrences of token sequences.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
EntityTokenSequenceFindingCheckBase()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getFindingMessage(java.util.List<IToken> tokens, int matchStart, int matchEnd) Returns a finding message for the given token type sequence.
protected abstract ETokenType[]	getFindingSequence() Returns the token type sequence for which findings should be created.
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

EntityTokenSequenceFindingCheckBase

public EntityTokenSequenceFindingCheckBase()

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

getFindingSequence

protected abstract ETokenType[] getFindingSequence()

Returns the token type sequence for which findings should be created.

getFindingMessage

protected abstract java.lang.String getFindingMessage(java.util.List<IToken> tokens,
                                                      int matchStart,
                                                      int matchEnd)

Returns a finding message for the given token type sequence. The sequence contains the tokens from matchStart inclusively to matchEnd exclusively.