Package org.jboss.windup.config.metadata

Interface RulesetMetadata

All Known Subinterfaces:

RuleProviderMetadata

All Known Implementing Classes:

AbstractRulesetMetadata, MetadataBuilder

public interface RulesetMetadata

Each Addon that contains RuleProvider implementations should implement this interface, and by doing so provide some basic metadata about its contents.

Author:

Jess Sightler , Lincoln Baxter, III

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a human-readable description the rules associated with this RulesetMetadata.
String	getID()	Returns a unique identifier for the corresponding RuleProvider.
String	getOrigin()	Returns a descriptive String, informing a human where they can find the Rule instances provided by this RuleProvider.
Set<org.jboss.forge.furnace.addons.AddonId>	getRequiredAddons()	Return the Set of Addons required to run this rule-set.
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.
boolean	hasTags(String tag, String... tags)	Return true if this RulesetMetadata contains all of the given tags.

Method Detail

getID

String getID()

Returns a unique identifier for the corresponding RuleProvider. The default is based on the originating Addon and Class name, but this can be overridden in subclasses to provide a more readable name.

getOrigin

String getOrigin()

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

getDescription

String getDescription()

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

getTags

Set<String> getTags()

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

hasTags

boolean hasTags(String tag,
                String... tags)

Return true if this RulesetMetadata contains all of the given tags.

getSourceTechnologies

Set<TechnologyReference> getSourceTechnologies()

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

getTargetTechnologies

Set<TechnologyReference> getTargetTechnologies()

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

getRequiredAddons

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

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.)