public class FlowBuilderImpl extends FlowBuilder
Constructor and Description |
---|
FlowBuilderImpl(FacesContext context) |
Modifier and Type | Method and Description |
---|---|
FlowImpl |
_getFlow() |
FlowBuilder |
finalizer(javax.el.MethodExpression methodExpression)
A MethodExpression that will be invoked when the flow is exited. |
FlowBuilder |
finalizer(String methodExpression)
A MethodExpression that will be invoked when the flow is exited. |
FlowCallBuilder |
flowCallNode(String flowCallNodeId)
Define a flow call node. |
Flow |
getFlow()
Called as the last step in flow definition,
this method must perform any implementation specific initialization
and return the built |
FlowBuilder |
id(String definingDocumentId,
String flowId)
Set the defining document id and flow id of this flow. |
FlowBuilder |
inboundParameter(String name,
String value)
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow. |
FlowBuilder |
inboundParameter(String name,
javax.el.ValueExpression value)
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow. |
FlowBuilder |
initializer(javax.el.MethodExpression methodExpression)
A MethodExpression that will be invoked when the flow is entered. |
FlowBuilder |
initializer(String methodExpression)
A MethodExpression that will be invoked when the flow is entered. |
MethodCallBuilder |
methodCallNode(String methodCallNodeId)
Define a method call node. |
NavigationCaseBuilder |
navigationCase()
Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next. |
ReturnBuilder |
returnNode(String returnNodeId)
Define a return node. |
SwitchBuilder |
switchNode(String switchNodeId)
Define a particular list of cases that will be inspected in the order they are defined to determine where to go next in the flow graph. |
ViewBuilder |
viewNode(String viewNodeId,
String vdlDocumentId)
Define a view node in a flow graph. |
public FlowBuilderImpl(FacesContext context)
public NavigationCaseBuilder navigationCase()
FlowBuilder
Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next.
navigationCase
in class FlowBuilder
public ViewBuilder viewNode(String viewNodeId, String vdlDocumentId)
FlowBuilder
Define a view node in a flow graph.
viewNode
in class FlowBuilder
viewNodeId
- Within the flow graph, the id of this view node. Must
be unique among all nodes in this flow graph.vdlDocumentId
- The fully qualified path to the view node within this flow.public SwitchBuilder switchNode(String switchNodeId)
FlowBuilder
Define a particular list of cases that will be inspected in the order they are defined to determine where to go next in the flow graph. If none of the cases match, the outcome from the default case is chosen.
switchNode
in class FlowBuilder
switchNodeId
- Within the flow graph, the id of this switch node. Must
be unique among all nodes in this flow graph.public ReturnBuilder returnNode(String returnNodeId)
FlowBuilder
Define a return node. This node will cause the specified outcome to be returned to the calling flow.
returnNode
in class FlowBuilder
returnNodeId
- Within the flow graph, the id of this return node. Must
be unique among all nodes in this flow graph.public MethodCallBuilder methodCallNode(String methodCallNodeId)
FlowBuilder
Define a method call node. This node will cause the specified method to be invoked, passing parameters if necessary. The return from the method is used as the outcome for where to go next in the flow. If the method is a void method, the default outcome is used.
methodCallNode
in class FlowBuilder
methodCallNodeId
- Within the flow graph, the id of this method call node. Must
be unique among all nodes in this flow graph.public FlowCallBuilder flowCallNode(String flowCallNodeId)
FlowBuilder
Define a flow call node. This node will cause the specified flow to be called, passing parameters if necessary.
flowCallNode
in class FlowBuilder
flowCallNodeId
- Within the flow graph, the id of this return node. Must
be unique among all nodes in this flow graph.public FlowBuilder id(String definingDocumentId, String flowId)
FlowBuilder
Set the defining document id and flow id of this flow.
id
in class FlowBuilder
definingDocumentId
- The defining document id of this flow, or the
empty string if this flow does not need a defining document id.flowId
- the id of the flowpublic FlowBuilder initializer(javax.el.MethodExpression methodExpression)
FlowBuilder
A MethodExpression that will be invoked when the flow is entered.
initializer
in class FlowBuilder
methodExpression
- the expression to invoke, must reference a zero-argument method.public FlowBuilder initializer(String methodExpression)
FlowBuilder
A MethodExpression that will be invoked when the flow is entered.
initializer
in class FlowBuilder
methodExpression
- the expression to invoke, must reference a zero-argument method.public FlowBuilder finalizer(javax.el.MethodExpression methodExpression)
FlowBuilder
A MethodExpression that will be invoked when the flow is exited.
finalizer
in class FlowBuilder
methodExpression
- the expression to invoke, must reference a zero-argument method.public FlowBuilder finalizer(String methodExpression)
FlowBuilder
A MethodExpression that will be invoked when the flow is exited.
finalizer
in class FlowBuilder
methodExpression
- the expression to invoke, must reference a zero-argument method.public FlowBuilder inboundParameter(String name, javax.el.ValueExpression value)
FlowBuilder
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
inboundParameter
in class FlowBuilder
name
- the parameter namevalue
- the ValueExpression
to populate with the inbound
value when the flow is called.public FlowBuilder inboundParameter(String name, String value)
FlowBuilder
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
inboundParameter
in class FlowBuilder
name
- the parameter namevalue
- the ValueExpression
String to populate with the inbound
value when the flow is called.public Flow getFlow()
FlowBuilder
Called as the last step in flow definition,
this method must perform any implementation specific initialization
and return the built Flow
. If called more than one time during a
given flow building process, the second and subsequent invocations must
take no action and return the built flow.
getFlow
in class FlowBuilder
Flow
public FlowImpl _getFlow()
Comments to: faces-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.