com.appperfect.codeanalyzer.engine.rules
Interface IConfigurableRule

All Superinterfaces:

IRule

public interface IConfigurableRule

extends IRule

The configurable rules are the rules that need to read values specified through Rules Manager Dialog. The way this mechanism may be used is the rule class should define class fields of type RuleParameter for each parameter and pass it to the Rule Engine through method getRuleParameters() (return new RuleParameter[]{this.p1, this.p2}), then during evaluation of a rule i.e in evaluate() method, the rule may access values of those parameters by calling getValue() on that class field like pMax.getValue();

Version:

6.0

Author:

AppPerfect Corporation.

Method Summary

com.appperfect.codeanalyzer.engine.rules.RuleParameter[]

getRuleParameters() A configurable rules may specify its parameters through this method.

Methods inherited from interface com.appperfect.codeanalyzer.engine.rules.IRule

evaluate, getASTNodeTypes, reset

Method Detail

getRuleParameters

public com.appperfect.codeanalyzer.engine.rules.RuleParameter[] getRuleParameters()

A configurable rules may specify its parameters through this method.

Returns:

an array contining instance of RuleParameter class. Each object represents one rule parameter.