org.jboss.windup.config.metadata

Class AbstractRulesetMetadata

java.lang.Object

org.jboss.windup.config.metadata.AbstractRulesetMetadata

All Implemented Interfaces:

RulesetMetadata

Direct Known Subclasses:

MetadataBuilder

public class AbstractRulesetMetadata
extends Object
implements RulesetMetadata

Base class for constructing RulesetMetadata instances. Provides sensible defaults.

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
AbstractRulesetMetadata(String id) Construct a new AbstractRulesetMetadata instance using the given String ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
int	hashCode()
boolean	hasTags(String tag, String... tags) Return true if this RulesetMetadata contains all of the given tags.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRulesetMetadata

public AbstractRulesetMetadata(String id)

Construct a new AbstractRulesetMetadata instance using the given String ID.

Method Detail

getID

public String getID()

Description copied from interface: RulesetMetadata

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.

Specified by:

getID in interface RulesetMetadata

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

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hasTags

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

Description copied from interface: RulesetMetadata

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

Specified by:

hasTags in interface RulesetMetadata

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

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

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

toString

public String toString()

Overrides:

toString in class Object