Reducing duplicate code within the archive helper tool (#1368)

* Moved help option declaration to CommonOptions to reduce duplicate code

* restored sorted options for subcommands

Author: ddsharpe

core/src/main/java/oracle/weblogic/deploy/tool/ArchiveHelper.java

@@ -35,7 +35,6 @@
         ListCommand.class,
         RemoveCommand.class
     },
-    sortOptions = false,
     versionProvider = ArchiveHelperVersionProvider.class
 )
 public class ArchiveHelper {

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/CommonOptions.java

@@ -13,11 +13,8 @@
 import oracle.weblogic.deploy.util.FileUtils;
 import oracle.weblogic.deploy.util.StringUtils;
 import oracle.weblogic.deploy.util.WLSDeployArchive;
-
 import picocli.CommandLine.Option;
-import picocli.CommandLine.Spec;
 import picocli.CommandLine.Unmatched;
-import picocli.CommandLine.Model.CommandSpec;
 
 import static oracle.weblogic.deploy.tool.ArchiveHelper.LOGGER_NAME;
 
@@ -28,8 +25,14 @@ public abstract class CommonOptions {
     @Unmatched
     protected List<String> unmatchedOptions;
 
-    @Spec
-    protected CommandSpec spec;
+    @Option(
+          names = { "-help" },
+          description = "Get help for the ${COMMAND-FULL-NAME} command",
+          usageHelp = true,
+          defaultValue = "false"
+    )
+    @SuppressWarnings("unused")
+    private boolean helpRequested;
 
     @Option(
         names = { "-archive_file" },

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddApplicationCommand.java

@@ -24,8 +24,7 @@
     header = "Add application to the archive file.",
     description = "%nCommand-line options:",
     footer = "%nNote: If using an Application Installation Directory, " +
-        "please see the archiveHelper add structuredApplication command.%n",
-    sortOptions = false
+        "please see the archiveHelper add structuredApplication command.%n"
 )
 public class AddApplicationCommand extends AddTypeCommandBase {
     private static final String CLASS = AddApplicationCommand.class.getName();
@@ -40,13 +39,6 @@ public class AddApplicationCommand extends AddTypeCommandBase {
     )
     private String sourcePath;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add application subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddApplicationPlanCommand.java

@@ -20,8 +20,7 @@
 @Command(
     name = "applicationPlan",
     header = "Add application deployment plan to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddApplicationPlanCommand extends AddTypeCommandBase {
     private static final String CLASS = AddApplicationPlanCommand.class.getName();
@@ -36,13 +35,6 @@ public class AddApplicationPlanCommand extends AddTypeCommandBase {
     )
     private String sourcePath;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add applicationPlan subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddClasspathLibraryCommand.java

@@ -20,8 +20,7 @@
 @Command(
     name = "classpathLibrary",
     header = "Add classpath library to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddClasspathLibraryCommand extends AddTypeCommandBase {
     private static final String CLASS = AddClasspathLibraryCommand.class.getName();
@@ -36,13 +35,6 @@ public class AddClasspathLibraryCommand extends AddTypeCommandBase {
     )
     private String sourcePath;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add classpathLibrary subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddCoherenceConfigCommand.java

@@ -20,8 +20,7 @@
 @Command(
     name = "coherenceConfig",
     header = "Add a Coherence config file to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddCoherenceConfigCommand extends AddTypeCommandBase {
     private static final String CLASS = AddCoherenceConfigCommand.class.getName();
@@ -43,13 +42,6 @@ public class AddCoherenceConfigCommand extends AddTypeCommandBase {
     )
     protected String clusterName;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add coherenceConfig subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddCoherencePersistenceDirCommand.java

@@ -18,8 +18,7 @@
 @Command(
     name = "coherencePersistenceDir",
     header = "Add a Coherence persistence directory to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddCoherencePersistenceDirCommand extends AddTypeCommandBase {
     private static final String CLASS = AddCoherencePersistenceDirCommand.class.getName();
@@ -41,13 +40,6 @@ public class AddCoherencePersistenceDirCommand extends AddTypeCommandBase {
     )
     private String directoryType;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add coherencePersistenceDir subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddCommand.java

@@ -33,8 +33,7 @@
         AddSharedLibraryCommand.class,
         AddSharedLibraryPlanCommand.class,
         AddStructuredApplicationCommand.class,
-    },
-    sortOptions = false
+    }
 )
 public class AddCommand {
     @Option(

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddCustomCommand.java

@@ -22,8 +22,7 @@
 @Command(
     name = "custom",
     header = "Add custom file/directory to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddCustomCommand extends AddTypeCommandBase {
     private static final String CLASS = AddCustomCommand.class.getName();
@@ -45,13 +44,6 @@ public class AddCustomCommand extends AddTypeCommandBase {
     )
     private String archivePath = null;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add custom subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";

core/src/main/java/oracle/weblogic/deploy/tool/archive_helper/add/AddDatabaseWalletCommand.java

@@ -20,8 +20,7 @@
 @Command(
     name = "databaseWallet",
     header = "Add database wallet to the archive file.",
-    description = "%nCommand-line options:",
-    sortOptions = false
+    description = "%nCommand-line options:"
 )
 public class AddDatabaseWalletCommand extends AddTypeCommandBase {
     private static final String CLASS = AddDatabaseWalletCommand.class.getName();
@@ -44,13 +43,6 @@ public class AddDatabaseWalletCommand extends AddTypeCommandBase {
     )
     private String sourcePath;
 
-    @Option(
-        names = { "-help" },
-        description = "Get help for the archiveHelper add databaseWallet subcommand",
-        usageHelp = true
-    )
-    private boolean helpRequested = false;
-
     @Override
     public CommandResponse call() throws Exception {
         final String METHOD = "call";