Package org.jboss.windup.config

Class GraphRewrite

java.lang.Object

org.ocpsoft.rewrite.AbstractRewrite

org.jboss.windup.config.GraphRewrite

All Implemented Interfaces:

org.ocpsoft.rewrite.event.Rewrite

public class GraphRewrite
extends org.ocpsoft.rewrite.AbstractRewrite
implements org.ocpsoft.rewrite.event.Rewrite

Holds the context of the whole Windup Execution. TODO: should be called "WindupExecutionContext" then?

Author:

Lincoln Baxter, III, Ondrej Zizka

Constructor Summary

Constructors

Constructor	Description
GraphRewrite(Iterable<RuleLifecycleListener> listeners, org.jboss.windup.graph.GraphContext context)
GraphRewrite(org.jboss.windup.graph.GraphContext context)

Method Summary

Modifier and Type	Method	Description
org.ocpsoft.rewrite.event.Flow	getFlow()
org.jboss.windup.graph.GraphContext	getGraphContext()
org.jboss.windup.util.exception.WindupStopException	getWindupStopException()
boolean	ruleEvaluationProgress(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.
void	setWindupStopException(org.jboss.windup.util.exception.WindupStopException windupStopException)	Stores the exception which holds information if, and where, the Windup stopped (typically on an external request).
boolean	shouldWindupStop()

Methods inherited from class org.ocpsoft.rewrite.AbstractRewrite

getEvaluatedRules, getRewriteContext, logEvaluatedRules

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ocpsoft.rewrite.event.Rewrite

getEvaluatedRules, getRewriteContext

Constructor Detail

GraphRewrite

public GraphRewrite(org.jboss.windup.graph.GraphContext context)

GraphRewrite

public GraphRewrite(Iterable<RuleLifecycleListener> listeners,
                    org.jboss.windup.graph.GraphContext context)

Method Detail

getWindupStopException

public org.jboss.windup.util.exception.WindupStopException getWindupStopException()

Returns:

The exception which holds information where Windup has stopped before finishing (typically on an external request), or null if Windup finished normally.

setWindupStopException

public void setWindupStopException(org.jboss.windup.util.exception.WindupStopException windupStopException)

Stores the exception which holds information if, and where, the Windup stopped (typically on an external request). If windup was stopped, this must be called.

getFlow

public org.ocpsoft.rewrite.event.Flow getFlow()

Specified by:

getFlow in interface org.ocpsoft.rewrite.event.Rewrite

getGraphContext

public org.jboss.windup.graph.GraphContext getGraphContext()

ruleEvaluationProgress

public boolean ruleEvaluationProgress(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.

shouldWindupStop

public boolean shouldWindupStop()