Module jakarta.faces

Package jakarta.faces.flow.builder

Class SwitchBuilder

java.lang.Object

jakarta.faces.flow.builder.SwitchBuilder

All Implemented Interfaces:

NodeBuilder

Direct Known Subclasses:

SwitchBuilderImpl

public abstract class SwitchBuilder
extends Object
implements NodeBuilder

Create a switch node in the current Flow.

Since:

2.2

Constructor Summary

Constructors

Constructor	Description
SwitchBuilder()

Method Summary

Modifier and Type	Method	Description
abstract SwitchCaseBuilder	defaultOutcome(ValueExpression outcome)	Set the default outcome of the current switch.
abstract SwitchCaseBuilder	defaultOutcome(String outcome)	Set the default outcome of the current switch.
abstract SwitchBuilder	markAsStartNode()	Mark this node as the start node in the flow.
abstract SwitchCaseBuilder	switchCase()	Create a switch case in the current switch.

Methods inherited from class java.lang.Object

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

Constructor Details

SwitchBuilder

public SwitchBuilder()

Method Details

switchCase

public abstract SwitchCaseBuilder switchCase()

Create a switch case in the current switch.

Returns:

the builder instance

Since:

2.2

defaultOutcome

public abstract SwitchCaseBuilder defaultOutcome(String outcome)

Set the default outcome of the current switch.

Parameters:

outcome - A ValueExpression String that will be the default outcome of the switch.

Returns:

the builder instance

Throws:

NullPointerException - if any of the parameters are null

Since:

2.2

defaultOutcome

public abstract SwitchCaseBuilder defaultOutcome(ValueExpression outcome)

Set the default outcome of the current switch.

Parameters:

outcome - A ValueExpression that will be the default outcome of the switch.

Returns:

the builder instance

Throws:

NullPointerException - if any of the parameters are null

Since:

2.2

markAsStartNode

public abstract SwitchBuilder markAsStartNode()

Description copied from interface: NodeBuilder

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.

Specified by:

markAsStartNode in interface NodeBuilder

Returns:

the builder instance