Better help printout

Author: yatharthranjan

src/main/java/org/radarcns/RestructureAvroRecords.java

@@ -80,8 +80,14 @@ public class RestructureAvroRecords {
 
     public static void main(String [] args) throws Exception {
 
-        parser.setProgramName("hadoop jar restructurehdfs-all-0.3.2.jar");
+        parser.setProgramName("hadoop jar restructurehdfs-all-0.3.3.jar");
         parser.parse(args);
+
+        if(commandLineArgs.help) {
+            parser.usage();
+            System.exit(0);
+        }
+
         USE_GZIP = "gzip".equalsIgnoreCase(commandLineArgs.compression);
         DO_DEDUPLICATE = commandLineArgs.deduplicate;
 

src/main/java/org/radarcns/util/commandline/BooleanValidator.java

@@ -7,10 +7,11 @@ public class BooleanValidator implements IParameterValidator{
 
     @Override
     public void validate(String name, String value) throws ParameterException {
-        if(!value.equalsIgnoreCase("true") && !value.equalsIgnoreCase("false")) {
-            ParameterException exc = new ParameterException("Parameter " + name + " can only be true or false (found " + value +")");
-            exc.usage();
-            throw exc;
+        if(!value.equalsIgnoreCase("true")
+                && !value.equalsIgnoreCase("false")) {
+            throw new ParameterException("Parameter " + name + " can only be true or "
+                    + "false (found " + value +"). "
+                    + "Please run with --help or -h for more information.");
         }
     }
 }

src/main/java/org/radarcns/util/commandline/CommandLineArgs.java

@@ -3,7 +3,7 @@
 import com.beust.jcommander.Parameter;
 
 public class CommandLineArgs {
-    @Parameter(names = { "-c", "--compression" }, description = "Compression to use when converting the files. Default is none. Gzip is available.")
+    @Parameter(names = { "-c", "--compression" }, description = "Compression to use when converting the files. Gzip is available.")
     public String compression = "none";
 
     // Default set to false because causes loss of records from Biovotion data. https://github.com/RADAR-base/Restructure-HDFS-topic/issues/16
@@ -19,6 +19,6 @@ public class CommandLineArgs {
     @Parameter(names = { "-o", "--output-directory"}, description = "The output folder where the files are to be extracted.", required = true, validateWith = PathValidator.class)
     public String outputDirectory;
 
-    @Parameter(names = { "-h", "--help"}, help = true)
+    @Parameter(names = { "-h", "--help"}, help = true, description = "Display the usage of the program with available options.")
     public boolean help;
 }

src/main/java/org/radarcns/util/commandline/HdfsUriValidator.java

@@ -8,9 +8,9 @@ public class HdfsUriValidator implements IParameterValidator{
     @Override
     public void validate(String name, String value) throws ParameterException {
         if (! value.matches("((hdfs)|(webhdfs)):(/?/?)[^\\s]+")) {
-            ParameterException exc = new ParameterException("Parameter " + name + " should be a valid HDFS or WebHDFS URI. Eg - hdfs://<HOST>:<RPC_PORT>/<PATH>. (found " + value +")");
-            exc.usage();
-            throw exc;
+            throw new ParameterException("Parameter " + name + " should be a valid HDFS or WebHDFS URI. "
+                    + "Eg - hdfs://<HOST>:<RPC_PORT>/<PATH>. (found " + value
+                    + "). Please run with --help or -h for more information.");
         }
     }
 }

src/main/java/org/radarcns/util/commandline/PathValidator.java

@@ -7,9 +7,9 @@ public class PathValidator implements IParameterValidator{
     @Override
     public void validate(String name, String value) throws ParameterException {
         if (value == null || value.isEmpty()) {
-            ParameterException exc =  new ParameterException("Parameter " + name + " should be supplied. It cannot be empty or null. (found " + value +")");
-            exc.usage();
-            throw exc;
+            throw new ParameterException("Parameter " + name + " should be supplied. "
+                    + "It cannot be empty or null. (found " + value +")."
+                    + "Please run with --help or -h for more information.");
         }
     }
 }