Package org.jboss.windup.config.phase

Class RulePhase

java.lang.Object

org.ocpsoft.rewrite.context.ContextBase

org.jboss.windup.config.AbstractRuleProvider

org.jboss.windup.config.phase.RulePhase

All Implemented Interfaces:

RuleProvider, org.ocpsoft.common.pattern.Specialized<Object>, org.ocpsoft.common.pattern.Weighted, org.ocpsoft.rewrite.config.ConfigurationProvider<RuleLoaderContext>, org.ocpsoft.rewrite.context.Context

Direct Known Subclasses:

ArchiveExtractionPhase, ArchiveMetadataExtractionPhase, ClassifyFileTypesPhase, DecompilationPhase, DependentPhase, DiscoverProjectStructurePhase, DiscoveryPhase, FinalizePhase, InitialAnalysisPhase, InitializationPhase, MigrationRulesPhase, PostFinalizePhase, PostMigrationRulesPhase, PostReportGenerationPhase, PostReportRenderingPhase, PreReportGenerationPhase, ReportGenerationPhase, ReportRenderingPhase

public abstract class RulePhase
extends AbstractRuleProvider

Provides a shorthand for stating the order of execution of Rules within Windup. When a AbstractRuleProvider specifies a RulePhase, the results of calling getExecuteAfter() and getExecuteBefore() on the rule will appended to the results of RuleProviderMetadata.getExecuteAfter() and getExecuteBefore(). In this way, most AbstractRuleProviders will be able to simply specify a RulePhase in order to determine their approximate placement within the execution lifecycle.

Author:

Jesse Sightler

Constructor Summary

Constructors

Constructor	Description
RulePhase(Class<? extends RulePhase> implementationType)

Method Summary

Modifier and Type	Method	Description
org.ocpsoft.rewrite.config.Configuration	getConfiguration(RuleLoaderContext ruleLoaderContext)	This will always return an empty Configuration as these are just barriers that do not provide additional Rules.
abstract Class<? extends RulePhase>	getExecuteAfter()	This allows the RulePhase implementation to specify the RulePhase implementation that it should be executed after.
abstract Class<? extends RulePhase>	getExecuteBefore()	This allows the RulePhase implementation to specify the RulePhase implementation that it should be executed before.
RuleProviderMetadata	getMetadata()	Get the RuleProviderMetadata for this RuleProvider.
void	setExecuteAfter(Class<? extends RulePhase> previousPhase)	This allows the sorter to link RulePhases to each other, without them having to explicitly specify both the executeAfter and executeBefore.
void	setExecuteBefore(Class<? extends RulePhase> nextPhase)	This allows the sorter to link RulePhases to each other, without them having to explicitly specify both the executeAfter and executeBefore.

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

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

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

Constructor Detail

RulePhase

public RulePhase(Class<? extends RulePhase> implementationType)

Method Detail

getConfiguration

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

This will always return an empty Configuration as these are just barriers that do not provide additional Rules.

getMetadata

public final RuleProviderMetadata getMetadata()

Description copied from interface: RuleProvider

Get the RuleProviderMetadata for this RuleProvider.

Specified by:

getMetadata in interface RuleProvider

Overrides:

getMetadata in class AbstractRuleProvider

getExecuteAfter

public abstract Class<? extends RulePhase> getExecuteAfter()

This allows the RulePhase implementation to specify the RulePhase implementation that it should be executed after.

getExecuteBefore

public abstract Class<? extends RulePhase> getExecuteBefore()

This allows the RulePhase implementation to specify the RulePhase implementation that it should be executed before.

setExecuteAfter

public final void setExecuteAfter(Class<? extends RulePhase> previousPhase)

This allows the sorter to link RulePhases to each other, without them having to explicitly specify both the executeAfter and executeBefore.

setExecuteBefore

public final void setExecuteBefore(Class<? extends RulePhase> nextPhase)

This allows the sorter to link RulePhases to each other, without them having to explicitly specify both the executeAfter and executeBefore.