eu.cqse.check.framework.core

Interface IFindingDescriptionModifyingCheck

public interface IFindingDescriptionModifyingCheck

Interface for Custom Checks that modify the description of their findings based on the check options.

Implementers must also extend CheckImplementationBase.

Method Summary

Modifier and Type	Method and Description
java.lang.String	computeUpdatedFindingDescription() Allows to override the default finding description (the default is the string given in the "description" field of the Check annotation) based on the check options.

Method Detail

computeUpdatedFindingDescription

java.lang.String computeUpdatedFindingDescription()

Allows to override the default finding description (the default is the string given in the "description" field of the Check annotation) based on the check options. This can be used to reflect complex check-option values in the FindingDetailsPage if they can't be properly included in the finding message. The finding description is the same for all findings of a given custom check in a given project. When this method is called, the check options are initialized and CheckImplementationBase.initialize() has been called.

Returns:

The new finding description, enriched based on check-option values.