Top Description Constructors Methods
jakarta.faces.flow.builder

public abstract Class MethodCallBuilder

extends Object
implements NodeBuilder
Class Inheritance
All Implemented Interfaces
jakarta.faces.flow.builder.NodeBuilder
Imports
java.util.List, jakarta.el.MethodExpression, .ValueExpression, jakarta.faces.flow.Parameter

Create a method call node in the current jakarta.faces.flow.Flow.

Since
2.2

Constructor Summary

AccessConstructor and Description
public
MethodCallBuilder()

Method Summary

Modifier and TypeMethod and Description
public abstract MethodCallBuilder

Returns:

the builder instance
defaultOutcome(String
A ValueExpression String representing the default outcome, only used if the method is a void method or returns null.
outcome)

If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns.

public abstract MethodCallBuilder

Returns:

the builder instance
defaultOutcome(ValueExpression
A ValueExpression representing the default outcome, only used if the method is a void method or returns null.
outcome)

If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns.

public abstract MethodCallBuilder

Returns:

the builder instance
expression(MethodExpression
The MethodExpression to invoke.
methodExpression)

Set the method expression of this method call node.

public abstract MethodCallBuilder

Returns:

the builder instance
expression(String
The MethodExpression String to invoke.
methodExpression)

Set the method expression of this method call node.

public abstract MethodCallBuilder

Returns:

the builder instance
expression(String
The MethodExpression to invoke.
methodExpression, Class<T>[]
the types of the parameters to the method.
paramTypes)

Set the method expression of this method call node.

public abstract MethodCallBuilder
markAsStartNode()

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

Mark this node as the start node in the flow.

public abstract MethodCallBuilder

Returns:

the builder instance
parameters(List<Parameter>
the parameters to pass to the method when it is invoked.
parameters)

Set the parameters of the method call node.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

MethodCallBuilderback to summary
public MethodCallBuilder()

Method Detail

defaultOutcomeback to summary
public abstract MethodCallBuilder defaultOutcome(String outcome)

If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns.

Parameters
outcome:String

A ValueExpression String representing the default outcome, only used if the method is a void method or returns null.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
defaultOutcomeback to summary
public abstract MethodCallBuilder defaultOutcome(ValueExpression outcome)

If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns.

Parameters
outcome:ValueExpression

A ValueExpression representing the default outcome, only used if the method is a void method or returns null.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
expressionback to summary
public abstract MethodCallBuilder expression(MethodExpression methodExpression)

Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the parameters method.

Parameters
methodExpression:MethodExpression

The MethodExpression to invoke.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
expressionback to summary
public abstract MethodCallBuilder expression(String methodExpression)

Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the parameters method.

Parameters
methodExpression:String

The MethodExpression String to invoke.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
expressionback to summary
public abstract MethodCallBuilder expression(String methodExpression, Class<T>[] paramTypes)

Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the parameters method.

Parameters
methodExpression:String

The MethodExpression to invoke.

paramTypes:Class<T>[]

the types of the parameters to the method.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
markAsStartNodeback to summary
public abstract MethodCallBuilder 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:MethodCallBuilder

the builder instance

Annotations
@Override
parametersback to summary
public abstract MethodCallBuilder parameters(List<Parameter> parameters)

Set the parameters of the method call node.

Parameters
parameters:List<Parameter>

the parameters to pass to the method when it is invoked.

Returns:MethodCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2