Skip navigation links

oracle.ide.extension.rules
Class RuleType

java.lang.Object
oracle.ide.extension.rules.RuleType

public final class RuleType

extends java.lang.Object

A RuleType instance represents a kind of rule. Each RuleType must have a unique identifier, a reference to a MetaClass that provides the rule implementation, and a reference to the Extension that introduced the rule type.

The RuleType also contains information about what parameters are supported on this kind of rule (if any).

Constructor Summary

RuleType(java.lang.String id, MetaClass<RuleFunction> implClass, Extension extension)
Constructs a RuleType.

Method Summary

boolean	addSupportedParameter(RuleTypeParameter parameter) Attempts to add a parameter to this rule-type definition, returns false if a parameter with the same name already existed.
Extension	getExtension()
java.lang.String	getId()
RuleFunction	getRuleFunction() Attempts to instantiate the RuleFunction class associated with this RuleType.
java.util.Collection<RuleTypeParameter>	getSupportedParameters()
boolean	hasRequiredParameters()
boolean	isParameterSupported(java.lang.String paramName)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleType

public RuleType(java.lang.String id,
                MetaClass<RuleFunction> implClass,
                Extension extension)

Constructs a RuleType. Each RuleType must have a unique identifier, a reference to a MetaClass that provides the rule implementation, and a reference to the Extension that introduced the rule type.

Parameters:

id -

implClass -

extension -

Method Detail

getId

public java.lang.String getId()

getExtension

public Extension getExtension()

getRuleFunction

public RuleFunction getRuleFunction()
                             throws RuleEvaluationException

Attempts to instantiate the RuleFunction class associated with this RuleType. A RuleEvaluationException will be thrown if the specified rule class cannot be instantiated, or if the extension that defined this rule-type is not fully loaded (evaluating a rule is not allowed to trigger fully loading an extension).

Returns:

Throws:

RuleEvaluationException

isParameterSupported

public boolean isParameterSupported(java.lang.String paramName)

getSupportedParameters

public java.util.Collection<RuleTypeParameter> getSupportedParameters()

hasRequiredParameters

public boolean hasRequiredParameters()

addSupportedParameter

public boolean addSupportedParameter(RuleTypeParameter parameter)

Attempts to add a parameter to this rule-type definition, returns false if a parameter with the same name already existed.

Parameters:

parameter -

Returns:

Skip navigation links