org.jboss.windup.config.metadata

Class MetadataBuilder

java.lang.Object

org.jboss.windup.config.metadata.AbstractRulesetMetadata

org.jboss.windup.config.metadata.MetadataBuilder

All Implemented Interfaces:

RuleProviderMetadata, RulesetMetadata

public class MetadataBuilder
extends AbstractRulesetMetadata
implements RuleProviderMetadata

Fluent builder for creating RuleProviderMetadata instances. Provides sensible defaults using given required values.

If RulesetMetadata is available in the Addon in which this MetadataBuilder was constructed, this will inherit values from RulesetMetadata for getTags(), getSourceTechnologies(), getTargetTechnologies() and getRequiredAddons().

Inherited metadata is specified by setRulesetMetadata(RulesetMetadata), and is typically performed by the RuleProviderLoader implementation.

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field and Description
static Class<? extends RulePhase>	DEFAULT_PHASE

Method Summary

Modifier and Type	Method and Description
MetadataBuilder	addExecuteAfter(Class<? extends RuleProvider> type) Ad an entry to the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	addExecuteAfterId(String id) Add an entry to the list of the RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	addExecuteBefore(Class<? extends RuleProvider> type) Ad an entry to the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	addExecuteBeforeId(String id) Add to the list of the RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	addRequiredAddon(org.jboss.forge.furnace.addons.AddonId reference) Add to the Set of Addons required to run this rule-set.
MetadataBuilder	addSourceTechnology(TechnologyReference reference) Add to the Set of source TechnologyReference instances to which this RuleProvider is related.
MetadataBuilder	addTag(String tag)
MetadataBuilder	addTags(String tag, String... tags) Add to the Set of tags by which this RulesetMetadata is classified.
MetadataBuilder	addTargetTechnology(TechnologyReference reference) Add to the Set of target TechnologyReference instances to which this RuleProvider is related.
boolean	equals(Object o)
static MetadataBuilder	forProvider(Class<? extends RuleProvider> implementationType) Create a new RuleProviderMetadata builder instance for the given RuleProvider type, using the provided parameters and RulesetMetadata to seed sensible defaults.
static MetadataBuilder	forProvider(Class<? extends RuleProvider> implementationType, String providerId) Create a new RuleProviderMetadata builder instance for the given RuleProvider type, and String ID, using the provided parameters and RulesetMetadata to seed sensible defaults.
String	getDescription() Returns a human-readable description the rules associated with this RulesetMetadata.
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.
String	getOrigin() Returns a descriptive String, informing a human where they can find the Rule instances provided by this RuleProvider.
Class<? extends RulePhase>	getPhase() Return the RulePhase in which Rule instances from this RuleProvider should be executed.
Set<org.jboss.forge.furnace.addons.AddonId>	getRequiredAddons() Return the Set of Addons required to run this rule-set.
RulesetMetadata	getRulesetMetadata() Returns the RulesetMetadata, if any, for the rule-set from which this RuleProviderMetadata originated.
Set<TechnologyReference>	getSourceTechnologies() Return the Set of source TechnologyReference instances to which this RuleProvider is related.
Set<String>	getTags() Return the Set of tags by which this RulesetMetadata is classified.
Set<TechnologyReference>	getTargetTechnologies() Return the Set of target TechnologyReference instances to which this RuleProvider is related.
Class<? extends RuleProvider>	getType() Returns the Class of the corresponding RuleProvider.
int	hashCode()
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.
MetadataBuilder	setDescription(String description) Sets the human readable description.
MetadataBuilder	setExecuteAfter(List<Class<? extends RuleProvider>> executeAfter) Set the list of RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	setExecuteAfterIDs(List<String> executeAfterIDs) Set the list of the RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	setExecuteBefore(List<Class<? extends RuleProvider>> executeBefore) Set the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	setExecuteBeforeIDs(List<String> executeBeforeIDs) Set the list of the RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.
MetadataBuilder	setHaltOnException(boolean haltOnException) Whether Windup should stop execution if this provider's rule execution ends with an exception.
MetadataBuilder	setOrigin(String origin) Set the descriptive information indicating where the corresponding RuleProvider instance is located (eg, a path to an XML file on disk, or an Addon coordinate and class name).
MetadataBuilder	setOverrideProvider(boolean overrideProvider) Sets whether or not this provider's rules should override rules from other providers with the same ID.
MetadataBuilder	setPhase(Class<? extends RulePhase> phase) Set the RulePhase in which the Rule instances from the corresponding RuleProvider instance should be executed.
MetadataBuilder	setRulesetMetadata(RulesetMetadata parent)
MetadataBuilder	setTags(List<String> tags) Set the tags by which this RulesetMetadata is classified.

