org.jboss.windup.config.operation

Class Iteration

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.jboss.windup.config.operation.Iteration

All Implemented Interfaces:

IterationBuilderComplete, IterationBuilderOtherwise, IterationBuilderOver, IterationBuilderPerform, IterationBuilderVar, IterationBuilderWhen, org.ocpsoft.rewrite.config.CompositeOperation, org.ocpsoft.rewrite.config.Operation, org.ocpsoft.rewrite.config.OperationBuilder, org.ocpsoft.rewrite.param.Parameterized

public class Iteration
extends org.ocpsoft.rewrite.config.DefaultOperationBuilder
implements IterationBuilderVar, IterationBuilderOver, IterationBuilderWhen, IterationBuilderPerform, IterationBuilderOtherwise, IterationBuilderComplete, org.ocpsoft.rewrite.config.CompositeOperation, org.ocpsoft.rewrite.param.Parameterized

Used to iterate over an implicit or explicit variable defined within the corresponding ConfigurationRuleBuilder.when(Condition) clause in the current rule.

Author:

Lincoln Baxter, III, Ondrej Zizka, I, zizka@seznam.cz

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SINGLE_VARIABLE_STRING
static String	DEFAULT_VARIABLE_LIST_STRING

Method Summary

Modifier and Type	Method and Description
IterationBuilderWhen	all(org.ocpsoft.rewrite.config.Condition... condition)
IterationBuilderVar	as(Class<? extends WindupVertexFrame> varType, String var) Change the name of the single variable of the given type.
IterationBuilderVar	as(String var) Change the name of the single variable.
IterationBuilderComplete	endIteration() Visual end of the iteration.
static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE	getCurrentPayload(Variables stack, Class<FRAMETYPE> type, String name) Get the Iteration payload with the given name and type.
static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE	getCurrentPayload(Variables stack, String name) Get the Iteration payload with the given name.
List<org.ocpsoft.rewrite.config.Operation>	getOperations()
IterationPayloadManager	getPayloadManager()
static String	getPayloadVariableName(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext ctx) Return the current Iteration payload variable name.
Set<String>	getRequiredParameterNames() These are really just needed to pass through to the condition, since the visitor system doesn't expect operations to have conditions and wouldn't otherwise find them.
FramesSelector	getSelectionManager()
IterationBuilderOtherwise	otherwise(org.ocpsoft.rewrite.config.Operation operation) Perform the given Operation when the conditions set in this Iteration are met.
static IterationBuilderOver	over() Begin an Iteration over the selection that is placed on the top of the Variables.
static IterationBuilderOver	over(Class<? extends WindupVertexFrame> sourceType) Begin an Iteration over the selection of the given type, named with the default name.
static IterationBuilderOver	over(Class<? extends WindupVertexFrame> sourceType, String source) Begin an Iteration over the named selection of the given type.
static IterationBuilderOver	over(String source) Begin an Iteration over the named selection.
void	perform(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context) Called internally to actually process the Iteration.
IterationBuilderPerform	perform(org.ocpsoft.rewrite.config.Operation... operations) Perform the given Operation instances when the conditions set in this Iteration are met.
IterationBuilderPerform	perform(org.ocpsoft.rewrite.config.Operation operation) Perform the given Operation when the conditions set in this Iteration are met.
void	perform(org.ocpsoft.rewrite.event.Rewrite event, org.ocpsoft.rewrite.context.EvaluationContext context) Called internally to actually process the Iteration.
static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE	removeCurrentPayload(Variables stack, Class<FRAMETYPE> type, String name) Remove the current Iteration payload.
static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE	removeCurrentPayload(Variables stack, String name) Remove the current Iteration payload.
static void	setCurrentPayload(Variables stack, String name, WindupVertexFrame frame) Set the current Iteration payload.
void	setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store) These are really just needed to pass through to the condition, since the visitor system doesn't expect operations to have conditions and wouldn't otherwise find them.
void	setPayloadManager(IterationPayloadManager payloadManager)
static String	singleVariableIterationName(String selectionName) Calculates the default name for the single variable in the selection with the given name.
String	toString()
IterationBuilderWhen	when(org.ocpsoft.rewrite.config.Condition condition) A condition which decides for each frame whether IterationBuilderVar.perform(Operation) or otherwise(Operation) will be processed.

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ocpsoft.rewrite.config.OperationBuilder

and

Field Detail

DEFAULT_VARIABLE_LIST_STRING

public static final String DEFAULT_VARIABLE_LIST_STRING

See Also:

Constant Field Values

DEFAULT_SINGLE_VARIABLE_STRING

public static final String DEFAULT_SINGLE_VARIABLE_STRING

Method Detail

singleVariableIterationName

public static String singleVariableIterationName(String selectionName)

Calculates the default name for the single variable in the selection with the given name.

over

public static IterationBuilderOver over(Class<? extends WindupVertexFrame> sourceType,
                                        String source)

Begin an Iteration over the named selection of the given type. Also sets the name and type of the variable for this iteration's "current element". The type serves for automatic type check.

over

public static IterationBuilderOver over(String source)

Begin an Iteration over the named selection. Also sets the name of the variable for this iteration's "current element".

over

public static IterationBuilderOver over(Class<? extends WindupVertexFrame> sourceType)

Begin an Iteration over the selection of the given type, named with the default name. Also sets the name of the variable for this iteration's "current element" to have the default value.

over

public static IterationBuilderOver over()

