eu.cqse.check.base

Class TopLevelTypeCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.TopLevelTypeCheckBase

public abstract class TopLevelTypeCheckBase
extends CheckImplementationBase

Base class for checks that analyze top-level types.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
TopLevelTypeCheckBase()

Method Summary

Modifier and Type	Method and Description
protected abstract void	analyzeTopLevelTypes(java.util.List<ShallowEntity> topLevelTypeEntities) Analyzes the given top-level entities.
void	execute() Executes the custom check with the given context.
protected java.lang.String	getXPathTypeSelectionString() Returns the xPath selection string that is used to select all types.
protected abstract boolean	isTopLevelType(ShallowEntity typeEntity) Returns whether the given entity represents a top-level type.

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

TopLevelTypeCheckBase

public TopLevelTypeCheckBase()

Method Detail

execute

public void execute()
             throws CheckException

Executes the custom check with the given context.

Specified by:

execute in class CheckImplementationBase

Throws:

CheckException

getXPathTypeSelectionString

protected java.lang.String getXPathTypeSelectionString()

Returns the xPath selection string that is used to select all types.

analyzeTopLevelTypes

protected abstract void analyzeTopLevelTypes(java.util.List<ShallowEntity> topLevelTypeEntities)
                                      throws CheckException

Analyzes the given top-level entities.

Throws:

CheckException

isTopLevelType

protected abstract boolean isTopLevelType(ShallowEntity typeEntity)

Returns whether the given entity represents a top-level type.