javadoc + linelength

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277453 13f79535-47bb-0310-9956-ffa450edef68

src/main/org/apache/tools/ant/dispatch/DispatchTask.java

@@ -1,5 +1,5 @@
 /*
- * Copyright  2004 The Apache Software Foundation
+ * Copyright  2004-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -32,14 +32,26 @@ import org.apache.tools.ant.Task;
 public abstract class DispatchTask extends Task implements Dispatchable {
     private String action;
 
+    /**
+     * Get the action parameter name.
+     * @return the <code>String</code> "action" by default (can be overridden).
+     */
     public String getActionParameterName() {
         return "action";
     }
 
+    /**
+     * Set the action.
+     * @param action the method name.
+     */
     public void setAction(String action) {
         this.action = action;
     }
 
+    /**
+     * Get the action.
+     * @return the action.
+     */
     public String getAction() {
         return action;
     }

src/main/org/apache/tools/ant/dispatch/DispatchUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright  2004 The Apache Software Foundation
+ * Copyright  2004-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -24,11 +24,13 @@ import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
 /**
- * Determines and Executes the action method for the task
+ * Determines and Executes the action method for the task.
  */
 public class DispatchUtils {
     /**
-     * Determines and Executes the action method for the task
+     * Determines and Executes the action method for the task.
+     * @param task the task to execute.
+     * @throws BuildException on error.
      */
     public static final void execute(Object task) throws BuildException {
         String methodName = "execute";
@@ -39,7 +41,9 @@ public class DispatchUtils {
             } else if (task instanceof UnknownElement) {
                 UnknownElement ue = (UnknownElement) task;
                 Object realThing = ue.getRealThing();
-                if (realThing != null && realThing instanceof Dispatchable && realThing instanceof Task) {
+                if (realThing != null
+                    && realThing instanceof Dispatchable
+                    && realThing instanceof Task) {
                     dispatchable = (Dispatchable) realThing;
                 }
             }
@@ -61,9 +65,11 @@ public class DispatchUtils {
                                 if (s != null && s.trim().length() > 0) {
                                     methodName = s.trim();
                                     Method executeM = null;
-                                    executeM = dispatchable.getClass().getMethod(methodName, new Class[0]);
+                                    executeM = dispatchable.getClass().getMethod(
+                                        methodName, new Class[0]);
                                     if (executeM == null) {
-                                        throw new BuildException("No public " + methodName + "() in "
+                                        throw new BuildException(
+                                            "No public " + methodName + "() in "
                                             + dispatchable.getClass());
                                     }
                                     executeM.invoke(dispatchable, (Object[]) null);
@@ -71,16 +77,19 @@ public class DispatchUtils {
                                         ((UnknownElement) task).setRealThing(null);
                                     }
                                 } else {
-                                    throw new BuildException("Dispatchable Task attribute '" + name.trim()
-                                            + "' not set or value is empty.");
+                                    throw new BuildException(
+                                        "Dispatchable Task attribute '" + name.trim()
+                                        + "' not set or value is empty.");
                                 }
                             } else {
-                                    throw new BuildException("Dispatchable Task attribute '" + name.trim()
-                                            + "' not set or value is empty.");
+                                    throw new BuildException(
+                                        "Dispatchable Task attribute '" + name.trim()
+                                        + "' not set or value is empty.");
                             }
                         }
                     } else {
-                        throw new BuildException("Action Parameter Name must not be empty for Dispatchable Task.");
+                        throw new BuildException(
+                            "Action Parameter Name must not be empty for Dispatchable Task.");
                     }
                 } catch (NoSuchMethodException nsme) {
                     throw new BuildException("No public " + mName + "() in " + task.getClass());

src/main/org/apache/tools/ant/dispatch/Dispatchable.java

@@ -1,5 +1,5 @@
 /*
- * Copyright  2004 The Apache Software Foundation
+ * Copyright  2004-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -22,5 +22,9 @@ package org.apache.tools.ant.dispatch;
  * of the task's method to execute.
  */
 public interface Dispatchable {
-    public String getActionParameterName();
-}
+    /**
+     * Get the name of the parameter.
+     * @return the name of the parameter that contains the name of the method.
+     */
+    String getActionParameterName();
+}