Begin an Iteration over the selection that is placed on the top of the Variables. Also sets the name of the variable for this iteration's "current element" (i.e payload) to have the default value.

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

These are really just needed to pass through to the condition, since the visitor system doesn't expect operations to have conditions and wouldn't otherwise find them.

Specified by:

getRequiredParameterNames in interface org.ocpsoft.rewrite.param.Parameterized

setParameterStore

public void setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)

These are really just needed to pass through to the condition, since the visitor system doesn't expect operations to have conditions and wouldn't otherwise find them.

Specified by:

setParameterStore in interface org.ocpsoft.rewrite.param.Parameterized

as

public IterationBuilderVar as(Class<? extends WindupVertexFrame> varType,
                              String var)

Change the name of the single variable of the given type. If this method is not called, the name is calculated using the singleVariableIterationName(String) method.

Specified by:

as in interface IterationBuilderOver

as

public IterationBuilderVar as(String var)

Change the name of the single variable. If this method is not called, the name is calculated using the singleVariableIterationName(String) method.

Specified by:

as in interface IterationBuilderOver

all

public IterationBuilderWhen all(org.ocpsoft.rewrite.config.Condition... condition)

when

public IterationBuilderWhen when(org.ocpsoft.rewrite.config.Condition condition)

Description copied from interface: IterationBuilderVar

A condition which decides for each frame whether IterationBuilderVar.perform(Operation) or otherwise(Operation) will be processed.

Specified by:

when in interface IterationBuilderVar

perform

public IterationBuilderPerform perform(org.ocpsoft.rewrite.config.Operation operation)

Description copied from interface: IterationBuilderVar

Perform the given Operation when the conditions set in this Iteration are met.

Specified by:

perform in interface IterationBuilderVar

Specified by:

perform in interface IterationBuilderWhen

perform

public IterationBuilderPerform perform(org.ocpsoft.rewrite.config.Operation... operations)

Description copied from interface: IterationBuilderVar

Perform the given Operation instances when the conditions set in this Iteration are met.

Specified by:

perform in interface IterationBuilderVar

otherwise

public IterationBuilderOtherwise otherwise(org.ocpsoft.rewrite.config.Operation operation)

Description copied from interface: IterationBuilderPerform

Perform the given Operation when the conditions set in this Iteration are met.

Specified by:

otherwise in interface IterationBuilderPerform

endIteration

public IterationBuilderComplete endIteration()

Visual end of the iteration.

Specified by:

endIteration in interface IterationBuilderOtherwise

Specified by:

endIteration in interface IterationBuilderPerform

perform

public void perform(org.ocpsoft.rewrite.event.Rewrite event,
                    org.ocpsoft.rewrite.context.EvaluationContext context)

Called internally to actually process the Iteration.

Specified by:

perform in interface org.ocpsoft.rewrite.config.Operation

perform

public void perform(GraphRewrite event,
                    org.ocpsoft.rewrite.context.EvaluationContext context)

Called internally to actually process the Iteration. Loops over the frames to iterate, and performs their .perform( ... ) or .otherwise( ... ) parts.

getOperations

public List<org.ocpsoft.rewrite.config.Operation> getOperations()

Specified by:

getOperations in interface org.ocpsoft.rewrite.config.CompositeOperation

getPayloadVariableName

public static String getPayloadVariableName(GraphRewrite event,
                                            org.ocpsoft.rewrite.context.EvaluationContext ctx)
                                     throws IllegalStateException

Return the current Iteration payload variable name.

Throws:

IllegalStateException - if there is more than one variable in the Variables stack, and the payload name cannot be determined.

setCurrentPayload

public static void setCurrentPayload(Variables stack,
                                     String name,
                                     WindupVertexFrame frame)
                              throws IllegalArgumentException

Set the current Iteration payload.

Throws:

IllegalArgumentException

getCurrentPayload

public static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE getCurrentPayload(Variables stack,
                                                                                String name)
                                                                         throws IllegalStateException,
                                                                                IllegalArgumentException

Get the Iteration payload with the given name.

Throws:

IllegalArgumentException - if the given variable refers to a non-payload.

IllegalStateException

getCurrentPayload

public static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE getCurrentPayload(Variables stack,
                                                                                Class<FRAMETYPE> type,
                                                                                String name)
                                                                         throws IllegalStateException,
                                                                                IllegalArgumentException

Get the Iteration payload with the given name and type.

Throws:

IllegalArgumentException - if the given variable refers to a non-payload.

IllegalStateException

removeCurrentPayload

public static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE removeCurrentPayload(Variables stack,
                                                                                   Class<FRAMETYPE> type,
                                                                                   String name)
                                                                            throws IllegalStateException,
                                                                                   IllegalTypeArgumentException

Remove the current Iteration payload.

Throws:

IllegalStateException

IllegalTypeArgumentException

removeCurrentPayload

public static <FRAMETYPE extends WindupVertexFrame> FRAMETYPE removeCurrentPayload(Variables stack,
                                                                                   String name)
                                                                            throws IllegalStateException,
                                                                                   IllegalTypeArgumentException

Remove the current Iteration payload.

Throws:

IllegalStateException

IllegalTypeArgumentException

setPayloadManager

public void setPayloadManager(IterationPayloadManager payloadManager)

getSelectionManager

public FramesSelector getSelectionManager()

getPayloadManager

public IterationPayloadManager getPayloadManager()

toString

public String toString()

Overrides:

toString in class Object

Returns:

Description of this iteration, e.g. "Iteration.over(?).as(...).when(...).perform(...)".