eu.cqse.check.base

Class EntityCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.EntityCheckBase

Direct Known Subclasses:

AvoidObjectComparisonWithSelfCheckBase, AvoidStringFormatInLogStatementsBase, CatchExceptionCheckBase, EntityFindingCheckBase, EntityFirstLineFindingCheckBase, EntityTokenCheckBase, TokenTextSequenceCheckBase

public abstract class EntityCheckBase
extends CheckImplementationBase

Base class for checks, that select a set of entities via xPath and inspect each of these. Subclasses must use the ECheckParameter.ABSTRACT_SYNTAX_TREE parameter.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
EntityCheckBase()

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the custom check with the given context.
protected java.util.List<ShallowEntity>	filterEntities(java.util.List<ShallowEntity> entities) Filters the selected entities.
protected abstract java.lang.String	getXPathSelectionString() Returns the xPath string for selecting entities.
protected abstract void	processEntity(ShallowEntity entity) Processes a single selected entity.

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

EntityCheckBase

public EntityCheckBase()

Method Detail

execute

public void execute()
             throws CheckException

Executes the custom check with the given context.

Specified by:

execute in class CheckImplementationBase

Throws:

CheckException

filterEntities

protected java.util.List<ShallowEntity> filterEntities(java.util.List<ShallowEntity> entities)

Filters the selected entities. The default implementation returns all selected entities.

getXPathSelectionString

protected abstract java.lang.String getXPathSelectionString()

Returns the xPath string for selecting entities.

processEntity

protected abstract void processEntity(ShallowEntity entity)
                               throws CheckException

Processes a single selected entity.

Throws:

CheckException