1 /*
2 * $Id: MethodBinding.java,v 1.13 2007/04/27 22:00:08 ofung Exp $
3 */
4
5 /*
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
7 *
8 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41
42 package javax.faces.el;
43
44
45 import javax.faces.context.FacesContext;
46
47
48 /**
49 * <p><strong>MethodBinding</strong> is an object that can be used
50 * to call an arbitrary public method, on an instance that is acquired by
51 * evaluatng the leading portion of a method binding expression via a
52 * {@link ValueBinding}. An immutable {@link MethodBinding} for a particular
53 * method binding expression can be acquired by calling the
54 * <code>createMethodBinding()</code> method of the
55 * {@link javax.faces.application.Application} instance for this web
56 * application.</p>
57 *
58 *
59 * @deprecated This has been replaced by {@link javax.el.MethodExpression}.
60 */
61
62 public abstract class MethodBinding {
63
64
65 /**
66 * <p>Return the return value (if any) resulting from a call to the
67 * method identified by this method binding expression, passing it
68 * the specified parameters, relative to the specified {@link FacesContext}.
69 * </p>
70 *
71 * @param context {@link FacesContext} for the current request
72 * @param params Array of parameters to be passed to the called method,
73 * or <code>null</code> for no parameters
74 *
75 * @throws EvaluationException if an exception is thrown
76 * by the called method (the thrown exception must be included as the
77 * <code>cause</code> property of this exception)
78 * @throws MethodNotFoundException if no suitable method can be found
79 * @throws NullPointerException if <code>context</code>
80 * is <code>null</code>
81 */
82 public abstract Object invoke(FacesContext context, Object params[])
83 throws EvaluationException, MethodNotFoundException;
84
85
86 /**
87 * <p>Return the Java class representing the return type from the
88 * method identified by this method binding expression. </p>
89 *
90 * @param context {@link FacesContext} for the current request
91 *
92 * @throws MethodNotFoundException if no suitable method can be found
93 * @throws NullPointerException if <code>context</code>
94 * is <code>null</code>
95 */
96 public abstract Class getType(FacesContext context)
97 throws MethodNotFoundException;
98
99 /**
100 * <p>Return the (possibly <code>null</code>) expression String,
101 * with leading and trailing delimiters, from which this
102 * <code>MethodBinding</code> was built. The default implementation
103 * returns <code>null</code>.</p>
104 *
105 */
106 public String getExpressionString() {
107 return null;
108 }
109
110
111
112 }
Save This Page