javax.faces.flow.builder.ReturnBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.3_spec Show documentation

Jakarta Server Faces defines an MVC framework for building user interfaces for web applications, including UI components, state management, event handing, input validation, page navigation, and support for internationalization and accessibility.

There is a newer version: 3.1.0.SP02

Show newest version

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.faces.flow.builder;

import javax.el.ValueExpression;

/**
 * Create a return node in the current {@link javax.faces.flow.Flow}.
 * @since 2.2
 */
public abstract class ReturnBuilder implements NodeBuilder {
    
    /**
     * Set the outcome of the current return node.
     * 
     * @param outcome A {@code ValueExpression} String {@code String} that will be the 
     * outcome of the return.
     * @throws NullPointerException if any of the parameters are {@code null}
     * 
     * @since 2.2
     *
     * @return the builder instance
     */
    public abstract ReturnBuilder fromOutcome(String outcome);
    
    /**
     * Set the outcome of the current return node.
     * 
     * @param outcome A {@code ValueExpression} {@code String} that will be the 
     * outcome of the return.
     * @throws NullPointerException if any of the parameters are {@code null}
     * 
     * @since 2.2
     *
     * @return the builder instance
     */
    public abstract ReturnBuilder fromOutcome(ValueExpression outcome);

    @Override
    public abstract ReturnBuilder markAsStartNode();
        
}