org.jboss.windup.tooling.rules

Interface RuleProvider

All Superinterfaces:

Serializable

public interface RuleProvider
extends Serializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RuleProvider.RuleProviderType

Method Summary

Modifier and Type	Method and Description
Calendar	getDateLoaded() Contains the time that this rule's metadata was loaded into the windup-web database.
Calendar	getDateModified() Contains the time that this rule's metadata was last modified on disk.
String	getDescription() Contains a human readable description of this rule provider.
String	getOrigin() Contains the origin of the Rule Provider.
String	getPhase() Contains the phase during which this rule will execute.
String	getProviderID() Contains the ID from the Rule Provider.
RuleProvider.RuleProviderType	getRuleProviderType() Contains the type of provider (for example, Java vs Groovy).
List<Rule>	getRules() Contains the list of rules that were loaded by this provider.
RulesPath	getRulesPath() Contains the path in which this provider was found.
Set<Technology>	getSources() Contains the source technologies for this provider.
Set<Technology>	getTargets() Contains the target technologies for this provider.
int	getVersion() Contains a version field used for conflict resolution.
void	setDateLoaded(Calendar dateLoaded) Contains the time that this rule's metadata was loaded into the windup-web database.
void	setDateModified(Calendar dateModified) Contains the time that this rule's metadata was last modified on disk.
void	setDescription(String description) Contains a human readable description of this rule provider.
void	setOrigin(String origin) Contains the origin of the Rule Provider.
void	setPhase(String phase) Contains the phase during which this rule will execute.
void	setProviderID(String providerID) Contains the ID from the Rule Provider.
void	setRuleProviderType(RuleProvider.RuleProviderType ruleProviderType) Contains the type of provider (for example, Java vs Groovy).
void	setRules(List<Rule> rules) Contains the list of rules that were loaded by this provider.
void	setRulesPath(RulesPath rulesPath) Contains the path in which this provider was found.
void	setSources(Set<Technology> sources) Contains the source technologies for this provider.
void	setTargets(Set<Technology> targets) Contains the source technologies for this provider.
void	setVersion(int version) Contains a version field used for conflict resolution.

Method Detail

getVersion

int getVersion()

Contains a version field used for conflict resolution.

setVersion

void setVersion(int version)

Contains a version field used for conflict resolution.

getProviderID

String getProviderID()

Contains the ID from the Rule Provider. This should be unique across all rule providers.

setProviderID

void setProviderID(String providerID)

Contains the ID from the Rule Provider. This should be unique across all rule providers.

getOrigin

String getOrigin()

Contains the origin of the Rule Provider. For an XML File, this will be a full path to the file.

setOrigin

void setOrigin(String origin)

Contains the origin of the Rule Provider. For an XML File, this will be a full path to the file.

getDescription

String getDescription()

Contains a human readable description of this rule provider.

setDescription

void setDescription(String description)

Contains a human readable description of this rule provider.

getPhase

String getPhase()

Contains the phase during which this rule will execute.

setPhase

void setPhase(String phase)

Contains the phase during which this rule will execute.

getDateLoaded

Calendar getDateLoaded()

Contains the time that this rule's metadata was loaded into the windup-web database.

setDateLoaded

void setDateLoaded(Calendar dateLoaded)

Contains the time that this rule's metadata was loaded into the windup-web database.

getDateModified

Calendar getDateModified()

Contains the time that this rule's metadata was last modified on disk. This may be null if no modification date could be determined.

setDateModified

void setDateModified(Calendar dateModified)

Contains the time that this rule's metadata was last modified on disk. This may be null if no modification date could be determined.

getSources

Set<Technology> getSources()

Contains the source technologies for this provider.

setSources

void setSources(Set<Technology> sources)

Contains the source technologies for this provider.

getTargets

Set<Technology> getTargets()

Contains the target technologies for this provider.

setTargets

void setTargets(Set<Technology> targets)

Contains the source technologies for this provider.

getRules

List<Rule> getRules()

Contains the list of rules that were loaded by this provider.

setRules

void setRules(List<Rule> rules)

Contains the list of rules that were loaded by this provider.

getRulesPath

RulesPath getRulesPath()

Contains the path in which this provider was found.

setRulesPath

void setRulesPath(RulesPath rulesPath)

Contains the path in which this provider was found.

getRuleProviderType

RuleProvider.RuleProviderType getRuleProviderType()

Contains the type of provider (for example, Java vs Groovy).

setRuleProviderType

void setRuleProviderType(RuleProvider.RuleProviderType ruleProviderType)

Contains the type of provider (for example, Java vs Groovy).