Methods inherited from class org.jboss.windup.config.metadata.AbstractRulesetMetadata

getID, hasTags, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getID, hasTags

Field Detail

DEFAULT_PHASE

public static final Class<? extends RulePhase> DEFAULT_PHASE

Method Detail

forProvider

public static MetadataBuilder forProvider(Class<? extends RuleProvider> implementationType)

Create a new RuleProviderMetadata builder instance for the given RuleProvider type, using the provided parameters and RulesetMetadata to seed sensible defaults.

forProvider

public static MetadataBuilder forProvider(Class<? extends RuleProvider> implementationType,
                                          String providerId)

Create a new RuleProviderMetadata builder instance for the given RuleProvider type, and String ID, using the provided parameters and RulesetMetadata to seed sensible defaults.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRulesetMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRulesetMetadata

getType

public Class<? extends RuleProvider> getType()

Description copied from interface: RuleProviderMetadata

Returns the Class of the corresponding RuleProvider.

Specified by:

getType in interface RuleProviderMetadata

getRulesetMetadata

public RulesetMetadata getRulesetMetadata()

Description copied from interface: RuleProviderMetadata

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

Specified by:

getRulesetMetadata in interface RuleProviderMetadata

setRulesetMetadata

public MetadataBuilder setRulesetMetadata(RulesetMetadata parent)

isOverrideProvider

public boolean isOverrideProvider()

Description copied from interface: RuleProviderMetadata

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.

Specified by:

isOverrideProvider in interface RuleProviderMetadata

setOverrideProvider

public MetadataBuilder setOverrideProvider(boolean overrideProvider)

Sets whether or not this provider's rules should override rules from other providers with the same ID.

getOrigin

public String getOrigin()

Description copied from interface: RulesetMetadata

Returns a descriptive String, informing a human where they can find the Rule instances provided by this RuleProvider.

Specified by:

getOrigin in interface RulesetMetadata

Overrides:

getOrigin in class AbstractRulesetMetadata

setOrigin

public MetadataBuilder setOrigin(String origin)

Set the descriptive information indicating where the corresponding RuleProvider instance is located (eg, a path to an XML file on disk, or an Addon coordinate and class name).

getPhase

public Class<? extends RulePhase> getPhase()

Description copied from interface: RuleProviderMetadata

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

The default phase is MigrationRulesPhase.

Specified by:

getPhase in interface RuleProviderMetadata

setPhase

public MetadataBuilder setPhase(Class<? extends RulePhase> phase)

Set the RulePhase in which the Rule instances from the corresponding RuleProvider instance should be executed.

The default phase is MigrationRulesPhase.

getExecuteAfter

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

Description copied from interface: RuleProviderMetadata

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 (RuleProviderMetadata.getExecuteAfterIDs()).

Specified by:

getExecuteAfter in interface RuleProviderMetadata

setExecuteAfter

public MetadataBuilder setExecuteAfter(List<Class<? extends RuleProvider>> executeAfter)

Set the list of RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.

RuleProvider references can also be specified based on id (getExecuteAfterIDs()).

addExecuteAfter

public MetadataBuilder addExecuteAfter(Class<? extends RuleProvider> type)

Ad an entry to the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance. RuleProviders can also be specified based on id (getExecuteBeforeIDs()).

setDescription

public MetadataBuilder setDescription(String description)

Sets the human readable description.

getDescription

public String getDescription()

Description copied from interface: RulesetMetadata

Returns a human-readable description the rules associated with this RulesetMetadata.

Specified by:

getDescription in interface RulesetMetadata

Overrides:

getDescription in class AbstractRulesetMetadata

getExecuteAfterIDs

public List<String> getExecuteAfterIDs()

Description copied from interface: RuleProviderMetadata

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, RuleProviderMetadata.getExecuteAfter() is preferred.

Specified by:

getExecuteAfterIDs in interface RuleProviderMetadata

setExecuteAfterIDs

public MetadataBuilder setExecuteAfterIDs(List<String> executeAfterIDs)

Set the list of the RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.

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.

addExecuteAfterId

public MetadataBuilder addExecuteAfterId(String id)

