GH-3670: Enable command line processing without requiring exec()

jena-cmds/src/main/java/arq/cmdline/CmdARQ.java

@@ -20,11 +20,11 @@
 
 import org.apache.jena.atlas.lib.Lib;
 import org.apache.jena.cmd.ArgDecl;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.query.ARQ;
 import org.apache.jena.sys.JenaSystem;
 
-public abstract class CmdARQ extends CmdGeneral {
+public abstract class CmdARQ extends CmdMain {
     static {
         JenaSystem.init();
     }

jena-cmds/src/main/java/arq/cmdline/CmdARQ_SSE.java

@@ -23,23 +23,25 @@
 /** Root of read an SSE file and do something */
 public abstract class CmdARQ_SSE extends CmdARQ
 {
-    protected ModItem modItem = new ModItem() ; 
-    
+    protected ModItem modItem = new ModItem() ;
+
     public CmdARQ_SSE(String[] argv)
     {
         super(argv) ;
         super.addModule(modItem) ;
     }
-    
+
     @Override
-    protected String getSummary() { return getCommandName()+" [--file<file> | string]" ; }
+    protected String getSummary() {
+        return getCommandName() + " [--file<file> | string]";
+    }
 
     @Override
     final protected void exec()
     {
         Item item = modItem.getItem() ;
         exec(item) ;
     }
-    
+
     protected abstract void exec(Item item) ;
 }

jena-cmds/src/main/java/arq/qparse.java

@@ -110,11 +110,11 @@ protected void processModulesAndArgs() {
             printQuery = true;
     }
 
-    static String usage = qparse.class.getName() + " [--in syntax] [--out syntax] [--print=FORM] [\"query\"] | --query <file>";
+    static String usageArgs =  "[--in syntax] [--out syntax] [--print=FORM] [\"query\"] | --query <file>";
 
     @Override
     protected String getSummary() {
-        return usage;
+        return getCommandName()+" "+usageArgs;
     }
 
     static final String divider = "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -";

jena-cmds/src/main/java/org/apache/jena/cmd/CmdArgModule.java

@@ -21,7 +21,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public abstract class CmdArgModule extends CmdMain
+public abstract class CmdArgModule extends CmdLineArgs
 {
     private List<ArgModuleGeneral> modules = new ArrayList<>();
 
@@ -34,9 +34,9 @@ protected void addModule(ArgModuleGeneral argModule) {
     }
 
     @Override
-    final public void process() {
+    public void process() {
         super.process();
-        forEach((controller, module) -> module.processArgs(controller));
+        forEach((cmdArgModule, module) -> module.processArgs(cmdArgModule));
         processModulesAndArgs();
     }
 
@@ -48,7 +48,8 @@ private void forEach(Action action) {
         }
     }
 
+    @FunctionalInterface
     interface Action {
-        public void action(CmdArgModule controller, ArgModuleGeneral module);
+        public void action(CmdArgModule cmdArgModule, ArgModuleGeneral module);
     }
 }

jena-cmds/src/main/java/org/apache/jena/cmd/CmdGeneral.java

@@ -21,7 +21,7 @@
 import java.io.PrintStream;
 import org.apache.jena.atlas.io.IndentedWriter;
 // Added usage + some common flags
-// This is the usual starting point for any sub
+// This is the starting point for argument processing.
 
 public abstract class CmdGeneral extends CmdArgModule
 {
@@ -40,9 +40,9 @@ public void addModule(ArgModuleGeneral argModule) {
         argModule.registerWith(this);
     }
 
-    protected boolean isVerbose() { return modGeneral.verbose; }
-    protected boolean isQuiet()   { return modGeneral.quiet; }
-    protected boolean isDebug()   { return modGeneral.debug; }
+    public boolean isVerbose() { return modGeneral.verbose; }
+    public boolean isQuiet()   { return modGeneral.quiet; }
+    public boolean isDebug()   { return modGeneral.debug; }
     protected boolean help()      { return modGeneral.help; }
 
     final public void printHelp() {
@@ -56,9 +56,16 @@ protected void processModulesAndArgs() {
             modVersion.printVersionAndExit();
     }
 
+    public void add(ArgDecl argDecl, String argName, String msg) {
+        add(argDecl);
+        getUsage().addUsage(argName, msg);
+    }
+
     private Usage usage = new Usage();
-    protected String cmdName = null;
+
+    protected String getCommandName() { return null; }
     protected abstract String getSummary();
+
     public void usage() { usage(System.err); }
 
     public void usage(PrintStream pStr) {
@@ -67,10 +74,5 @@ public void usage(PrintStream pStr) {
         usage.output(out);
     }
 
-    public void add(ArgDecl argDecl, String argName, String msg) {
-        add(argDecl);
-        getUsage().addUsage(argName, msg);
-    }
-
     public Usage getUsage() { return usage; }
 }

jena-cmds/src/main/java/org/apache/jena/cmd/CmdLineArgs.java

@@ -31,6 +31,14 @@ public CmdLineArgs(String[] args) {
         super(args);
     }
 
+    public void cmdError(String msg) { cmdError(msg, true);}
+
+    public void cmdError(String msg, boolean exit) {
+        System.err.println(msg);
+        if ( exit )
+            throw new TerminationException(5);
+    }
+
     private boolean processedArgs = false;
 
     // Setup:

jena-cmds/src/main/java/org/apache/jena/cmd/CmdMain.java

@@ -19,22 +19,28 @@
 package org.apache.jena.cmd;
 
 import org.apache.jena.atlas.logging.LogCtl;
-/** Adds main()-like methods
- *
+
+/**
+ * Adds main()-like methods to argument processing.
+ * <p>
+ * Use this class for commands that follow the common pattern of processing arguments
+ * and then executing with no additional intermediate steps.
+ * <p>
  * Usage:
- *    new YourCommand(args).mainAndExit()
- *  which never returns and routes thing to System.exit.
- *  or call
- *     new YourCommand(args).mainMethod()
- *  which should not call System.exit anywhere */
+ * <pre>new YourCommand(args).mainAndExit()</pre>
+ * which never returns and routes to System.exit. or call
+ * <pre>new YourCommand(args).mainMethod()</pre>
+ *
+ * which should not call {@code System.exit} anywhere.
+ */
 
-public abstract class CmdMain extends CmdLineArgs
+public abstract class CmdMain extends CmdGeneral
 {
     // Do this very early so it happens before anything else
     // gets a chance to create a logger.
     static { LogCtl.setLogging(); }
 
-    public CmdMain(String[] args) {
+    protected CmdMain(String[] args) {
         super(args);
     }
 
@@ -81,18 +87,11 @@ public int mainRun(boolean exitOnSuccess, boolean exitOnFailure) {
         return 0;
     }
 
-    protected final void mainMethod() {
-        process();
-        exec();
-    }
 
     protected abstract void exec();
-    protected abstract String getCommandName();
-    public void cmdError(String msg) { cmdError(msg, true);}
 
-    public void cmdError(String msg, boolean exit) {
-        System.err.println(msg);
-        if ( exit )
-            throw new TerminationException(5);
+    protected final void mainMethod() {
+        process();
+        exec();
     }
 }

jena-cmds/src/main/java/rdfpatch/CmdRDFPatch.java

@@ -26,11 +26,11 @@
 import org.apache.jena.atlas.io.IO;
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.sys.JenaSystem;
 
 /** Abstract base class to work on patch files given on the command line */
-public abstract class CmdRDFPatch extends CmdGeneral {
+public abstract class CmdRDFPatch extends CmdMain {
     static {
         LogCtl.setLogging();
         JenaSystem.init();

jena-cmds/src/main/java/riotcmd/CmdLangParse.java

@@ -36,7 +36,7 @@
 import org.apache.jena.atlas.logging.Log;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.irix.IRIException;
 import org.apache.jena.irix.IRIs;
 import org.apache.jena.irix.IRIxResolver;
@@ -54,7 +54,7 @@
 import org.apache.jena.sys.JenaSystem;
 
 /** Common framework for running RIOT parsers */
-public abstract class CmdLangParse extends CmdGeneral {
+public abstract class CmdLangParse extends CmdMain {
     static {
         JenaSystem.init();
     }

jena-cmds/src/main/java/riotcmd/infer.java

@@ -23,7 +23,7 @@
 import org.apache.jena.atlas.io.IO ;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.graph.Graph;
 import org.apache.jena.rdfs.RDFSFactory;
 import org.apache.jena.riot.Lang ;
@@ -78,7 +78,7 @@
     * owl:inverseOf
     * owl:TransitiveProperty
  */
-public class infer extends CmdGeneral
+public class infer extends CmdMain
 {
     static final ArgDecl argRDFS = new ArgDecl(ArgDecl.HasValue, "rdfs") ;
     private Graph vocab ;

jena-cmds/src/main/java/shacl/shacl_parse.java

@@ -30,7 +30,7 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.graph.Graph;
 import org.apache.jena.irix.IRIException;
 import org.apache.jena.irix.IRIs;
@@ -49,7 +49,7 @@
  * <p>
  * Usage: <code>shacl parse FILE</code>
  */
-public class shacl_parse extends CmdGeneral {
+public class shacl_parse extends CmdMain {
     static {
         LogCtl.setLogging();
         JenaSystem.init();

jena-cmds/src/main/java/shacl/shacl_validate.java

@@ -21,7 +21,7 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.graph.Graph;
 import org.apache.jena.graph.Node;
 import org.apache.jena.graph.NodeFactory;
@@ -39,7 +39,7 @@
  * <p>
  * Usage: <code>shacl validate [--text] --shapes SHAPES --data DATA</code>
  */
-public class shacl_validate extends CmdGeneral {
+public class shacl_validate extends CmdMain {
 
     static {
         LogCtl.setLogging();

jena-cmds/src/main/java/shex/shex_parse.java

@@ -30,7 +30,7 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.riot.RiotException;
 import org.apache.jena.shex.Shex;
 import org.apache.jena.shex.ShexSchema;
@@ -42,7 +42,7 @@
  * <p>
  * Usage: <code>shex parse FILE</code>
  */
-public class shex_parse extends CmdGeneral {
+public class shex_parse extends CmdMain {
     static {
         LogCtl.setLogging();
         JenaSystem.init();

jena-cmds/src/main/java/shex/shex_validate.java

@@ -23,7 +23,7 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.graph.Graph;
 import org.apache.jena.graph.Node;
 import org.apache.jena.graph.NodeFactory;
@@ -37,7 +37,7 @@
  * <p>
  * Usage: <code>shex validate [--text] --shapes SHAPES --data DATA</code>
  */
-public class shex_validate extends CmdGeneral {
+public class shex_validate extends CmdMain {
 
     static {
         LogCtl.setLogging();

jena-cmds/src/main/java/tdb/xloader/CmdNodeTableBuilder.java

@@ -26,7 +26,7 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.riot.Lang;
 import org.apache.jena.riot.RDFLanguages;
 import org.apache.jena.sys.JenaSystem;
@@ -36,7 +36,7 @@
 import tdb.cmdline.CmdTDB;
 
 /** Build node table - write triples/quads as text file */
-public class CmdNodeTableBuilder extends CmdGeneral
+public class CmdNodeTableBuilder extends CmdMain
 {
     static {
         LogCtl.setLogging();

jena-cmds/src/main/java/tdb2/xloader/AbstractCmdxLoad.java

@@ -28,15 +28,15 @@
 import org.apache.jena.atlas.logging.LogCtl;
 import org.apache.jena.cmd.ArgDecl;
 import org.apache.jena.cmd.CmdException;
-import org.apache.jena.cmd.CmdGeneral;
+import org.apache.jena.cmd.CmdMain;
 import org.apache.jena.sys.JenaSystem;
 import org.apache.jena.tdb2.xloader.XLoaderFiles;
 
 /**
  * Base class for TDB xloaders commands for java steps in the load process.
  * All steps accept all the same arguments, even if they are not applicable to the stage.
  */
-abstract class AbstractCmdxLoad extends CmdGeneral {
+abstract class AbstractCmdxLoad extends CmdMain {
     static {
         JenaSystem.init();
         LogCtl.setLog4j2();
@@ -79,9 +79,6 @@ protected AbstractCmdxLoad(String stageName, String[] argv) {
 
     protected abstract void setCmdArgs();
 
-    @Override
-    protected abstract String getSummary();
-
     protected String getArgsSummary() {
         return "--loc=DIR --tmpdir=DIR";
     }