From bfdaab64460a3adef3ed45e5bf69a581ff8c4f58 Mon Sep 17 00:00:00 2001 From: Sander Fieten Date: Fri, 1 Mar 2024 16:37:55 +0100 Subject: [PATCH] Update documentation --- .../ui/app/cli/CommandLineArguments.java | 80 +++++++++---------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/modules/holodeckb2b-ui/src/main/java/org/holodeckb2b/ui/app/cli/CommandLineArguments.java b/modules/holodeckb2b-ui/src/main/java/org/holodeckb2b/ui/app/cli/CommandLineArguments.java index d38312bdd..4b421bb62 100644 --- a/modules/holodeckb2b-ui/src/main/java/org/holodeckb2b/ui/app/cli/CommandLineArguments.java +++ b/modules/holodeckb2b-ui/src/main/java/org/holodeckb2b/ui/app/cli/CommandLineArguments.java @@ -23,41 +23,41 @@ /** * Utility class for parsing the command line arguments. - * + * * @author Sander Fieten (sander at holodeck-b2b.org) * @since 5.0.0 */ public class CommandLineArguments { /** - * Represents the options that can be supplied for a command. Consists of the command line flag, an indication + * Represents the options that can be supplied for a command. Consists of the command line flag, an indication * whether the option is required (not really an option then ;-) ) and a short description used when printing help * instruction. */ - static class Option { + static class Option { String flag, description; boolean isRequired; - - Option(String f, boolean r, String d) { + + Option(String f, boolean r, String d) { this.flag = f; this.isRequired = r; - this.description = d; - } + this.description = d; + } } - + final static Option PORT_OPTION = new Option("-p", false, "The RMI port used by the Holodeck B2B instance"); - + final static Option PRT_PMODE_ID = new Option("-id", true , "The identifier of the P-Mode to print"); final static Option FORMAT = new Option("-format", false , "The level of details that should be included (simple [default] or detailed)"); final static Option CERT_ALIAS = new Option("-alias", true , "The alias of the certificate to print"); final static Option CERT_TYPE = new Option("-type", true , "The type of the certificate to print (private, partner or trusted)"); - + final static Option MESSAGE_ID = new Option("-messageId", true , "The MessageId of the message unit"); - + final static Option FROM = new Option("-from", false, "The time stamp from which to start listing the message units. Default current time"); final static Option MAX = new Option("-max", false, "Max number of message units to list. Default 10"); - + /** * Enumeration of all actions that can be used as argument when invoking the app. Each command contains the name * of the command, the list of available options and a short description used for printing a help instruction. @@ -69,81 +69,81 @@ enum Action { PRINT_CERT("printCert", new Option[] { PORT_OPTION, CERT_ALIAS, CERT_TYPE } , "Prints the details of a certificate"), MSG_STATUS("msgStatus", new Option[] { PORT_OPTION, MESSAGE_ID } , "Gets the current processing state of a message unit"), STATUS_LIST("statusList", new Option[] { PORT_OPTION, MESSAGE_ID } , "Lists of processing states a message unit was and is in"), - HISTORY("history", new Option[] { PORT_OPTION, FROM, MAX } , "Provides overview of message units in descending order, sorted by time stamp"); - + HISTORY("history", new Option[] { PORT_OPTION, FROM, MAX } , "Provides overview of message units in descending order of latest proc state's start time"); + String name; Option[] options; - String description; + String description; Action(String name, Option[] options, String description) { this.name = name; this.options = options; - this.description = description; + this.description = description; } } - + /** - * The requested action to execute and its parameter + * The requested action to execute and its parameter */ private Action curAction; private Map parameters; - + /** * Parses the arguments provided to the current invocation of the application. - * + * * @param clArgs The arguments provided on invocation * @throws IllegalArgumentException When a required option is not provided or when an unknown argument is provided */ public CommandLineArguments(String[] clArgs) throws IllegalArgumentException { if (clArgs.length == 0) throw new IllegalArgumentException("No action specified"); - + for (Action action : Action.values()) { if (action.name.equals(clArgs[0])) - curAction = action; + curAction = action; } - if (curAction == null) + if (curAction == null) throw new IllegalArgumentException(clArgs[0] + " not recognized as valid action."); - + // Parse the remainder of command line to find parameters parameters = new HashMap<>(curAction.options.length); for (int i = 1; i < clArgs.length - 1; i++) { Option o = null; - for (int j = 0; j < curAction.options.length && o == null; j++) - if (curAction.options[j].flag.equals(clArgs[i])) + for (int j = 0; j < curAction.options.length && o == null; j++) + if (curAction.options[j].flag.equals(clArgs[i])) // Found a valid option of this command o = curAction.options[j]; if (o != null) - parameters.put(o.flag, clArgs[++i]); + parameters.put(o.flag, clArgs[++i]); } // Now check that all required options were provided boolean arp = true; for (int i = 0; i < curAction.options.length && arp; i++) arp &= !curAction.options[i].isRequired || parameters.containsKey(curAction.options[i].flag); - if (!arp) + if (!arp) throw new IllegalArgumentException("Not all required options for action " + curAction.name + "provided!"); } - + /** * Gets the action that was specified as argument when invoking the application. - * + * * @return The requested action to execute */ public Action getAction() { - return curAction; + return curAction; } - + /** * Gets the value for the action's parameter as specified on the command line when invoking the application. - * - * @param opt The parameter's flag which value to get, expressed as {@link Option} + * + * @param opt The parameter's flag which value to get, expressed as {@link Option} * @return The value for the action's parameter */ - public String getParameter(final Option opt) { + public String getParameter(final Option opt) { return parameters.get(opt.flag); } - + /** * Prints a simple "usage" message to the console. */ @@ -153,15 +153,15 @@ public static void printUsage() { System.out.println("Usage: nc1701a [options...]"); System.out.println(); System.out.println("Available actions:"); - for (Action a : Action.values()) - System.out.printf("\t%-20s %s%n", a.name, a.description); + for (Action a : Action.values()) + System.out.printf("\t%-20s %s%n", a.name, a.description); System.out.println(); System.out.println("Available options for actions:"); for (Action a : Action.values()) { System.out.println(); System.out.println(a.name); - for (Option o : a.options) - System.out.printf("\t%-20s %s%n", !o.isRequired ? "[" + o.flag + "]" : o.flag, o.description); + for (Option o : a.options) + System.out.printf("\t%-20s %s%n", !o.isRequired ? "[" + o.flag + "]" : o.flag, o.description); } }