com.appperfect.codeanalyzer.engine.rules
Class RuleParameter

java.lang.Object
  |
  +--com.appperfect.codeanalyzer.engine.rules.RuleParameter

public final class RuleParameter

extends java.lang.Object

This class represents a parameter of a configurable rule. This class allows a custom rule to fetch latest parameter values while it is evaluated. The parameter values may be specified through the Rules Manager Dialog.

Version:

6.0

Author:

AppPerfect Corporation.

Field Summary

static com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type	BOOLEAN Constant indicating the data type of a Rule Parameter.
static com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type	INTEGER Constant indicating the data type of a Rule Parameter.
static com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type	STRING Constant indicating the data type of a Rule Parameter.

Constructor Summary

RuleParameter(java.lang.String name, com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type type, java.lang.Object oDefaultValue)
The constructor for a RuleParameter.

Method Summary

java.lang.String	getName() Used internally.
java.lang.Object	getValue() Allows a rule to access the current value of this Parameter during evaluation.
boolean	setValue(java.lang.Object value) Used internally.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTEGER

public static final com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type INTEGER

Constant indicating the data type of a Rule Parameter.

STRING

public static final com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type STRING

Constant indicating the data type of a Rule Parameter.

BOOLEAN

public static final com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type BOOLEAN

Constant indicating the data type of a Rule Parameter.

Constructor Detail

RuleParameter

public RuleParameter(java.lang.String name,
                     com.appperfect.codeanalyzer.engine.rules.RuleParameter.Type type,
                     java.lang.Object oDefaultValue)

The constructor for a RuleParameter.

Parameters:

name - the label that appears in the Rules Manager Dialog for this Rule Parameter.

type - data type of this rule either com.appperfect.common.IProductConstants.INTEGER, com.appperfect.common.IProductConstants.STRING or com.appperfect.common.IProductConstants.BOOLEAN.

oDefaultValue - initial value of this Parameter. This value is used as long as the new value is not provided through Rules Paramter Dialog.

Method Detail

getName

public java.lang.String getName()

Used internally.

Returns:

getValue

public java.lang.Object getValue()

Allows a rule to access the current value of this Parameter during evaluation. Returns the value as specified through Rules Manager Dialog.

Returns:

setValue

public boolean setValue(java.lang.Object value)

Used internally.

Returns: