svn commit: r629931 - /commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java

[jc...@apache.org]

Author: jcarman
Date: Thu Feb 21 10:51:18 2008
New Revision: 629931

URL: http://svn.apache.org/viewvc?rev=629931&view=rev
Log:
Added javadocs

Modified:
    commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java

Modified: commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java
URL: http://svn.apache.org/viewvc/commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java?rev=629931&r1=629930&r2=629931&view=diff
==============================================================================
--- commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java (original)
+++ commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/Invocation.java Thu Feb 21 10:51:18 2008
@@ -27,8 +27,30 @@
  */
 public interface Invocation
 {
+    /**
+     * Returns the method being called.
+     * @return the method being called
+     */
     public Method getMethod();
+
+    /**
+     * Returns the arguments being passed to this method invocation.  Changes in the elements of this array will be
+     * propagated to the recipient of this invocation.
+     * 
+     * @return the arguments being passed to this method invocation
+     */
     public Object[] getArguments();
+
+    /**
+     * Returns the proxy object on which this invocation was invoked.
+     * @return the proxy object on which this invocation was invoked
+     */
     public Object getProxy();
+
+    /**
+     * Called in order to let the invocation proceed.
+     * @return the return value of the invocation
+     * @throws Throwable any exception or error that was thrown as a result of this invocation
+     */
     public Object proceed() throws Throwable;
 }