View Javadoc

1   /*
2    * Copyright 2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.jexl.util.introspection;
18  
19  
20  import java.util.Iterator;
21  
22  /***
23   * 'Federated' introspection/reflection interface to allow the introspection
24   *  behavior in Velocity to be customized.
25   *
26   * @author <a href="mailto:geirm@apache.org">Geir Magusson Jr.</a>
27   * @version $Id: Uberspect.java,v 1.4 2004/02/28 13:45:21 yoavs Exp $
28   */
29  public interface Uberspect
30  {
31      /***
32       *  Initializer - will be called before use
33       */
34      public void init() throws Exception;
35  
36      /***
37       *  To support iteratives - #foreach()
38       */
39      public Iterator getIterator(Object obj, Info info) throws Exception;
40  
41      /***
42       *  Returns a general method, corresponding to $foo.bar( $woogie )
43       */
44      public VelMethod getMethod(Object obj, String method, Object[] args, Info info) throws Exception;
45  
46      /***
47       * Property getter - returns VelPropertyGet appropos for #set($foo = $bar.woogie)
48       */
49      public VelPropertyGet getPropertyGet(Object obj, String identifier, Info info) throws Exception;
50  
51      /***
52       * Property setter - returns VelPropertySet appropos for #set($foo.bar = "geir")
53       */
54      public VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info info) throws Exception;
55  }