com.sun.faces.flow

Class FlowImpl

java.lang.Object

jakarta.faces.flow.Flow

com.sun.faces.flow.FlowImpl

All Implemented Interfaces:

Serializable

public class FlowImpl
extends jakarta.faces.flow.Flow
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static jakarta.faces.flow.Flow	ABANDONED_FLOW
static jakarta.faces.flow.Flow	SYNTHESIZED_RETURN_CASE_FLOW

Constructor Summary

Constructors

Constructor and Description
FlowImpl()

Method Summary

Modifier and Type	Method and Description
Map<String,jakarta.faces.flow.FlowCallNode>	_getFlowCalls()
Map<String,jakarta.faces.flow.Parameter>	_getInboundParameters()
List<jakarta.faces.flow.MethodCallNode>	_getMethodCalls()
Map<String,Set<jakarta.faces.application.NavigationCase>>	_getNavigationCases()
Map<String,jakarta.faces.flow.ReturnNode>	_getReturns()
Map<String,jakarta.faces.flow.SwitchNode>	_getSwitches()
List<jakarta.faces.flow.ViewNode>	_getViews()
boolean	equals(Object obj)
String	getClientWindowFlowId(jakarta.faces.lifecycle.ClientWindow curWindow) Get the ClientWindow's id and append "_" and the return from Flow.getId().
String	getDefiningDocumentId() Return the immutable application unique identifier for the document in which the argument flow is defined.
jakarta.el.MethodExpression	getFinalizer() Return the MethodExpression that must be called by the runtime as the last thing that happens before exiting this flow.
jakarta.faces.flow.FlowCallNode	getFlowCall(jakarta.faces.flow.Flow targetFlow) Return the FlowCallNode that represents calling the targetFlow from this flow, or null if targetFlow cannot be reached from this flow.
Map<String,jakarta.faces.flow.FlowCallNode>	getFlowCalls() Return an immutable data structure containing all the flow call nodes declared for this flow.
String	getId() Return the immutable id for this Flow.
Map<String,jakarta.faces.flow.Parameter>	getInboundParameters() Return an immutable data structure containing the inbound parameters that have been declared for this flow.
jakarta.el.MethodExpression	getInitializer() Return the MethodExpression that must be called by the runtime immediately after activating any FlowScoped beans declared for this flow.
List<jakarta.faces.flow.MethodCallNode>	getMethodCalls() Return an immutable data structure containing all the method call nodes declared for this flow.
Map<String,Set<jakarta.faces.application.NavigationCase>>	getNavigationCases() Return an unmodifiable view of the navigation cases within this flow.
jakarta.faces.flow.FlowNode	getNode(String nodeId) Return the generic FlowNode by id, or null if not found.
Map<String,jakarta.faces.flow.ReturnNode>	getReturns() Return an immutable data structure containing all of the return nodes declared for this flow.
String	getStartNodeId() Return the immutable id for the default node that should be activated when this flow is entered.
Map<String,jakarta.faces.flow.SwitchNode>	getSwitches() Return an immutable data structure containing all of the switch nodes declared for this flow.
List<jakarta.faces.flow.ViewNode>	getViews() Return an immutable data structure containing all of the view nodes declared for this flow.
int	hashCode()
void	init(jakarta.faces.context.FacesContext context)
void	setFinalizer(jakarta.el.MethodExpression finalizer)
void	setId(String definingDocumentId, String id)
void	setInitializer(jakarta.el.MethodExpression initializer)
void	setStartNodeId(String defaultNodeId)

Methods inherited from class java.lang.Object

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

Field Detail

SYNTHESIZED_RETURN_CASE_FLOW

public static final jakarta.faces.flow.Flow SYNTHESIZED_RETURN_CASE_FLOW

ABANDONED_FLOW

public static final jakarta.faces.flow.Flow ABANDONED_FLOW

Constructor Detail

FlowImpl

public FlowImpl()

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Description copied from class: jakarta.faces.flow.Flow

Return the immutable id for this Flow. This must be unique within the defining document (such as an Application Configuration Resources file), but need not be unique within the entire application.

Specified by:

getId in class jakarta.faces.flow.Flow

Returns:

the id.

getDefiningDocumentId

public String getDefiningDocumentId()

Description copied from class: jakarta.faces.flow.Flow

Return the immutable application unique identifier for the document in which the argument flow is defined.

Specified by:

getDefiningDocumentId in class jakarta.faces.flow.Flow

Returns:

the defining document id

setId

public void setId(String definingDocumentId,
                  String id)

getStartNodeId

public String getStartNodeId()

Description copied from class: jakarta.faces.flow.Flow

Return the immutable id for the default node that should be activated when this flow is entered.

Specified by:

getStartNodeId in class jakarta.faces.flow.Flow

Returns:

the id of the start node

setStartNodeId

public void setStartNodeId(String defaultNodeId)

getFinalizer

public jakarta.el.MethodExpression getFinalizer()

Description copied from class: jakarta.faces.flow.Flow

