javax.faces.el.MethodBinding Maven / Gradle / Ivy
/*
* $Id: MethodBinding.java,v 1.13 2007/04/27 22:00:08 ofung Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.el;
import javax.faces.context.FacesContext;
/**
* MethodBinding is an object that can be used
* to call an arbitrary public method, on an instance that is acquired by
* evaluatng the leading portion of a method binding expression via a
* {@link ValueBinding}. An immutable {@link MethodBinding} for a particular
* method binding expression can be acquired by calling the
* createMethodBinding() method of the
* {@link javax.faces.application.Application} instance for this web
* application.
*
*
* @deprecated This has been replaced by {@link javax.el.MethodExpression}.
*/
public abstract class MethodBinding {
/**
* Return the return value (if any) resulting from a call to the
* method identified by this method binding expression, passing it
* the specified parameters, relative to the specified {@link FacesContext}.
*
*
* @param context {@link FacesContext} for the current request
* @param params Array of parameters to be passed to the called method,
* or null for no parameters
*
* @throws EvaluationException if an exception is thrown
* by the called method (the thrown exception must be included as the
* cause property of this exception)
* @throws MethodNotFoundException if no suitable method can be found
* @throws NullPointerException if context
* is null
*/
public abstract Object invoke(FacesContext context, Object params[])
throws EvaluationException, MethodNotFoundException;
/**
* Return the Java class representing the return type from the
* method identified by this method binding expression.
*
* @param context {@link FacesContext} for the current request
*
* @throws MethodNotFoundException if no suitable method can be found
* @throws NullPointerException if context
* is null
*/
public abstract Class getType(FacesContext context)
throws MethodNotFoundException;
/**
* Return the (possibly null) expression String,
* with leading and trailing delimiters, from which this
* MethodBinding was built. The default implementation
* returns null.
*
*/
public String getExpressionString() {
return null;
}
}