eu.cqse.check.framework.core.ruleset

Interface IRulesetRule

All Known Implementing Classes:

EAutosarCpp14Rule, EMisraC2012Rule

public interface IRulesetRule

Functions to be provided by rules in a rule set.

Method Summary

Modifier and Type	Method and Description
void	contributeRules(java.util.function.BiConsumer<java.lang.String,java.lang.String> contributor) Allows to contribute rule mappings that are not custom checks.
java.lang.String	getRuleId() Returns a human readable rule id (e.g.
java.lang.String	getRuleText() Returns a readable name of description of the rule.

Method Detail

getRuleId

java.lang.String getRuleId()

Returns a human readable rule id (e.g. "M2-1-3") that is unique within the ruleset.

getRuleText

java.lang.String getRuleText()

Returns a readable name of description of the rule.

contributeRules

void contributeRules(java.util.function.BiConsumer<java.lang.String,java.lang.String> contributor)

Allows to contribute rule mappings that are not custom checks. See implementations for examples.

Parameters:

contributor - accepts the rule id and the name of the general check.