javax.faces.flow
Class Flow

java.lang.Object
  extended by javax.faces.flow.Flow
All Implemented Interfaces:
Serializable

public class Flow
extends Object
implements Serializable

Flow is the runtime representation of a Faces Flow. Once placed into service by the runtime, an instance of this class is immutable. The implementation must be thread-safe because instances will be shared across all usages of the flow within the application.

Since:
2.2
See Also:
Serialized Form

Constructor Summary
Flow()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getClientWindowFlowId(ClientWindow curWindow)
          

Obtain the current ClientWindow from the ExternalContext.

 javax.el.MethodExpression getFinalizer()
           
 String getId()
          

Return the immutable id for this Flow.

 javax.el.MethodExpression getInitializer()
           
 FlowNode getNode(String viewNodeId)
           
 Map<String,NavigationCase> getReturns(FacesContext context)
           
 String getStartNodeId()
          

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

 Map<String,List<NavigationCase>> getSwitches(FacesContext context)
           
 List<ViewNode> getViews()
           
 int hashCode()
           
 void setFinalizer(javax.el.MethodExpression finalizer)
           
 void setId(String id)
          

This setter will likely be moved from the public API into the implementation.

 void setInitializer(javax.el.MethodExpression initializer)
           
 void setStartNodeId(String defaultNodeId)
          

This setter will likely be moved from the public API into the implementation.

 void setViews(List<ViewNode> views)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Flow

public Flow()
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()

Return the immutable id for this Flow. This must be unique within a flow definition, but need not be unique within the entire application.

Since:
2.2

setId

public void setId(String id)

This setter will likely be moved from the public API into the implementation.

Since:
2.2

getStartNodeId

public String getStartNodeId()

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

Since:
2.2

setStartNodeId

public void setStartNodeId(String defaultNodeId)

This setter will likely be moved from the public API into the implementation.

Since:
2.2

getFinalizer

public javax.el.MethodExpression getFinalizer()

setFinalizer

public void setFinalizer(javax.el.MethodExpression finalizer)

getInitializer

public javax.el.MethodExpression getInitializer()

setInitializer

public void setInitializer(javax.el.MethodExpression initializer)

getViews

public List<ViewNode> getViews()

setViews

public void setViews(List<ViewNode> views)

getReturns

public Map<String,NavigationCase> getReturns(FacesContext context)

getSwitches

public Map<String,List<NavigationCase>> getSwitches(FacesContext context)

getNode

public FlowNode getNode(String viewNodeId)

getClientWindowFlowId

public String getClientWindowFlowId(ClientWindow curWindow)

Obtain the current ClientWindow from the ExternalContext. Get the window's id and append "_" and the return from getId(). Return the result.

Since:
2.2


Copyright 2002-2010 Oracle America Inc, Inc. All Rights Reserved.