org.jboss.windup.config

Class AbstractRuleLifecycleListener

java.lang.Object

org.jboss.windup.config.AbstractRuleLifecycleListener

All Implemented Interfaces:

RuleLifecycleListener

Direct Known Subclasses:

ProjectTraversalCache

public abstract class AbstractRuleLifecycleListener
extends Object
implements RuleLifecycleListener

This provides a set of default (empty) methods that make it easy to implement RuleLifecycleListeners that only need to override a subset of the available methods.

Author:

Jesse Sightler, Ondrej Zizka

Constructor Summary

Constructors

Constructor and Description
AbstractRuleLifecycleListener()

Method Summary

Modifier and Type	Method and Description
void	afterExecution(GraphRewrite event) Called immediately after any Rule instances are executed.
void	afterRuleConditionEvaluation(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, org.ocpsoft.rewrite.config.Rule rule, boolean result) Called immediately after execution of the each Rule.
void	afterRuleExecutionFailed(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, org.ocpsoft.rewrite.config.Rule rule, Throwable failureCause) Called immediately after a a Rule has thrown an exception, to indicate a failure of some kind
void	afterRuleOperationsPerformed(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, org.ocpsoft.rewrite.config.Rule rule) Called immediately after Rule operations are performed (Only called if Condition.evaluate(org.ocpsoft.rewrite.event.Rewrite, EvaluationContext) returned true).
void	beforeExecution(GraphRewrite event) Called immediately before any Rule instances are executed.
boolean	beforeRuleEvaluation(GraphRewrite event, org.ocpsoft.rewrite.config.Rule rule, org.ocpsoft.rewrite.context.EvaluationContext context) Called immediately before the given Rule is executed.
boolean	beforeRuleOperationsPerformed(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, org.ocpsoft.rewrite.config.Rule rule) Called immediately before Rule operations are performed (Only called if Condition.evaluate(org.ocpsoft.rewrite.event.Rewrite, EvaluationContext) returned true).
boolean	ruleEvaluationProgress(GraphRewrite event, String name, int currentPosition, int total, int timeRemainingInSeconds) This is optionally called by long-running rules to indicate their current progress and estimated time-remaining.
boolean	shouldWindupStop() Returns directly the information whether Windup execution should stop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRuleLifecycleListener

public AbstractRuleLifecycleListener()

Method Detail

beforeExecution

public void beforeExecution(GraphRewrite event)

Description copied from interface: RuleLifecycleListener

Called immediately before any Rule instances are executed.

Specified by:

beforeExecution in interface RuleLifecycleListener

beforeRuleEvaluation

public boolean beforeRuleEvaluation(GraphRewrite event,
                                    org.ocpsoft.rewrite.config.Rule rule,
                                    org.ocpsoft.rewrite.context.EvaluationContext context)

Description copied from interface: RuleLifecycleListener

Called immediately before the given Rule is executed.

Specified by:

beforeRuleEvaluation in interface RuleLifecycleListener

Returns:

true if the execution should be stopped, which is typically indicated by an underlying WindupProgressMonitor.

ruleEvaluationProgress

public boolean ruleEvaluationProgress(GraphRewrite event,
                                      String name,
                                      int currentPosition,
                                      int total,
                                      int timeRemainingInSeconds)

Description copied from interface: RuleLifecycleListener

This is optionally called by long-running rules to indicate their current progress and estimated time-remaining.

Specified by:

ruleEvaluationProgress in interface RuleLifecycleListener

Returns:

true if the execution should be stopped, which is typically indicated by an underlying WindupProgressMonitor.

afterRuleConditionEvaluation

public void afterRuleConditionEvaluation(GraphRewrite event,
                                         org.ocpsoft.rewrite.context.EvaluationContext context,
                                         org.ocpsoft.rewrite.config.Rule rule,
                                         boolean result)

Description copied from interface: RuleLifecycleListener

Called immediately after execution of the each Rule.

Specified by:

afterRuleConditionEvaluation in interface RuleLifecycleListener

beforeRuleOperationsPerformed

public boolean beforeRuleOperationsPerformed(GraphRewrite event,
                                             org.ocpsoft.rewrite.context.EvaluationContext context,
                                             org.ocpsoft.rewrite.config.Rule rule)

Description copied from interface: RuleLifecycleListener

Called immediately before Rule operations are performed (Only called if Condition.evaluate(org.ocpsoft.rewrite.event.Rewrite, EvaluationContext) returned true).

Specified by:

beforeRuleOperationsPerformed in interface RuleLifecycleListener

Returns:

true if the execution should be stopped, which is typically indicated by an underlying WindupProgressMonitor.

afterRuleOperationsPerformed

public void afterRuleOperationsPerformed(GraphRewrite event,
                                         org.ocpsoft.rewrite.context.EvaluationContext context,
                                         org.ocpsoft.rewrite.config.Rule rule)

Description copied from interface: RuleLifecycleListener

Called immediately after Rule operations are performed (Only called if Condition.evaluate(org.ocpsoft.rewrite.event.Rewrite, EvaluationContext) returned true).

Specified by:

afterRuleOperationsPerformed in interface RuleLifecycleListener

afterRuleExecutionFailed

public void afterRuleExecutionFailed(GraphRewrite event,
                                     org.ocpsoft.rewrite.context.EvaluationContext context,
                                     org.ocpsoft.rewrite.config.Rule rule,
                                     Throwable failureCause)

Description copied from interface: RuleLifecycleListener

Called immediately after a a Rule has thrown an exception, to indicate a failure of some kind

Specified by:

afterRuleExecutionFailed in interface RuleLifecycleListener

afterExecution

public void afterExecution(GraphRewrite event)

Description copied from interface: RuleLifecycleListener

Called immediately after any Rule instances are executed.

Specified by:

afterExecution in interface RuleLifecycleListener

shouldWindupStop

public boolean shouldWindupStop()

Description copied from interface: RuleLifecycleListener

Returns directly the information whether Windup execution should stop. Not all listeners need to return true - just one returning true is a reason to stop execution. Queried by various rule implementations so we can stop as soon as possible.

Specified by:

shouldWindupStop in interface RuleLifecycleListener