Top Fields Constructors Methods
com.sun.faces.flow.builder

public Class FlowBuilderImpl

extends FlowBuilder
Class Inheritance
Imports
com.sun.faces.flow.FlowImpl, .ParameterImpl, com.sun.faces.util.Util, jakarta.el.ELContext, .ExpressionFactory, .MethodExpression, .ValueExpression, jakarta.faces.context.FacesContext, jakarta.faces.flow.Flow, jakarta.faces.flow.builder.FlowBuilder, .FlowCallBuilder, .MethodCallBuilder, .NavigationCaseBuilder, .ReturnBuilder, .SwitchBuilder, .ViewBuilder

Field Summary

Modifier and TypeField and Description
private FacesContext
context

private boolean
didInit

private ELContext
elContext

private ExpressionFactory
expressionFactory

private FlowImpl
flow

private boolean
hasId

Constructor Summary

AccessConstructor and Description
public
FlowBuilderImpl(FacesContext context)

Method Summary

Modifier and TypeMethod and Description
public FlowImpl
_getFlow()

public FlowBuilder
finalizer(MethodExpression
the expression to invoke, must reference a zero-argument method.
methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.finalizer.

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

public FlowBuilder
finalizer(String
the expression to invoke, must reference a zero-argument method.
methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.finalizer.

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

public FlowCallBuilder
flowCallNode(String
Within the flow graph, the id of this return node. Must be unique among all nodes in this flow graph.
flowCallNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.flowCallNode.

Define a flow call node.

pack-priv ELContext
getELContext()

pack-priv ExpressionFactory
getExpressionFactory()

public Flow
getFlow()

Implements abstract jakarta.faces.flow.builder.FlowBuilder.getFlow.

Called as the last step in flow definition, this method must perform any implementation specific initialization and return the built Flow.

public FlowBuilder
id(String
The defining document id of this flow, or the empty string if this flow does not need a defining document id.
definingDocumentId, String
the id of the flow
flowId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.id.

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

public FlowBuilder
inboundParameter(String
the parameter name
name, ValueExpression
the ValueExpression to populate with the inbound value when the flow is called.
value)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

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.

public FlowBuilder
inboundParameter(String
the parameter name
name, String
the ValueExpression String to populate with the inbound value when the flow is called.
value)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

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.

public FlowBuilder
initializer(MethodExpression
the expression to invoke, must reference a zero-argument method.
methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.initializer.

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

public FlowBuilder
initializer(String
the expression to invoke, must reference a zero-argument method.
methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.initializer.

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

public MethodCallBuilder
methodCallNode(String
Within the flow graph, the id of this method call node. Must be unique among all nodes in this flow graph.
methodCallNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.methodCallNode.

Define a method call node.

public ReturnBuilder
returnNode(String
Within the flow graph, the id of this return node. Must be unique among all nodes in this flow graph.
returnNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.returnNode.

Define a return node.

public SwitchBuilder
switchNode(String
Within the flow graph, the id of this switch node. Must be unique among all nodes in this flow graph.
switchNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.switchNode.

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.

public ViewBuilder
viewNode(String
Within the flow graph, the id of this view node. Must be unique among all nodes in this flow graph.
viewNodeId, String
The fully qualified path to the view node within this flow.
vdlDocumentId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.viewNode.

Define a view node in a flow graph.

Field Detail

contextback to summary
private FacesContext context
didInitback to summary
private boolean didInit
elContextback to summary
private ELContext elContext
expressionFactoryback to summary
private ExpressionFactory expressionFactory
flowback to summary
private FlowImpl flow
hasIdback to summary
private boolean hasId

Constructor Detail

FlowBuilderImplback to summary
public FlowBuilderImpl(FacesContext context)

Method Detail

_getFlowback to summary
public FlowImpl _getFlow()
finalizerback to summary
public FlowBuilder finalizer(MethodExpression methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.finalizer.

Doc from jakarta.faces.flow.builder.FlowBuilder.finalizer.

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

Parameters
methodExpression:MethodExpression

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
finalizerback to summary
public FlowBuilder finalizer(String methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.finalizer.

Doc from jakarta.faces.flow.builder.FlowBuilder.finalizer.

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

Parameters
methodExpression:String

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
flowCallNodeback to summary
public FlowCallBuilder flowCallNode(String flowCallNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.flowCallNode.

Doc from jakarta.faces.flow.builder.FlowBuilder.flowCallNode.

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

Parameters
flowCallNodeId:String

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

Returns:FlowCallBuilder

the builder instance

Annotations
@Override
getELContextback to summary
pack-priv ELContext getELContext()
getExpressionFactoryback to summary
pack-priv ExpressionFactory getExpressionFactory()
getFlowback to summary
public Flow getFlow()

Implements abstract jakarta.faces.flow.builder.FlowBuilder.getFlow.

Doc from jakarta.faces.flow.builder.FlowBuilder.getFlow.

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.

Returns:Flow

the completely built Flow

Annotations
@Override
idback to summary
public FlowBuilder id(String definingDocumentId, String flowId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.id.

Doc from jakarta.faces.flow.builder.FlowBuilder.id.

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

Parameters
definingDocumentId:String

The defining document id of this flow, or the empty string if this flow does not need a defining document id.

flowId:String

the id of the flow

Returns:FlowBuilder

the builder instance

Annotations
@Override
inboundParameterback to summary
public FlowBuilder inboundParameter(String name, ValueExpression value)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

Doc from jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

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.

Parameters
name:String

the parameter name

value:ValueExpression

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
inboundParameterback to summary
public FlowBuilder inboundParameter(String name, String value)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

Doc from jakarta.faces.flow.builder.FlowBuilder.inboundParameter.

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.

Parameters
name:String

the parameter name

value:String

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
initializerback to summary
public FlowBuilder initializer(MethodExpression methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.initializer.

Doc from jakarta.faces.flow.builder.FlowBuilder.initializer.

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

Parameters
methodExpression:MethodExpression

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
initializerback to summary
public FlowBuilder initializer(String methodExpression)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.initializer.

Doc from jakarta.faces.flow.builder.FlowBuilder.initializer.

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

Parameters
methodExpression:String

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

Returns:FlowBuilder

the builder instance

Annotations
@Override
methodCallNodeback to summary
public MethodCallBuilder methodCallNode(String methodCallNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.methodCallNode.

Doc from jakarta.faces.flow.builder.FlowBuilder.methodCallNode.

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.

Parameters
methodCallNodeId:String

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

Returns:MethodCallBuilder

the builder instance

Annotations
@Override
navigationCaseback to summary
public NavigationCaseBuilder navigationCase()

Implements abstract jakarta.faces.flow.builder.FlowBuilder.navigationCase.

Doc from jakarta.faces.flow.builder.FlowBuilder.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.

Returns:NavigationCaseBuilder

the builder instance

Annotations
@Override
returnNodeback to summary
public ReturnBuilder returnNode(String returnNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.returnNode.

Doc from jakarta.faces.flow.builder.FlowBuilder.returnNode.

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

Parameters
returnNodeId:String

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

Returns:ReturnBuilder

the builder instance

Annotations
@Override
switchNodeback to summary
public SwitchBuilder switchNode(String switchNodeId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.switchNode.

Doc from jakarta.faces.flow.builder.FlowBuilder.switchNode.

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.

Parameters
switchNodeId:String

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

Returns:SwitchBuilder

the builder instance

Annotations
@Override
viewNodeback to summary
public ViewBuilder viewNode(String viewNodeId, String vdlDocumentId)

Implements abstract jakarta.faces.flow.builder.FlowBuilder.viewNode.

Doc from jakarta.faces.flow.builder.FlowBuilder.viewNode.

Define a view node in a flow graph.

Parameters
viewNodeId:String

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

vdlDocumentId:String

The fully qualified path to the view node within this flow.

Returns:ViewBuilder

the builder instance

Annotations
@Override