org.jboss.windup.config

Class AbstractRuleProvider

java.lang.Object

org.ocpsoft.rewrite.context.ContextBase

org.jboss.windup.config.AbstractRuleProvider

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:

IteratingRuleProvider, RulePhase, RuleProviderBuilder, SingleRuleProvider

public abstract class AbstractRuleProvider
extends org.ocpsoft.rewrite.context.ContextBase
implements RuleProvider

AbstractRuleProvider provides metadata, and a list of Rule objects that are then evaluated by the RuleSubset during Windup execution.

Author:

Lincoln Baxter, III, Ondrej Zizka, I

Constructor Summary

Constructors

Constructor and Description
AbstractRuleProvider()
AbstractRuleProvider(Class<? extends RuleProvider> implementationType, String id) Create a new AbstractRuleProvider instance using the given parameters to construct default RuleProviderMetadata.
AbstractRuleProvider(RuleProviderMetadata metadata) Create a new AbstractRuleProvider instance using the given RuleProviderMetadata.

Method Summary

Modifier and Type	Method and Description
static void	enhanceRuleMetadata(RuleProvider provider, org.ocpsoft.rewrite.config.Rule rule) Specify additional meta-data to individual Rule instances originating from the corresponding RuleProvider instance.
boolean	equals(Object other)
int	getExecutionIndex() For internal use only.
RuleProviderMetadata	getMetadata() Get the RuleProviderMetadata for this RuleProvider.
boolean	handles(Object payload)
int	hashCode()
int	priority() The "priority" of the RuleProvider instance.
void	setExecutionIndex(int executionIndex) For internal use only.
String	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

Methods inherited from interface org.jboss.windup.config.RuleProvider

getConfiguration

Constructor Detail

AbstractRuleProvider

public AbstractRuleProvider()

AbstractRuleProvider

public AbstractRuleProvider(RuleProviderMetadata metadata)

Create a new AbstractRuleProvider instance using the given RuleProviderMetadata.

AbstractRuleProvider

public AbstractRuleProvider(Class<? extends RuleProvider> implementationType,
                            String id)

Create a new AbstractRuleProvider instance using the given parameters to construct default RuleProviderMetadata.

Method Detail

getMetadata

public RuleProviderMetadata getMetadata()

Description copied from interface: RuleProvider

Get the RuleProviderMetadata for this RuleProvider.

Specified by:

getMetadata in interface RuleProvider

handles

public boolean handles(Object payload)

Specified by:

handles in interface org.ocpsoft.common.pattern.Specialized<Object>

enhanceRuleMetadata

public static void enhanceRuleMetadata(RuleProvider provider,
                                       org.ocpsoft.rewrite.config.Rule rule)

Specify additional meta-data to individual Rule instances originating from the corresponding RuleProvider instance.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExecutionIndex

public final int getExecutionIndex()

For internal use only.

setExecutionIndex

public final void setExecutionIndex(int executionIndex)

For internal use only.

priority

public final int priority()

The "priority" of the RuleProvider instance. This is not presently used by Windup.

Specified by:

priority in interface org.ocpsoft.common.pattern.Weighted

toString

public String toString()

Overrides:

toString in class org.ocpsoft.rewrite.context.ContextBase