org.jboss.windup.config.metadata

Annotation Type RuleMetadata

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface RuleMetadata

A descriptor for RuleProvider metadata. Can be overridden by altering the RuleProviderMetadata directly.

Author:

Ondrej Zizka, Lincoln Baxter, III

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends RuleProvider>[]	after Returns a list of RuleProvider after which the Rule instances supplied by this RuleProvider should be executed.
String[]	afterIDs Returns a list of RuleProvider IDs after which the Rule instances supplied by this RuleProvider should be executed.
Class<? extends RuleProvider>[]	before Returns a list of RuleProvider before which the Rule instances supplied by this RuleProvider should be executed.
String[]	beforeIDs Returns a list of RuleProvider IDs before which the Rule instances supplied by this RuleProvider should be executed.
String	description Returns a human-readable text containing a description of the rules in this RuleProvider.
boolean	disabled If true, Windup will skip running this RuleProvider.
boolean	haltOnException Whether Windup should stop execution if this provider's rule execution ends with an exception.
String	id Returns a unique identifier for this particular RuleProvider.
boolean	overrideProvider Indicates whether or not the rules in this provider should override other rules.
String	perform String used to display the progress of rule execution to the user.
Class<? extends RulePhase>	phase Return the RulePhase in which the Rule instances from this RuleProvider should be executed.
Technology[]	sourceTechnologies A list of source technologies that the annotated rules pertain to.
String[]	tags The tags describing this RuleProvider.
Technology[]	targetTechnologies A list of target technologies that the annotated rules pertain to.

Element Detail

id

public abstract String id

Returns a unique identifier for this particular RuleProvider. The default is based on the Class name, but this can be overridden here - or in subclasses - to provide a more readable name.

Default:

""

description

public abstract String description

Returns a human-readable text containing a description of the rules in this RuleProvider.

Default:

""

perform

public abstract String perform

String used to display the progress of rule execution to the user.

Default:

""

phase

public abstract Class<? extends RulePhase> phase

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

The default phase is MigrationRulesPhase.

Default:

org.jboss.windup.config.phase.MigrationRulesPhase.class

after

public abstract Class<? extends RuleProvider>[] after

Returns a list of RuleProvider after which the Rule instances supplied by this RuleProvider should be executed.

Default:

{}

afterIDs

public abstract String[] afterIDs

Returns a list of RuleProvider IDs after which the Rule instances supplied by this RuleProvider should be executed.

This is returned as a list of RuleProvider IDs in order to support extensions that cannot depend on each other via class names.

Default:

{}

before

public abstract Class<? extends RuleProvider>[] before

Returns a list of RuleProvider before which the Rule instances supplied by this RuleProvider should be executed.

Default:

{}

beforeIDs

public abstract String[] beforeIDs

Returns a list of RuleProvider IDs before which the Rule instances supplied by this RuleProvider should be executed.

This is returned as a list of RuleProvider IDs in order to support extensions that cannot depend on each other via class names.

Default:

{}

tags

public abstract String[] tags

The tags describing this RuleProvider.

Default:

{}

sourceTechnologies

public abstract Technology[] sourceTechnologies

A list of source technologies that the annotated rules pertain to.

Default:

{}

targetTechnologies

public abstract Technology[] targetTechnologies

A list of target technologies that the annotated rules pertain to.

Default:

{}

haltOnException

public abstract boolean haltOnException

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.

Default:

false

overrideProvider

public abstract boolean overrideProvider

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.

Default:

false

disabled

public abstract boolean disabled

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

Default:

false