Return the MethodExpression that must be called by the runtime as the last thing that happens before exiting this flow. Any FlowScoped beans declared for this flow must remain in scope until after control returns from the method referenced by this MethodExpression.

Specified by:

getFinalizer in class jakarta.faces.flow.Flow

Returns:

the MethodExpresion for the finalizer.

setFinalizer

public void setFinalizer(jakarta.el.MethodExpression finalizer)

getInitializer

public jakarta.el.MethodExpression getInitializer()

Description copied from class: jakarta.faces.flow.Flow

Return the MethodExpression that must be called by the runtime immediately after activating any FlowScoped beans declared for this flow.

Specified by:

getInitializer in class jakarta.faces.flow.Flow

Returns:

the MethodExpresion for the initializer.

setInitializer

public void setInitializer(jakarta.el.MethodExpression initializer)

getInboundParameters

public Map<String,jakarta.faces.flow.Parameter> getInboundParameters()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing the inbound parameters that have been declared for this flow. See FlowHandler.transition(jakarta.faces.context.FacesContext, jakarta.faces.flow.Flow, jakarta.faces.flow.Flow, jakarta.faces.flow.FlowCallNode, java.lang.String) for the specification of how these parameters are used. Inbound parameters are associated with a specific flow instance, while outbound parameters are associated with a FlowCallNode that causes the transition to a new flow.

Specified by:

getInboundParameters in class jakarta.faces.flow.Flow

Returns:

the inbound parameters

_getInboundParameters

public Map<String,jakarta.faces.flow.Parameter> _getInboundParameters()

getViews

public List<jakarta.faces.flow.ViewNode> getViews()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing all of the view nodes declared for this flow.

Specified by:

getViews in class jakarta.faces.flow.Flow

Returns:

the view nodes for this flow

_getViews

public List<jakarta.faces.flow.ViewNode> _getViews()

getReturns

public Map<String,jakarta.faces.flow.ReturnNode> getReturns()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing all of the return nodes declared for this flow.

Specified by:

getReturns in class jakarta.faces.flow.Flow

Returns:

the return nodes for this flow.

_getReturns

public Map<String,jakarta.faces.flow.ReturnNode> _getReturns()

getSwitches

public Map<String,jakarta.faces.flow.SwitchNode> getSwitches()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing all of the switch nodes declared for this flow.

Specified by:

getSwitches in class jakarta.faces.flow.Flow

Returns:

the switch nodes for this flow

_getSwitches

public Map<String,jakarta.faces.flow.SwitchNode> _getSwitches()

getFlowCalls

public Map<String,jakarta.faces.flow.FlowCallNode> getFlowCalls()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing all the flow call nodes declared for this flow.

Specified by:

getFlowCalls in class jakarta.faces.flow.Flow

Returns:

the flow call nodes for this flow

_getFlowCalls

public Map<String,jakarta.faces.flow.FlowCallNode> _getFlowCalls()

getNavigationCases

public Map<String,Set<jakarta.faces.application.NavigationCase>> getNavigationCases()

Description copied from class: jakarta.faces.flow.Flow

Return an unmodifiable view of the navigation cases within this flow.

Specified by:

getNavigationCases in class jakarta.faces.flow.Flow

Returns:

the navigation cases,

_getNavigationCases

public Map<String,Set<jakarta.faces.application.NavigationCase>> _getNavigationCases()

getFlowCall

public jakarta.faces.flow.FlowCallNode getFlowCall(jakarta.faces.flow.Flow targetFlow)

Description copied from class: jakarta.faces.flow.Flow

Return the FlowCallNode that represents calling the targetFlow from this flow, or null if targetFlow cannot be reached from this flow.

Specified by:

getFlowCall in class jakarta.faces.flow.Flow

Parameters:

targetFlow - the flow for which the FlowCallNode is to be returned

Returns:

a FlowCallNode for the argument flow or null

getMethodCalls

public List<jakarta.faces.flow.MethodCallNode> getMethodCalls()

Description copied from class: jakarta.faces.flow.Flow

Return an immutable data structure containing all the method call nodes declared for this flow.

Specified by:

getMethodCalls in class jakarta.faces.flow.Flow

Returns:

the method call nodes for this flow

_getMethodCalls

public List<jakarta.faces.flow.MethodCallNode> _getMethodCalls()

getNode

public jakarta.faces.flow.FlowNode getNode(String nodeId)

Description copied from class: jakarta.faces.flow.Flow

Return the generic FlowNode by id, or null if not found.

Specified by:

getNode in class jakarta.faces.flow.Flow

Parameters:

nodeId - the node id for which the FlowNode is to be returned

Returns:

the FlowNode or null

getClientWindowFlowId

public String getClientWindowFlowId(jakarta.faces.lifecycle.ClientWindow curWindow)

Description copied from class: jakarta.faces.flow.Flow

Get the ClientWindow's id and append "_" and the return from Flow.getId(). Return the result.

Specified by:

getClientWindowFlowId in class jakarta.faces.flow.Flow

Parameters:

curWindow - the

Returns:

the generated client window id for this flow.

init

public void init(jakarta.faces.context.FacesContext context)