[jboss-svn-commits] JBoss Common SVN: r4168 - invokablecontainer/trunk/api/src/main/java/org/jboss/invokable.

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

Author: david.lloyd at jboss.com
Date: 2010-03-11 09:04:25 -0500 (Thu, 11 Mar 2010)
New Revision: 4168

Modified:
   invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationDispatcher.java
   invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationException.java
   invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationPermission.java
   invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ObjectInvocationDispatcher.java
   invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ProxyInvocationHandler.java
Log:
Javadoc

Modified: invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationDispatcher.java
===================================================================
--- invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationDispatcher.java	2010-03-11 13:59:20 UTC (rev 4167)
+++ invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationDispatcher.java	2010-03-11 14:04:25 UTC (rev 4168)
@@ -22,26 +22,25 @@
 package org.jboss.invokable;
 
 /**
- * Invokable
- * <p/>
- * Contract of an endpoint servicing incoming invocations.  For instance, implementations may either handle directly, or
+ * Contract of an dispatcher servicing incoming invocations.  For instance, implementations may either handle directly, or
  * delegate to an underlying bean instance.
  *
  * @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
+ * @author <a href="mailto:david.lloyd at redhat.com">David M. Lloyd</a>
  * @version $Revision: $
  */
 public interface InvocationDispatcher {
 
     /**
-     * Carries out the specified invocation, returning the result
+     * Carries out the specified invocation, returning the result.
      *
-     * @param invocation
+     * @param invocation the invocation to execute
      *
-     * @return
+     * @return the result
      *
-     * @throws InvocationException If the underlying invocation resulted in some Exception; the true context may be
+     * @throws InvocationException If the underlying invocation resulted in some Exception; the original exception may be
      * obtained via {@link InvocationException#getCause()}
-     * @throws IllegalArgumentException If the invocation is not specified
+     * @throws IllegalArgumentException If the invocation is not specified (i.e. {@code null})
      */
     Object dispatch(Invocation invocation) throws InvocationException;
 }

Modified: invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationException.java
===================================================================
--- invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationException.java	2010-03-11 13:59:20 UTC (rev 4167)
+++ invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationException.java	2010-03-11 14:04:25 UTC (rev 4168)
@@ -22,12 +22,11 @@
 package org.jboss.invokable;
 
 /**
- * InvocationException
- * <p/>
- * Represents some exceptional circumstance has occurred while carrying out an invocation.  The underlying problem is
+ * Represents some exceptional circumstance which has occurred while carrying out an invocation.  The underlying problem is
  * represented in the wrapped cause, which is required at construction.
  *
  * @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
+ * @author <a href="mailto:david.lloyd at redhat.com">David M. Lloyd</a>
  * @version $Revision: $
  */
 public class InvocationException extends Exception {

Modified: invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationPermission.java
===================================================================
--- invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationPermission.java	2010-03-11 13:59:20 UTC (rev 4167)
+++ invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/InvocationPermission.java	2010-03-11 14:04:25 UTC (rev 4168)
@@ -26,6 +26,8 @@
 
 /**
  * The basic permission type for invocations.
+ *
+ * @author <a href="mailto:david.lloyd at redhat.com">David M. Lloyd</a>
  */
 public final class InvocationPermission extends BasicPermission {
 

Modified: invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ObjectInvocationDispatcher.java
===================================================================
--- invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ObjectInvocationDispatcher.java	2010-03-11 13:59:20 UTC (rev 4167)
+++ invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ObjectInvocationDispatcher.java	2010-03-11 14:04:25 UTC (rev 4168)
@@ -30,6 +30,8 @@
 
 /**
  * An {@code InvocationDispatcher} which executes the invocation method on a target object.
+ *
+ * @author <a href="mailto:david.lloyd at redhat.com">David M. Lloyd</a>
  */
 public final class ObjectInvocationDispatcher implements Serializable, InvocationDispatcher {
 

Modified: invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ProxyInvocationHandler.java
===================================================================
--- invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ProxyInvocationHandler.java	2010-03-11 13:59:20 UTC (rev 4167)
+++ invokablecontainer/trunk/api/src/main/java/org/jboss/invokable/ProxyInvocationHandler.java	2010-03-11 14:04:25 UTC (rev 4168)
@@ -31,6 +31,8 @@
 
 /**
  * A proxy {@code InvocationHandler} which delegates invocations to an {@code InvocationDispatcher}.
+ *
+ * @author <a href="mailto:david.lloyd at redhat.com">David M. Lloyd</a>
  */
 public final class ProxyInvocationHandler implements InvocationHandler, Serializable {