Class ReturnBuilder

java.lang.Object
jakarta.faces.flow.builder.ReturnBuilder
All Implemented Interfaces:
NodeBuilder

public abstract class ReturnBuilder extends Object implements NodeBuilder

Create a return node in the current Flow.

Since:
2.2
  • Constructor Details

    • ReturnBuilder

      public ReturnBuilder()
  • Method Details

    • fromOutcome

      public abstract ReturnBuilder fromOutcome(String outcome)

      Set the outcome of the current return node.

      Parameters:
      outcome - A ValueExpression String String that will be the outcome of the return.
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2
    • fromOutcome

      public abstract ReturnBuilder fromOutcome(ValueExpression outcome)

      Set the outcome of the current return node.

      Parameters:
      outcome - A ValueExpression String that will be the outcome of the return.
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2
    • markAsStartNode

      public abstract ReturnBuilder 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