1 files changed, 33 insertions, 15 deletions

diff --git a/src/org/gnunet/util/Program.java b/src/org/gnunet/util/Program.java
index a5cd147..1c7f1b9 100644
--- a/src/org/gnunet/util/Program.java
+++ b/src/org/gnunet/util/Program.java
@@ -21,8 +21,8 @@
 package org.gnunet.util;
 
 import org.apache.log4j.*;
-import org.gnunet.util.getopt.Option;
-import org.gnunet.util.getopt.OptionAction;
+import org.gnunet.util.getopt.Argument;
+import org.gnunet.util.getopt.ArgumentAction;
 import org.gnunet.util.getopt.Parser;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -33,6 +33,8 @@ import java.io.IOException;
 /**
  * Program is the entry point class for everything that uses gnunet services or APIs.
  *
+ * Also specifies the default command line arguments using the org.gnunet.util.getopt annotations.
+ *
  * @see Service
  */
 public abstract class Program {
@@ -42,33 +44,33 @@ public abstract class Program {
 
     protected final Configuration cfg = new Configuration();
 
-    @Option(shortname = "c", longname = "config",
+    @Argument(shortname = "c", longname = "config",
             description = "Path of the configuration file",
             argumentName = "FILENAME",
-            action = OptionAction.STORE_STRING)
+            action = ArgumentAction.STORE_STRING)
     public String cfgFileName;
 
-    @Option(shortname = "h", longname = "help",
+    @Argument(shortname = "h", longname = "help",
             description = "print this help message",
-            action = OptionAction.SET)
+            action = ArgumentAction.SET)
     public boolean printHelp;
 
-    @Option(shortname = "v", longname = "version",
+    @Argument(shortname = "v", longname = "version",
             description = "print version",
-            action = OptionAction.SET)
+            action = ArgumentAction.SET)
     public boolean showVersion;
 
 
-    @Option(shortname = "L", longname = "log",
+    @Argument(shortname = "L", longname = "log",
             description = "configure logging to use LOGLEVEL",
             argumentName = "LOGLEVEL",
-            action = OptionAction.STORE_STRING)
+            action = ArgumentAction.STORE_STRING)
     public String logLevel;
 
-    @Option(shortname = "l", longname = "logfile",
+    @Argument(shortname = "l", longname = "logfile",
             description = "configure logging to write logs to LOGFILE",
             argumentName = "LOGFILE",
-            action = OptionAction.STORE_STRING)
+            action = ArgumentAction.STORE_STRING)
     public String logFile;
 
 
@@ -79,7 +81,7 @@ public abstract class Program {
 
     /**
      * A program with the desired environment for a gnunet utility.
-     * While executing the scheduler is guaranteed to run, command arguments are parsed,
+     * While executing, the scheduler is guaranteed to run, command arguments are parsed,
      * the default configuration is loaded and the DNS Resolver is initialized.
      *
      * @param args array of command line arguments to parse. used to automatically load additional settings
@@ -94,6 +96,12 @@ public abstract class Program {
          */
     }
 
+    /**
+     * Configure logging with the given log level and log file.
+     *
+     * @param logLevel one of DEBUG,INFO,WARN,ERROR,OFF
+     * @param logFile logfile, absolute or relative to the current working directory
+     */
     public static void configureLogging(String logLevel, String logFile) {
         org.apache.log4j.Logger rootLogger = LogManager.getRootLogger();
 
@@ -155,7 +163,7 @@ public abstract class Program {
     /**
      * Start the Program as the initial task of the Scheduler.
      */
-    public void start() {
+    public final void start() {
         Parser optParser = new Parser(this);
         unprocessedArgs = optParser.parse(args);
 
@@ -177,13 +185,23 @@ public abstract class Program {
         } else {
             Scheduler.run(new Scheduler.Task() {
                 public void run(Scheduler.RunContext c) {
-                    Program.this.run();
+                    Program.this.runHook();
                 }
             });
         }
     }
 
     /**
+     * Overridden by specializations of Program, like Service.
+     *
+     * Allows for start() to be final.
+     */
+    /* package-private */
+    void runHook() {
+        run();
+    }
+
+    /**
      * Override to implement the behavior of the Program.
      */
     public abstract void run();