View Javadoc

1   package org.apache.commons.ognl;
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.util.Map;
23  
24  /**
25   * This interface defines methods for calling methods in a target object. Methods are broken up into static and instance
26   * methods for convenience. indexes into the target object, which must be an array.
27   * 
28   * @author Luke Blanshard (blanshlu@netscape.net)
29   * @author Drew Davidson (drew@ognl.org)
30   */
31  public interface MethodAccessor
32  {
33      /**
34       * Calls the static method named with the arguments given on the class given.
35       * 
36       * @param context expression context in which the method should be called
37       * @param targetClass the object in which the method exists
38       * @param methodName the name of the method
39       * @param args the arguments to the method
40       * @return result of calling the method
41       * @exception OgnlException if there is an error calling the method
42       */
43      Object callStaticMethod( Map<String, Object> context, Class<?> targetClass, String methodName, Object[] args )
44          throws OgnlException;
45  
46      /**
47       * Calls the method named with the arguments given.
48       * 
49       * @param context expression context in which the method should be called
50       * @param target the object in which the method exists
51       * @param methodName the name of the method
52       * @param args the arguments to the method
53       * @return result of calling the method
54       * @exception OgnlException if there is an error calling the method
55       */
56      Object callMethod( Map<String, Object> context, Object target, String methodName, Object[] args )
57          throws OgnlException;
58  }