javax.faces.flow.MethodCallNode 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

JSR-000372: JavaServer(TM) Faces 2.3 API

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;

import java.util.List;
import javax.el.MethodExpression;
import javax.el.ValueExpression;

/**
 * Represents a method call node in the flow graph.
 * When control passes to a method call node, its {@code MethodExpression} is
 * invoked, passing any parameters.  Let outcome be the value determined
 * by the following algorithm.  If there is a {@code null} return from the invocation, 
 * {@link #getOutcome} is called.  If the result is non-{@code null}, its {@code getValue()} method 
 * is called and the value is considered to be outcome. If there is a non-{@code null} return,
 * let it be outcome.  Convert outcome to a String by calling 
 * its {@code toString} method.  Use outcome to determine the next
 * node in the flow graph.
 * 
 * @since 2.2
 */

public abstract class MethodCallNode extends FlowNode {
    
    /**
     * Return the {@code MethodExpression} to be
     * invoked to when control passes to this node.
     * 
     * @since 2.2
     * 
     * @return the {@code MethodExpression} to be invoked to when control passes to this node
     */
    public abstract MethodExpression getMethodExpression();

    /**
     * Return the {@code outcome} to be
     * used in the event of a {@code null} return from the method.
     * 
     * @since 2.2
     * 
     * @return the {@code outcome}
     */
    public abstract ValueExpression getOutcome();
    
    /**
     * Return the parameters to be passed
     * to the method.
     * 
     * @since 2.2
     * 
     * @return the parameters to be passed to the method
     */
    public abstract List getParameters();

}