Add an entry to the list of the RuleProvider classes that should execute before the Rule instances in the corresponding RuleProvider instance.

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

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

Description copied from interface: RuleProviderMetadata

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

Specified by:

getExecuteBefore in interface RuleProviderMetadata

setExecuteBefore

public MetadataBuilder setExecuteBefore(List<Class<? extends RuleProvider>> executeBefore)

Set the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance. RuleProviders can also be specified based on id (getExecuteBeforeIDs()).

addExecuteBefore

public MetadataBuilder addExecuteBefore(Class<? extends RuleProvider> type)

Ad an entry to the list of RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance. RuleProviders can also be specified based on id (getExecuteBeforeIDs()).

getExecuteBeforeIDs

public List<String> getExecuteBeforeIDs()

Description copied from interface: RuleProviderMetadata

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, RuleProviderMetadata.getExecuteBefore() is preferred.

Specified by:

getExecuteBeforeIDs in interface RuleProviderMetadata

setExecuteBeforeIDs

public MetadataBuilder setExecuteBeforeIDs(List<String> executeBeforeIDs)

Set the list of the RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.

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.

addExecuteBeforeId

public MetadataBuilder addExecuteBeforeId(String id)

Add to the list of the RuleProvider classes that should execute after the Rule instances in the corresponding RuleProvider instance.

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.

addTags

public MetadataBuilder addTags(String tag,
                               String... tags)

Add to the Set of tags by which this RulesetMetadata is classified.

Inherits from RulesetMetadata.getTags() if available.

addTag

public MetadataBuilder addTag(String tag)

getTags

public Set<String> getTags()

Description copied from interface: RulesetMetadata

Return the Set of tags by which this RulesetMetadata is classified.

Specified by:

getTags in interface RulesetMetadata

Overrides:

getTags in class AbstractRulesetMetadata

setTags

public MetadataBuilder setTags(List<String> tags)

Set the tags by which this RulesetMetadata is classified.

Inherits from RulesetMetadata.getTags() if available.

getSourceTechnologies

public Set<TechnologyReference> getSourceTechnologies()

Description copied from interface: RulesetMetadata

Return the Set of source TechnologyReference instances to which this RuleProvider is related.

Specified by:

getSourceTechnologies in interface RulesetMetadata

Overrides:

getSourceTechnologies in class AbstractRulesetMetadata

addSourceTechnology

public MetadataBuilder addSourceTechnology(TechnologyReference reference)

Add to the Set of source TechnologyReference instances to which this RuleProvider is related.

Inherits from RulesetMetadata.getSourceTechnologies() if available.

getTargetTechnologies

public Set<TechnologyReference> getTargetTechnologies()

Description copied from interface: RulesetMetadata

Return the Set of target TechnologyReference instances to which this RuleProvider is related.

Specified by:

getTargetTechnologies in interface RulesetMetadata

Overrides:

getTargetTechnologies in class AbstractRulesetMetadata

addTargetTechnology

public MetadataBuilder addTargetTechnology(TechnologyReference reference)

Add to the Set of target TechnologyReference instances to which this RuleProvider is related.

Inherits from RulesetMetadata.getTargetTechnologies() if available.

getRequiredAddons

public Set<org.jboss.forge.furnace.addons.AddonId> getRequiredAddons()

Description copied from interface: RulesetMetadata

Return the Set of Addons required to run this rule-set. (Note: This is typically only used in situations where rules are provided externally - such as XML - whereas in Java, the Addon will already define its dependencies on other addons directly.)

Specified by:

getRequiredAddons in interface RulesetMetadata

Overrides:

getRequiredAddons in class AbstractRulesetMetadata

addRequiredAddon

public MetadataBuilder addRequiredAddon(org.jboss.forge.furnace.addons.AddonId reference)

Add to the Set of Addons required to run this rule-set. (Note: This is typically only used in situations where rules are provided externally - such as XML - whereas in Java, the Addon will already define its dependencies on other addons directly.)

Inherits from RulesetMetadata.getRequiredAddons() if available.

setHaltOnException

public MetadataBuilder setHaltOnException(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.

isHaltOnException

public boolean isHaltOnException()

Description copied from interface: RuleProviderMetadata

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.

Specified by:

isHaltOnException in interface RuleProviderMetadata

isDisabled

public boolean isDisabled()

Description copied from interface: RuleProviderMetadata

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

Specified by:

isDisabled in interface RuleProviderMetadata