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 /**
23 * Method used for regular method invocation
24 *
25 * $foo.bar()
26 *
27 *
28 * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
29 * @version $Id: VelMethod.java 463298 2006-10-12 16:10:32Z henning $
30 */
31 public interface VelMethod
32 {
33 /**
34 * invocation method - called when the method invocationshould be
35 * preformed and a value returned
36 * @param o
37 * @param params
38 * @return The resulting object.
39 * @throws Exception
40 */
41 public Object invoke(Object o, Object[] params)
42 throws Exception;
43
44 /**
45 * specifies if this VelMethod is cacheable and able to be
46 * reused for this class of object it was returned for
47 *
48 * @return true if can be reused for this class, false if not
49 */
50 public boolean isCacheable();
51
52 /**
53 * returns the method name used
54 * @return The method name used
55 */
56 public String getMethodName();
57
58 /**
59 * returns the return type of the method invoked
60 * @return The return type of the method invoked
61 */
62 public Class getReturnType();
63 }