Package com.sun.faces.flow.builder

Class FlowBuilderImpl

java.lang.Object

jakarta.faces.flow.builder.FlowBuilder

com.sun.faces.flow.builder.FlowBuilderImpl

public class FlowBuilderImpl
extends FlowBuilder

Constructor Summary

Constructors

Constructor	Description
FlowBuilderImpl(FacesContext context)

Method Summary

Modifier and Type	Method	Description
FlowImpl	_getFlow()
FlowBuilder	finalizer(jakarta.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 Flow.
FlowBuilder	id(String definingDocumentId, String flowId)	Set the defining document id and flow id of this flow.
FlowBuilder	inboundParameter(String name, jakarta.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	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	initializer(jakarta.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowBuilderImpl

public FlowBuilderImpl(FacesContext context)

Method Detail

navigationCase

public NavigationCaseBuilder navigationCase()

Description copied from class: 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.

Specified by:

navigationCase in class FlowBuilder

Returns:

the builder instance

viewNode

public ViewBuilder viewNode(String viewNodeId,
                            String vdlDocumentId)

Description copied from class: FlowBuilder

Define a view node in a flow graph.

Specified by:

viewNode in class FlowBuilder

Parameters:

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.

Returns:

the builder instance

switchNode

public SwitchBuilder switchNode(String switchNodeId)

Description copied from class: 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.

Specified by:

switchNode in class FlowBuilder

Parameters:

switchNodeId - Within the flow graph, the id of this switch node. Must be unique among all nodes in this flow graph.

Returns:

the builder instance

returnNode

public ReturnBuilder returnNode(String returnNodeId)

Description copied from class: FlowBuilder

Define a return node. This node will cause the specified outcome to be returned to the calling flow.

Specified by:

returnNode in class FlowBuilder

Parameters:

returnNodeId - Within the flow graph, the id of this return node. Must be unique among all nodes in this flow graph.

Returns:

the builder instance

methodCallNode

public MethodCallBuilder methodCallNode(String methodCallNodeId)

Description copied from class: 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.

Specified by:

methodCallNode in class FlowBuilder

Parameters:

methodCallNodeId - Within the flow graph, the id of this method call node. Must be unique among all nodes in this flow graph.

Returns:

the builder instance

flowCallNode

public FlowCallBuilder flowCallNode(String flowCallNodeId)

Description copied from class: FlowBuilder

Define a flow call node. This node will cause the specified flow to be called, passing parameters if necessary.

Specified by:

flowCallNode in class FlowBuilder

Parameters:

flowCallNodeId - Within the flow graph, the id of this return node. Must be unique among all nodes in this flow graph.

Returns:

the builder instance

id

public FlowBuilder id(String definingDocumentId,
                      String flowId)

Description copied from class: FlowBuilder

Set the defining document id and flow id of this flow.

Specified by:

id in class FlowBuilder

Parameters:

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 flow

Returns:

the builder instance

initializer

public FlowBuilder initializer(jakarta.el.MethodExpression methodExpression)

Description copied from class: FlowBuilder

A MethodExpression that will be invoked when the flow is entered.

Specified by:

initializer in class FlowBuilder

Parameters:

methodExpression - the expression to invoke, must reference a zero-argument method.

Returns:

the builder instance

initializer

public FlowBuilder initializer(String methodExpression)

Description copied from class: FlowBuilder

A MethodExpression that will be invoked when the flow is entered.

Specified by:

initializer in class FlowBuilder

Parameters:

methodExpression - the expression to invoke, must reference a zero-argument method.

Returns:

the builder instance

finalizer

public FlowBuilder finalizer(jakarta.el.MethodExpression methodExpression)

Description copied from class: FlowBuilder

A MethodExpression that will be invoked when the flow is exited.

Specified by:

finalizer in class FlowBuilder

Parameters:

methodExpression - the expression to invoke, must reference a zero-argument method.

Returns:

the builder instance

finalizer

public FlowBuilder finalizer(String methodExpression)

Description copied from class: FlowBuilder

A MethodExpression that will be invoked when the flow is exited.

Specified by:

finalizer in class FlowBuilder

Parameters:

methodExpression - the expression to invoke, must reference a zero-argument method.

Returns:

the builder instance

inboundParameter

public FlowBuilder inboundParameter(String name,
                                    jakarta.el.ValueExpression value)

Description copied from class: 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.

Specified by:

inboundParameter in class FlowBuilder

Parameters:

name - the parameter name

value - the ValueExpression to populate with the inbound value when the flow is called.

Returns:

the builder instance

inboundParameter

public FlowBuilder inboundParameter(String name,
                                    String value)

Description copied from class: 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.

Specified by:

inboundParameter in class FlowBuilder

Parameters:

name - the parameter name

value - the ValueExpression String to populate with the inbound value when the flow is called.

Returns:

the builder instance

getFlow

public Flow getFlow()

Description copied from class: 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.

Specified by:

getFlow in class FlowBuilder

Returns:

the completely built Flow

_getFlow

public FlowImpl _getFlow()