svn commit: r1024562 - /commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java

[se...@apache.org]

Author: sebb
Date: Wed Oct 20 09:31:15 2010
New Revision: 1024562

URL: http://svn.apache.org/viewvc?rev=1024562&view=rev
Log:
Add a bit of documentation to init method

Modified:
    commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java

Modified: commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java?rev=1024562&r1=1024561&r2=1024562&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java (original)
+++ commons/proper/daemon/trunk/src/java/org/apache/commons/daemon/support/DaemonWrapper.java Wed Oct 20 09:31:15 2010
@@ -59,6 +59,30 @@ public class DaemonWrapper implements Da
 
     /**
      * Called from DaemonLoader on init stage.
+     * <p>
+     * Accepts the following configuration arguments:
+     * <ul>
+     * <li>-daemon-properties: - load DaemonConfiguration properties from the specified file to act as defaults</li>
+     * <li>-start: set start class name</li>
+     * <li>-start-method: set start method name</li>
+     * <li>-stop: set stop class name</li>
+     * <li>-stop-method: set stop method name</li>
+     * <li>-stop-argument: set optional argument to stop method</li>
+     * <li>Anything else is treated as a startup argument</li>
+     * </ul>
+     * <p>
+     * The following "-daemon-properties" are recognised:
+     * <ul>
+     * <li>args (startup argument)</li>
+     * <li>start</li>
+     * <li>start.method</li>
+     * <li>stop</li>
+     * <li>stop.method</li>
+     * <li>stop.args</li>
+     * </ul>
+     * These are used to set the corresponding item if it has not already been
+     * set by the command arguments. <b>However, note that args and stop.args are
+     * appended to any existing values.</b>
      */
     public void init(DaemonContext context)
         throws Exception