org.jboss.windup.config.builder

Class RuleProviderBuilder

java.lang.Object

org.ocpsoft.rewrite.context.ContextBase

org.jboss.windup.config.AbstractRuleProvider

org.jboss.windup.config.builder.RuleProviderBuilder

All Implemented Interfaces:

RuleProviderBuilderAddDependencies, RuleProviderBuilderMetadataAddSourceTechnology, RuleProviderBuilderMetadataAddTargetTechnology, RuleProviderBuilderMetadataSetPhase, RuleProviderBuilderSetPhase, RuleProvider, org.ocpsoft.common.pattern.Specialized<Object>, org.ocpsoft.common.pattern.Weighted, org.ocpsoft.rewrite.config.ConfigurationProvider<RuleLoaderContext>, org.ocpsoft.rewrite.context.Context

@Vetoed
public final class RuleProviderBuilder
extends AbstractRuleProvider
implements RuleProviderBuilderSetPhase, RuleProviderBuilderMetadataSetPhase, RuleProviderBuilderAddDependencies, RuleProviderBuilderMetadataAddSourceTechnology, RuleProviderBuilderMetadataAddTargetTechnology

Used to construct new dynamic AbstractRuleProvider instances.

Author:

Jess Sightler, Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
RuleProviderBuilderAddDependencies	addExecuteAfter(Class<? extends AbstractRuleProvider> type) Indicates that the current ruleset should execute after the ruleset with the type
RuleProviderBuilderAddDependencies	addExecuteAfter(String id) Indicates that the current ruleset should execute after the ruleset with the given id
RuleProviderBuilderAddDependencies	addExecuteBefore(Class<? extends AbstractRuleProvider> type) Indicates that the current ruleset should execute before the ruleset with the type
RuleProviderBuilderAddDependencies	addExecuteBefore(String id) Indicates that the current ruleset should execute before the ruleset with the given id
org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom	addRule() Begin defining a Rule instance.
org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom	addRule(org.ocpsoft.rewrite.config.Rule rule) Begin enhancing a Rule instance based on the given Rule.
RuleProviderBuilderAddDependencies	addSourceTechnology(TechnologyReference technologyReference) Set the TechnologyReference for this AbstractRuleProvider
RuleProviderBuilderAddDependencies	addTargetTechnology(TechnologyReference technologyReference) Set the TechnologyReference for this AbstractRuleProvider
static RuleProviderBuilder	begin(String id) Begin creating a new dynamic AbstractRuleProvider.
org.ocpsoft.rewrite.config.Configuration	getConfiguration(RuleLoaderContext ruleLoaderContext) KEEP - The purpose of this override is to make sure that reflection (interface.getClass().getMethods()) keeps a method with the specific type.
MetadataBuilder	getMetadataBuilder()
void	setOrigin(String origin)
RuleProviderBuilderAddDependencies	setPhase(Class<? extends RulePhase> phase) Set the RulePhase for this AbstractRuleProvider
String	toString()

Methods inherited from class org.jboss.windup.config.AbstractRuleProvider

enhanceRuleMetadata, equals, getExecutionIndex, getMetadata, handles, hashCode, priority, setExecutionIndex

Methods inherited from class org.ocpsoft.rewrite.context.ContextBase

clear, containsKey, get, put

Methods inherited from class java.lang.Object

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

Method Detail

begin

public static RuleProviderBuilder begin(String id)

Begin creating a new dynamic AbstractRuleProvider.

setOrigin

public void setOrigin(String origin)

setPhase

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

Description copied from interface: RuleProviderBuilderSetPhase

Set the RulePhase for this AbstractRuleProvider

Specified by:

setPhase in interface RuleProviderBuilderMetadataSetPhase

Specified by:

setPhase in interface RuleProviderBuilderSetPhase

addSourceTechnology

public RuleProviderBuilderAddDependencies addSourceTechnology(TechnologyReference technologyReference)

Description copied from interface: RuleProviderBuilderMetadataAddSourceTechnology

Set the TechnologyReference for this AbstractRuleProvider

Specified by:

addSourceTechnology in interface RuleProviderBuilderMetadataAddSourceTechnology

addTargetTechnology

public RuleProviderBuilderAddDependencies addTargetTechnology(TechnologyReference technologyReference)

Description copied from interface: RuleProviderBuilderMetadataAddTargetTechnology

Set the TechnologyReference for this AbstractRuleProvider

Specified by:

addTargetTechnology in interface RuleProviderBuilderMetadataAddTargetTechnology

addExecuteAfter

public RuleProviderBuilderAddDependencies addExecuteAfter(String id)

Description copied from interface: RuleProviderBuilderAddDependencies

Indicates that the current ruleset should execute after the ruleset with the given id

Specified by:

addExecuteAfter in interface RuleProviderBuilderAddDependencies

addExecuteAfter

public RuleProviderBuilderAddDependencies addExecuteAfter(Class<? extends AbstractRuleProvider> type)

Description copied from interface: RuleProviderBuilderAddDependencies

Indicates that the current ruleset should execute after the ruleset with the type

Specified by:

addExecuteAfter in interface RuleProviderBuilderAddDependencies

addExecuteBefore

public RuleProviderBuilderAddDependencies addExecuteBefore(String id)

Description copied from interface: RuleProviderBuilderAddDependencies

Indicates that the current ruleset should execute before the ruleset with the given id

Specified by:

addExecuteBefore in interface RuleProviderBuilderAddDependencies

addExecuteBefore

public RuleProviderBuilderAddDependencies addExecuteBefore(Class<? extends AbstractRuleProvider> type)

Description copied from interface: RuleProviderBuilderAddDependencies

Indicates that the current ruleset should execute before the ruleset with the type

Specified by:

addExecuteBefore in interface RuleProviderBuilderAddDependencies

addRule

public org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom addRule()

Description copied from interface: RuleProviderBuilderAddDependencies

Begin defining a Rule instance.

Specified by:

addRule in interface RuleProviderBuilderAddDependencies

addRule

public org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom addRule(org.ocpsoft.rewrite.config.Rule rule)

Description copied from interface: RuleProviderBuilderAddDependencies

Begin enhancing a Rule instance based on the given Rule.

Specified by:

addRule in interface RuleProviderBuilderAddDependencies

getConfiguration

public org.ocpsoft.rewrite.config.Configuration getConfiguration(RuleLoaderContext ruleLoaderContext)

Description copied from interface: RuleProvider

KEEP - The purpose of this override is to make sure that reflection (interface.getClass().getMethods()) keeps a method with the specific type. Otherwise, type erasure will get rid of it and callers will get ClassCastExceptions in some obscure cases.

Specified by:

getConfiguration in interface RuleProvider

Specified by:

getConfiguration in interface org.ocpsoft.rewrite.config.ConfigurationProvider<RuleLoaderContext>

getMetadataBuilder

public MetadataBuilder getMetadataBuilder()

toString

public String toString()

Overrides:

toString in class AbstractRuleProvider