1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.jexl.util.introspection;
18
19 import java.util.Iterator;
20
21 /***
22 * 'Federated' introspection/reflection interface to allow the introspection
23 * behavior in Velocity to be customized.
24 *
25 * @since 1.0
26 * @author <a href="mailto:geirm@apache.org">Geir Magusson Jr.</a>
27 * @version $Id: Uberspect.java 398498 2006-05-01 01:48:57Z dion $
28 */
29 public interface Uberspect {
30 /***
31 * Initializer - will be called before use.
32 * @throws Exception on any error.
33 */
34 void init() throws Exception;
35
36 /***
37 * To support iteratives - #foreach().
38 * @param info template info.
39 * @param obj to get the iterator for.
40 * @throws Exception on any error.
41 * @return an iterator over obj.
42 */
43 Iterator getIterator(Object obj, Info info) throws Exception;
44
45 /***
46 * Returns a general method, corresponding to $foo.bar( $woogie ).
47 * @param obj the object
48 * @param method the method name
49 * @param args method arguments
50 * @param info template info
51 * @throws Exception on any error.
52 * @return a {@link VelMethod}.
53 */
54 VelMethod getMethod(Object obj, String method, Object[] args, Info info) throws Exception;
55
56 /***
57 * Property getter - returns VelPropertyGet appropos for #set($foo =
58 * $bar.woogie).
59 * @param obj the object to get the property from.
60 * @param identifier property name
61 * @param info template info
62 * @throws Exception on any error.
63 * @return a {@link VelPropertyGet}.
64 */
65 VelPropertyGet getPropertyGet(Object obj, String identifier, Info info) throws Exception;
66
67 /***
68 * Property setter - returns VelPropertySet appropos for #set($foo.bar =
69 * "geir").
70 * @param obj the object to get the property from.
71 * @param identifier property name
72 * @param arg value to set.
73 * @param info template info
74 * @throws Exception on any error.
75 * @return a {@link VelPropertySet}.
76 */
77 VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info info) throws Exception;
78 }