eu.cqse.check.base

Class ThrowExceptionCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.EntityCheckBase

eu.cqse.check.base.EntityTokenCheckBase

eu.cqse.check.base.EntityTokenPatternCheckBase

eu.cqse.check.base.ThrowExceptionCheckBase

public abstract class ThrowExceptionCheckBase
extends EntityTokenPatternCheckBase

Base class for custom checks which reveal when exceptions are thrown.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
ThrowExceptionCheckBase()

Method Summary

Modifier and Type	Method and Description
abstract boolean	createFindingForException(java.lang.String className) Returns true if this check should create a finding for the thrown exception.
protected TokenPattern	getFindingPattern() Returns the pattern that the processed tokens are matched against.
protected java.lang.String	getXPathSelectionString() Returns the xPath string for selecting entities.
protected void	processEntity(ShallowEntity entity) Processes a single selected entity.
protected void	processTokens(java.util.List<IToken> tokens) Process the start or end tokens for a selected entity.
abstract boolean	skipMethod(ShallowEntity entity) Returns true if given method should be skipped from the check analysis.

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

getFindingMessage

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

execute, filterEntities

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

ThrowExceptionCheckBase

public ThrowExceptionCheckBase()

Method Detail

getXPathSelectionString

protected java.lang.String getXPathSelectionString()

Returns the xPath string for selecting entities.

Specified by:

getXPathSelectionString in class EntityCheckBase

getFindingPattern

protected 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 EntityTokenPatternCheckBase.getFindingMessage(List) and a finding will be created for them.

Specified by:

getFindingPattern in class EntityTokenPatternCheckBase

processEntity

protected void processEntity(ShallowEntity entity)
                      throws CheckException

Processes a single selected entity.

Overrides:

processEntity in class EntityTokenCheckBase

Throws:

CheckException

skipMethod

public abstract boolean skipMethod(ShallowEntity entity)

Returns true if given method should be skipped from the check analysis.

processTokens

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

Process the start or end tokens for a selected entity.

Overrides:

processTokens in class EntityTokenPatternCheckBase

Throws:

CheckException

createFindingForException

public abstract boolean createFindingForException(java.lang.String className)
                                           throws CheckException

Returns true if this check should create a finding for the thrown exception.

Throws:

CheckException