eu.cqse.check.clike

Class CatchExceptionCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.EntityCheckBase

eu.cqse.check.clike.CatchExceptionCheckBase

public abstract class CatchExceptionCheckBase
extends EntityCheckBase

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

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
CatchExceptionCheckBase()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	createFindingForException(java.util.Optional<java.lang.String> className) Returns true if this check should create a finding for the catched exception.
protected abstract java.lang.String	getFindingMessage(java.util.Optional<java.lang.String> className) Creates a message for a finding with the given exception class name.
protected java.lang.String	getXPathSelectionString() Returns the xPath string for selecting entities.
protected void	processEntity(ShallowEntity entity) Processes a single selected entity.

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

CatchExceptionCheckBase

public CatchExceptionCheckBase()

Method Detail

getXPathSelectionString

protected java.lang.String getXPathSelectionString()

Description copied from class: EntityCheckBase

Returns the xPath string for selecting entities.

Specified by:

getXPathSelectionString in class EntityCheckBase

processEntity

protected void processEntity(ShallowEntity entity)
                      throws CheckException

Processes a single selected entity. Determines whether the catch block at the ShallowEntity contains a forbidden exception.

Specified by:

processEntity in class EntityCheckBase

Throws:

CheckException

createFindingForException

protected abstract boolean createFindingForException(java.util.Optional<java.lang.String> className)
                                              throws CheckException

Returns true if this check should create a finding for the catched exception. Class name may be empty in anonymous catch blocks.

Throws:

CheckException

getFindingMessage

protected abstract java.lang.String getFindingMessage(java.util.Optional<java.lang.String> className)

Creates a message for a finding with the given exception class name. Class name may be empty in anonymous catch blocks.