Package jakarta.faces.flow.builder

Class ReturnBuilder

  • All Implemented Interfaces:
    NodeBuilder
    public abstract class ReturnBuilder
extends java.lang.Object
implements NodeBuilder

    Create a return node in the current Flow.

    Since:
    2.2

    • Constructor Summary

      Constructors 
      Constructor Description
      ReturnBuilder()  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract ReturnBuilder fromOutcome​(jakarta.el.ValueExpression outcome)
      Set the outcome of the current return node.
      abstract ReturnBuilder fromOutcome​(java.lang.String outcome)
      Set the outcome of the current return node.
      abstract ReturnBuilder markAsStartNode()
      Mark this node as the start node in the flow.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReturnBuilder

        public ReturnBuilder()

    • Method Detail

      • fromOutcome

        public abstract ReturnBuilder fromOutcome​(java.lang.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:
        java.lang.NullPointerException - if any of the parameters are null
        Since:
        2.2

      • fromOutcome

        public abstract ReturnBuilder fromOutcome​(jakarta.el.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:
        java.lang.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