[java-metadata-aggregator COMMIT] in /trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli: SimpleCommandLi...

noreply at shibboleth.net noreply at shibboleth.net
Fri Mar 23 17:22:33 GMT 2012


Author: iay
Date: Fri Mar 23 17:22:33 2012
New Revision: 203

URL: http://svn.shibboleth.net/view/java-metadata-aggregator?rev=203&view=rev
Log:
Coding conventions pass.

Modified:
    trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLine.java
    trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLineArguments.java

Modified: trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLine.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLine.java?rev=203&r1=202&r2=203&view=diff
==============================================================================
--- trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLine.java (original)
+++ trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLine.java Fri Mar 23 17:22:33 2012
@@ -66,7 +66,7 @@
      * @param args command line arguments
      */
     public static void main(String[] args) {
-        SimpleCommandLineArguments cli = new SimpleCommandLineArguments(args);
+        SimpleCommandLineArguments cli = new SimpleCommandLineArguments();
         cli.parseCommandLineArguments(args);
 
         if (cli.doHelp()) {

Modified: trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLineArguments.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLineArguments.java?rev=203&r1=202&r2=203&view=diff
==============================================================================
--- trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLineArguments.java (original)
+++ trunk/aggregator-cli/src/main/java/net/shibboleth/metadata/cli/SimpleCommandLineArguments.java Fri Mar 23 17:22:33 2012
@@ -22,43 +22,90 @@
 
 import java.io.PrintStream;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 /** Command line arguments for the {@link SimpleCommandLine} command line tool. */
 public class SimpleCommandLineArguments {
 
     // Non-option arguments
-    private String inFile;
-
-    private String pipelineName;
+    
+    /**
+     * Provided input file name for the Spring configuration file.
+     */
+    @Nullable private String inFile;
+
+    /**
+     * Provided name for the pipeline bean to execute.
+     */
+    @Nullable private String pipelineName;
 
     // Logging
+    
+    /**
+     * Verbose logging has been requested.
+     */
     private boolean verbose;
 
-    private CmdLineParser.Option VERBOSE_ARG;
-
+    /**
+     * Option object for the <code>--verbose</code> option.
+     */
+    @Nonnull private final CmdLineParser.Option verboseOption;
+
+    /**
+     * Quiet logging has been requested.
+     */
     private boolean quiet;
 
-    private CmdLineParser.Option QUIET_ARG;
-
-    private String logConfig;
-
-    private CmdLineParser.Option LOG_CONFIG_ARG;
+    /**
+     * Option object for the <code>--quiet</code> option.
+     */
+    @Nonnull private final CmdLineParser.Option quietOption;
+
+    /**
+     * Name of a specific logging configuration, if one has been requested.
+     */
+    @Nullable private String logConfig;
+
+    /**
+     * Option object for the <code>--logConfig</code> option.
+     */
+    @Nonnull private final CmdLineParser.Option logConfigOption;
 
     // Help
+    
+    /**
+     * Help has been requested.
+     */
     private boolean help;
 
-    private CmdLineParser.Option HELP_ARG;
-
-    private CmdLineParser cliParser;
-
-    public SimpleCommandLineArguments(String[] args) {
+    /**
+     * Option object for the <code>--help</code> option.
+     */
+    @Nonnull private final CmdLineParser.Option helpOption;
+
+    /**
+     * The configured command line parser.
+     */
+    @Nonnull private final CmdLineParser cliParser;
+
+    /**
+     * Constructor.
+     */
+    public SimpleCommandLineArguments() {
         cliParser = new CmdLineParser();
 
-        VERBOSE_ARG = cliParser.addBooleanOption("verbose");
-        QUIET_ARG = cliParser.addBooleanOption("quiet");
-        LOG_CONFIG_ARG = cliParser.addStringOption("logConfig");
-        HELP_ARG = cliParser.addBooleanOption("help");
-    }
-
+        verboseOption = cliParser.addBooleanOption("verbose");
+        quietOption = cliParser.addBooleanOption("quiet");
+        logConfigOption = cliParser.addStringOption("logConfig");
+        helpOption = cliParser.addBooleanOption("help");
+    }
+
+    /**
+     * Parse an array of command-line arguments as passed to the main program.
+     *
+     * @param args  array of command-line arguments to parse.
+     */
     public void parseCommandLineArguments(String[] args) {
         try {
             cliParser.parse(args);
@@ -72,40 +119,75 @@
             inFile = otherArgs[0];
             pipelineName = otherArgs[1];
 
-            verbose = (Boolean) cliParser.getOptionValue(VERBOSE_ARG, Boolean.FALSE);

[... 104 lines stripped ...]


More information about the commits mailing list