org.jboss.windup.config.metadata

Interface RuleProviderMetadata

All Superinterfaces:

RulesetMetadata

All Known Implementing Classes:

MetadataBuilder

public interface RuleProviderMetadata
extends RulesetMetadata

Describes RuleProvider instances.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
List<Class<? extends RuleProvider>>	getExecuteAfter() Returns a list of RuleProvider classes that should execute before the Rule instances in this corresponding RuleProvider .
List<String>	getExecuteAfterIDs() Returns a list of the RuleProvider classes that should execute before the Rules in this RuleProvider.
List<Class<? extends RuleProvider>>	getExecuteBefore() Returns a list of RuleProvider classes that should execute after the Rules in this RuleProvider.
List<String>	getExecuteBeforeIDs() Returns a list of the RuleProvider classes that should execute after the Rules in this RuleProvider.
Class<? extends RulePhase>	getPhase() Return the RulePhase in which Rule instances from this RuleProvider should be executed.
RulesetMetadata	getRulesetMetadata() Returns the RulesetMetadata, if any, for the rule-set from which this RuleProviderMetadata originated.
Class<? extends RuleProvider>	getType() Returns the Class of the corresponding RuleProvider.
boolean	isDisabled() If true, Windup will skip running this RuleProvider.
boolean	isHaltOnException() Whether Windup should stop execution if this provider's rule execution ends with an exception.
boolean	isOverrideProvider() Indicates whether or not the rules in this provider should override other rules.

Methods inherited from interface org.jboss.windup.config.metadata.RulesetMetadata

getDescription, getID, getOrigin, getRequiredAddons, getSourceTechnologies, getTags, getTargetTechnologies, hasTags

Method Detail

getType

Class<? extends RuleProvider> getType()

Returns the Class of the corresponding RuleProvider.

getRulesetMetadata

RulesetMetadata getRulesetMetadata()

Returns the RulesetMetadata, if any, for the rule-set from which this RuleProviderMetadata originated.

getPhase

Class<? extends RulePhase> getPhase()

Return the RulePhase in which Rule instances from this RuleProvider should be executed.

The default phase is MigrationRulesPhase.

getExecuteAfter

List<Class<? extends RuleProvider>> getExecuteAfter()

Returns a list of RuleProvider classes that should execute before the Rule instances in this corresponding RuleProvider . RuleProviders can also be specified based on id (getExecuteAfterIDs()).

getExecuteAfterIDs

List<String> getExecuteAfterIDs()

Returns a list of the RuleProvider classes that should execute before the Rules in this RuleProvider. This is returned as a list of Rule IDs in order to support extensions that cannot depend on each other via class names. For example, in the case of the Groovy rules extension, a single class covers many rules with their own IDs. For specifying Java-based rules, getExecuteAfter() is preferred.

getExecuteBefore

List<Class<? extends RuleProvider>> getExecuteBefore()

Returns a list of RuleProvider classes that should execute after the Rules in this RuleProvider. RuleProviders can also be specified based on id (getExecuteBeforeIDs()).

getExecuteBeforeIDs

List<String> getExecuteBeforeIDs()

Returns a list of the RuleProvider classes that should execute after the Rules in this RuleProvider. This is returned as a list of Rule IDs in order to support extensions that cannot depend on each other via Class names. For example, in the case of the Groovy rules extension, a single class covers many rules with their own IDs. For specifying Java-based rules, getExecuteBefore() is preferred.

isHaltOnException

boolean isHaltOnException()

Whether Windup should stop execution if this provider's rule execution ends with an exception. By default, the exceptions are only logged and the failing rule appears in report. The rule itself is responsible for handling exceptions and storing them into the graph.

isOverrideProvider

boolean isOverrideProvider()

Indicates whether or not the rules in this provider should override other rules. If this ruleprovider has the same ID as another rule provider, then any rules in this provider will override rules from that base rule provider that have the same id.

isDisabled

boolean isDisabled()

If true, Windup will skip running this RuleProvider. Meant for development purposes.