• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 package org.apache.velocity.util.introspection;
2 
3 /*
4  * Licensed to the Apache Software Foundation (ASF) under one
5  * or more contributor license agreements.  See the NOTICE file
6  * distributed with this work for additional information
7  * regarding copyright ownership.  The ASF licenses this file
8  * to you under the Apache License, Version 2.0 (the
9  * "License"); you may not use this file except in compliance
10  * with the License.  You may obtain a copy of the License at
11  *
12  *   http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17  * KIND, either express or implied.  See the License for the
18  * specific language governing permissions and limitations
19  * under the License.
20  */
21 
22 import java.lang.reflect.InvocationTargetException;
23 import java.lang.reflect.Method;
24 
25 /**
26  *  Method used for regular method invocation
27  *
28  *    $foo.bar()
29  *
30  *
31  * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
32  * @version $Id$
33  */
34 public interface VelMethod
35 {
36     /**
37      *  invocation method - called when the method invocation should be
38      *  performed and a value returned
39      * @param o
40      * @param params
41      * @return The resulting object.
42      * @throws IllegalAccessException
43      * @throws InvocationTargetException
44      */
invoke(Object o, Object[] params)45     Object invoke(Object o, Object[] params)
46         throws IllegalAccessException, InvocationTargetException;
47 
48     /**
49      *  specifies if this VelMethod is cacheable and able to be
50      *  reused for this class of object it was returned for
51      *
52      *  @return true if can be reused for this class, false if not
53      */
isCacheable()54     boolean isCacheable();
55 
56     /**
57      *  returns the method name used
58      * @return The method name used
59      */
getMethodName()60     String getMethodName();
61 
62     /**
63      * returns the underlying Method
64      * @return the method
65      * @since 2.0
66      */
getMethod()67     Method getMethod();
68 
69     /**
70      *  returns the return type of the method invoked
71      * @return The return type of the method invoked
72      */
getReturnType()73     Class<?> getReturnType();
74 }
75