[jboss-cvs] JBossAS SVN: r63471 - projects/aop/trunk/aop/src/main/org/jboss/aop/advice/annotation.

[jboss-cvs-commits at lists.jboss.org]

Author: flavia.rainone at jboss.com
Date: 2007-06-12 09:51:10 -0400 (Tue, 12 Jun 2007)
New Revision: 63471

Modified:
   projects/aop/trunk/aop/src/main/org/jboss/aop/advice/annotation/Args.java
Log:
[JBAOP-389] Added javadoc describing when an Args array is null.

Modified: projects/aop/trunk/aop/src/main/org/jboss/aop/advice/annotation/Args.java
===================================================================
--- projects/aop/trunk/aop/src/main/org/jboss/aop/advice/annotation/Args.java	2007-06-12 13:37:23 UTC (rev 63470)
+++ projects/aop/trunk/aop/src/main/org/jboss/aop/advice/annotation/Args.java	2007-06-12 13:51:10 UTC (rev 63471)
@@ -29,10 +29,22 @@
 
 /**
  * Use this annotation on the advice parameter that receives the complete list of
- * joinpoint argument values.
+ * joinpoint argument values.<br>
  * The annotated parameter must be of type <code>Object[]</code> and there
  * should not be any other advice parameter annotated either with {@link Arg} or
- * with <code>Args</code> itself.
+ * with <code>Args</code> itself.<br>
+ * For procedure executions and calls, this parameter will contain the arguments
+ * of the execution or call, in the same order they occur in the intercepted
+ * code. For interception of field write joinpoints, it will
+ * contain a single element: the value of the field write. For field read joinpoints,
+ * this parameter value will always be <code>null</code>.
+ * <br>
+ * Notice that primitive argument values are converted to their respective wrappers.
+ * <br>
+ * Any change that the advice performs on this parameter will be reflected on the
+ * next advices in the stack, and on the joinpoint itself (unless the advice performs
+ * a change after the joinpoint execution). Such a change must be compatible to
+ * the joinpoint argument types.
  * 
  * @author Flavia Rainone
  */