svn commit: r398498 - /jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java

[di...@apache.org]

Author: dion
Date: Sun Apr 30 18:48:57 2006
New Revision: 398498

URL: http://svn.apache.org/viewcvs?rev=398498&view=rev
Log:
Checkstyle

Modified:
    jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java

Modified: jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java?rev=398498&r1=398497&r2=398498&view=diff
==============================================================================
--- jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java (original)
+++ jakarta/commons/proper/jexl/trunk/src/java/org/apache/commons/jexl/util/introspection/Uberspect.java Sun Apr 30 18:48:57 2006
@@ -29,28 +29,50 @@
 public interface Uberspect {
     /**
      * Initializer - will be called before use.
+     * @throws Exception on any error.
      */
     void init() throws Exception;
 
     /**
      * To support iteratives - #foreach().
+     * @param info template info.
+     * @param obj to get the iterator for.
+     * @throws Exception on any error.
+     * @return an iterator over obj.
      */
     Iterator getIterator(Object obj, Info info) throws Exception;
 
     /**
      * Returns a general method, corresponding to $foo.bar( $woogie ).
+     * @param obj the object
+     * @param method the method name
+     * @param args method arguments
+     * @param info template info
+     * @throws Exception on any error.
+     * @return a {@link VelMethod}.
      */
     VelMethod getMethod(Object obj, String method, Object[] args, Info info) throws Exception;
 
     /**
      * Property getter - returns VelPropertyGet appropos for #set($foo =
      * $bar.woogie).
+     * @param obj the object to get the property from.
+     * @param identifier property name
+     * @param info template info
+     * @throws Exception on any error.
+     * @return a {@link VelPropertyGet}.
      */
     VelPropertyGet getPropertyGet(Object obj, String identifier, Info info) throws Exception;
 
     /**
      * Property setter - returns VelPropertySet appropos for #set($foo.bar =
      * "geir").
+     * @param obj the object to get the property from.
+     * @param identifier property name
+     * @param arg value to set.
+     * @param info template info
+     * @throws Exception on any error.
+     * @return a {@link VelPropertySet}.
      */
     VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info info) throws Exception;
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org