Top Description Constructors Methods
jakarta.faces.flow.builder

public abstract Class ReturnBuilder

extends Object
implements NodeBuilder
Class Inheritance
All Implemented Interfaces
jakarta.faces.flow.builder.NodeBuilder
Known Direct Subclasses
com.sun.faces.flow.builder.ReturnBuilderImpl
Imports
jakarta.el.ValueExpression

Create a return node in the current jakarta.faces.flow.Flow.

Since
2.2

Constructor Summary

AccessConstructor and Description
public
ReturnBuilder()

Method Summary

Modifier and TypeMethod and Description
public abstract ReturnBuilder

Returns:

the builder instance
fromOutcome(String
A ValueExpression String String that will be the outcome of the return.
outcome)

Set the outcome of the current return node.

public abstract ReturnBuilder

Returns:

the builder instance
fromOutcome(ValueExpression
A ValueExpression String that will be the outcome of the return.
outcome)

Set the outcome of the current return node.

public abstract ReturnBuilder
markAsStartNode()

Redeclares jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

Mark this node as the start node in the flow.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ReturnBuilderback to summary
public ReturnBuilder()

Method Detail

fromOutcomeback to summary
public abstract ReturnBuilder fromOutcome(String outcome)

Set the outcome of the current return node.

Parameters
outcome:String

A ValueExpression String String that will be the outcome of the return.

Returns:ReturnBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
fromOutcomeback to summary
public abstract ReturnBuilder fromOutcome(ValueExpression outcome)

Set the outcome of the current return node.

Parameters
outcome:ValueExpression

A ValueExpression String that will be the outcome of the return.

Returns:ReturnBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
markAsStartNodeback to summary
public abstract ReturnBuilder markAsStartNode()

Redeclares jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

Doc from jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node.

Returns:ReturnBuilder

the builder instance

Annotations
@Override