Javadoc

garydgregory · garydgregory · commit 0ef219a7774d · 2023-08-14T12:18:23.000-04:00
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -35,19 +35,21 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * Additionally, any left-over or unrecognized arguments, are available for further processing.
  */
 public class CommandLine implements Serializable {
+
     /**
      * A nested builder class to create {@code CommandLine} instance using descriptive methods.
      *
      * @since 1.4
      */
     public static final class Builder {
+
         /**
          * CommandLine that is being build by this Builder.
          */
         private final CommandLine commandLine = new CommandLine();
 
         /**
-         * Add left-over unrecognized option/argument.
+         * Adds left-over unrecognized option/argument.
          *
          * @param arg the unrecognized option/argument.
          *
@@ -59,7 +61,7 @@ public Builder addArg(final String arg) {
         }
 
         /**
-         * Add an option to the command line. The values of the option are stored.
+         * Adds an option to the command line. The values of the option are stored.
          *
          * @param opt the processed option.
          *
@@ -92,7 +94,7 @@ protected CommandLine() {
     }
 
     /**
-     * Add left-over unrecognized option/argument.
+     * Adds left-over unrecognized option/argument.
      *
      * @param arg the unrecognized option/argument.
      */
@@ -101,7 +103,7 @@ protected void addArg(final String arg) {
     }
 
     /**
-     * Add an option to the command line. The values of the option are stored.
+     * Adds an option to the command line. The values of the option are stored.
      *
      * @param opt the processed option.
      */
@@ -110,7 +112,7 @@ protected void addOption(final Option opt) {
     }
 
     /**
-     * Retrieve any left-over non-recognized options and arguments
+     * Gets any left-over non-recognized options and arguments
      *
      * @return remaining items passed in but not parsed as a {@code List}.
      */
@@ -119,7 +121,7 @@ public List<String> getArgList() {
     }
 
     /**
-     * Retrieve any left-over non-recognized options and arguments
+     * Gets any left-over non-recognized options and arguments
      *
      * @return remaining items passed in but not parsed as an array.
      */
@@ -128,7 +130,7 @@ public String[] getArgs() {
     }
 
     /**
-     * Return the {@code Object} type of this {@code Option}.
+     * Gets the {@code Object} type of this {@code Option}.
      *
      * @deprecated due to System.err message. Instead use getParsedOptionValue(char)
      * @param opt the name of the option.
@@ -140,7 +142,7 @@ public Object getOptionObject(final char opt) {
     }
 
     /**
-     * Return the {@code Object} type of this {@code Option}.
+     * Gets the {@code Object} type of this {@code Option}.
      *
      * @param opt the name of the option.
      * @return the type of this {@code Option}.
@@ -157,7 +159,7 @@ public Object getOptionObject(final String opt) {
     }
 
     /**
-     * Retrieve the map of values associated to the option. This is convenient for options specifying Java properties like
+     * Gets the map of values associated to the option. This is convenient for options specifying Java properties like
      * <code>-Dparam1=value1
      * -Dparam2=value2</code>. The first argument of the option is the key, and the 2nd argument is the value. If the option
      * has only one argument ({@code -Dfoo}) it is considered as a boolean flag and the value is {@code "true"}.
@@ -186,7 +188,7 @@ public Properties getOptionProperties(final Option option) {
     }
 
     /**
-     * Retrieve the map of values associated to the option. This is convenient for options specifying Java properties like
+     * Gets the map of values associated to the option. This is convenient for options specifying Java properties like
      * <code>-Dparam1=value1
      * -Dparam2=value2</code>. The first argument of the option is the key, and the 2nd argument is the value. If the option
      * has only one argument ({@code -Dfoo}) it is considered as a boolean flag and the value is {@code "true"}.
@@ -224,7 +226,7 @@ public Option[] getOptions() {
     }
 
     /**
-     * Retrieve the first argument, if any, of this option.
+     * Gets the first argument, if any, of this option.
      *
      * @param opt the character name of the option.
      * @return Value of the argument if option is set, and has an argument, otherwise null.
@@ -234,7 +236,7 @@ public String getOptionValue(final char opt) {
     }
 
     /**
-     * Retrieve the argument, if any, of an option.
+     * Gets the argument, if any, of an option.
      *
      * @param opt character name of the option
      * @param defaultValue is the default value to be returned if the option is not specified.
@@ -245,7 +247,7 @@ public String getOptionValue(final char opt, final String defaultValue) {
     }
 
     /**
-     * Retrieve the first argument, if any, of this option.
+     * Gets the first argument, if any, of this option.
      *
      * @param option the name of the option.
      * @return Value of the argument if option is set, and has an argument, otherwise null.
@@ -260,7 +262,7 @@ public String getOptionValue(final Option option) {
     }
 
     /**
-     * Retrieve the first argument, if any, of an option.
+     * Gets the first argument, if any, of an option.
      *
      * @param option name of the option.
      * @param defaultValue is the default value to be returned if the option is not specified.
@@ -273,7 +275,7 @@ public String getOptionValue(final Option option, final String defaultValue) {
     }
 
     /**
-     * Retrieve the first argument, if any, of this option.
+     * Gets the first argument, if any, of this option.
      *
      * @param opt the name of the option.
      * @return Value of the argument if option is set, and has an argument, otherwise null.
@@ -283,7 +285,7 @@ public String getOptionValue(final String opt) {
     }
 
     /**
-     * Retrieve the first argument, if any, of an option.
+     * Gets the first argument, if any, of an option.
      *
      * @param opt name of the option.
      * @param defaultValue is the default value to be returned if the option is not specified.
@@ -294,7 +296,7 @@ public String getOptionValue(final String opt, final String defaultValue) {
     }
 
     /**
-     * Retrieves the array of values, if any, of an option.
+     * Gets the array of values, if any, of an option.
      *
      * @param opt character name of the option.
      * @return Values of the argument if option is set, and has an argument, otherwise null.
@@ -304,7 +306,7 @@ public String[] getOptionValues(final char opt) {
     }
 
     /**
-     * Retrieves the array of values, if any, of an option.
+     * Gets the array of values, if any, of an option.
      *
      * @param option string name of the option.
      * @return Values of the argument if option is set, and has an argument, otherwise null.
@@ -323,7 +325,7 @@ public String[] getOptionValues(final Option option) {
     }
 
     /**
-     * Retrieves the array of values, if any, of an option.
+     * Gets the array of values, if any, of an option.
      *
      * @param opt string name of the option.
      * @return Values of the argument if option is set, and has an argument, otherwise null.
@@ -333,7 +335,7 @@ public String[] getOptionValues(final String opt) {
     }
 
     /**
-     * Return a version of this {@code Option} converted to a particular type.
+     * Gets a version of this {@code Option} converted to a particular type.
      *
      * @param opt the name of the option.
      * @return the value parsed into a particular object.
@@ -346,7 +348,7 @@ public Object getParsedOptionValue(final char opt) throws ParseException {
     }
 
     /**
-     * Return a version of this {@code Option} converted to a particular type.
+     * Gets a version of this {@code Option} converted to a particular type.
      *
      * @param option the name of the option.
      * @return the value parsed into a particular object.
@@ -366,7 +368,7 @@ public Object getParsedOptionValue(final Option option) throws ParseException {
     }
 
     /**
-     * Return a version of this {@code Option} converted to a particular type.
+     * Gets a version of this {@code Option} converted to a particular type.
      *
      * @param opt the name of the option.
      * @return the value parsed into a particular object.

Original file line number	Diff line number	Diff line change
`@@ -35,19 +35,21 @@ Licensed to the Apache Software Foundation (ASF) under one or more`
`35`	`35`	`* Additionally, any left-over or unrecognized arguments, are available for further processing.`
`36`	`36`	`*/`
`37`	`37`	`public class CommandLine implements Serializable {`
	`38`	`+`
`38`	`39`	`/**`
`39`	`40`	`* A nested builder class to create {@code CommandLine} instance using descriptive methods.`
`40`	`41`	`*`
`41`	`42`	`* @since 1.4`
`42`	`43`	`*/`
`43`	`44`	`public static final class Builder {`
	`45`	`+`
`44`	`46`	`/**`
`45`	`47`	`* CommandLine that is being build by this Builder.`
`46`	`48`	`*/`
`47`	`49`	`private final CommandLine commandLine = new CommandLine();`
`48`	`50`
`49`	`51`	`/**`
`50`		`- * Add left-over unrecognized option/argument.`
	`52`	`+ * Adds left-over unrecognized option/argument.`
`51`	`53`	`*`
`52`	`54`	`* @param arg the unrecognized option/argument.`
`53`	`55`	`*`
`@@ -59,7 +61,7 @@ public Builder addArg(final String arg) {`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`/**`
`62`		`- * Add an option to the command line. The values of the option are stored.`
	`64`	`+ * Adds an option to the command line. The values of the option are stored.`
`63`	`65`	`*`
`64`	`66`	`* @param opt the processed option.`
`65`	`67`	`*`
`@@ -92,7 +94,7 @@ protected CommandLine() {`
`92`	`94`	`}`
`93`	`95`
`94`	`96`	`/**`
`95`		`- * Add left-over unrecognized option/argument.`
	`97`	`+ * Adds left-over unrecognized option/argument.`
`96`	`98`	`*`
`97`	`99`	`* @param arg the unrecognized option/argument.`
`98`	`100`	`*/`
`@@ -101,7 +103,7 @@ protected void addArg(final String arg) {`
`101`	`103`	`}`
`102`	`104`
`103`	`105`	`/**`
`104`		`- * Add an option to the command line. The values of the option are stored.`
	`106`	`+ * Adds an option to the command line. The values of the option are stored.`
`105`	`107`	`*`
`106`	`108`	`* @param opt the processed option.`
`107`	`109`	`*/`
`@@ -110,7 +112,7 @@ protected void addOption(final Option opt) {`
`110`	`112`	`}`
`111`	`113`
`112`	`114`	`/**`
`113`		`- * Retrieve any left-over non-recognized options and arguments`
	`115`	`+ * Gets any left-over non-recognized options and arguments`
`114`	`116`	`*`
`115`	`117`	`* @return remaining items passed in but not parsed as a {@code List}.`
`116`	`118`	`*/`
`@@ -119,7 +121,7 @@ public List<String> getArgList() {`
`119`	`121`	`}`
`120`	`122`
`121`	`123`	`/**`
`122`		`- * Retrieve any left-over non-recognized options and arguments`
	`124`	`+ * Gets any left-over non-recognized options and arguments`
`123`	`125`	`*`
`124`	`126`	`* @return remaining items passed in but not parsed as an array.`
`125`	`127`	`*/`
`@@ -128,7 +130,7 @@ public String[] getArgs() {`
`128`	`130`	`}`
`129`	`131`
`130`	`132`	`/**`
`131`		`- * Return the {@code Object} type of this {@code Option}.`
	`133`	`+ * Gets the {@code Object} type of this {@code Option}.`
`132`	`134`	`*`
`133`	`135`	`* @deprecated due to System.err message. Instead use getParsedOptionValue(char)`
`134`	`136`	`* @param opt the name of the option.`
`@@ -140,7 +142,7 @@ public Object getOptionObject(final char opt) {`
`140`	`142`	`}`
`141`	`143`
`142`	`144`	`/**`
`143`		`- * Return the {@code Object} type of this {@code Option}.`
	`145`	`+ * Gets the {@code Object} type of this {@code Option}.`
`144`	`146`	`*`
`145`	`147`	`* @param opt the name of the option.`
`146`	`148`	`* @return the type of this {@code Option}.`
`@@ -157,7 +159,7 @@ public Object getOptionObject(final String opt) {`
`157`	`159`	`}`
`158`	`160`
`159`	`161`	`/**`
`160`		`- * Retrieve the map of values associated to the option. This is convenient for options specifying Java properties like`
	`162`	`+ * Gets the map of values associated to the option. This is convenient for options specifying Java properties like`
`161`	`163`	`* <code>-Dparam1=value1`
`162`	`164`	`* -Dparam2=value2</code>. The first argument of the option is the key, and the 2nd argument is the value. If the option`
`163`	`165`	`* has only one argument ({@code -Dfoo}) it is considered as a boolean flag and the value is {@code "true"}.`
`@@ -186,7 +188,7 @@ public Properties getOptionProperties(final Option option) {`
`186`	`188`	`}`
`187`	`189`
`188`	`190`	`/**`
`189`		`- * Retrieve the map of values associated to the option. This is convenient for options specifying Java properties like`
	`191`	`+ * Gets the map of values associated to the option. This is convenient for options specifying Java properties like`
`190`	`192`	`* <code>-Dparam1=value1`
`191`	`193`	`* -Dparam2=value2</code>. The first argument of the option is the key, and the 2nd argument is the value. If the option`
`192`	`194`	`* has only one argument ({@code -Dfoo}) it is considered as a boolean flag and the value is {@code "true"}.`
`@@ -224,7 +226,7 @@ public Option[] getOptions() {`
`224`	`226`	`}`
`225`	`227`
`226`	`228`	`/**`
`227`		`- * Retrieve the first argument, if any, of this option.`
	`229`	`+ * Gets the first argument, if any, of this option.`
`228`	`230`	`*`
`229`	`231`	`* @param opt the character name of the option.`
`230`	`232`	`* @return Value of the argument if option is set, and has an argument, otherwise null.`
`@@ -234,7 +236,7 @@ public String getOptionValue(final char opt) {`
`234`	`236`	`}`
`235`	`237`
`236`	`238`	`/**`
`237`		`- * Retrieve the argument, if any, of an option.`
	`239`	`+ * Gets the argument, if any, of an option.`
`238`	`240`	`*`
`239`	`241`	`* @param opt character name of the option`
`240`	`242`	`* @param defaultValue is the default value to be returned if the option is not specified.`
`@@ -245,7 +247,7 @@ public String getOptionValue(final char opt, final String defaultValue) {`
`245`	`247`	`}`
`246`	`248`
`247`	`249`	`/**`
`248`		`- * Retrieve the first argument, if any, of this option.`
	`250`	`+ * Gets the first argument, if any, of this option.`
`249`	`251`	`*`
`250`	`252`	`* @param option the name of the option.`
`251`	`253`	`* @return Value of the argument if option is set, and has an argument, otherwise null.`
`@@ -260,7 +262,7 @@ public String getOptionValue(final Option option) {`
`260`	`262`	`}`
`261`	`263`
`262`	`264`	`/**`
`263`		`- * Retrieve the first argument, if any, of an option.`
	`265`	`+ * Gets the first argument, if any, of an option.`
`264`	`266`	`*`
`265`	`267`	`* @param option name of the option.`
`266`	`268`	`* @param defaultValue is the default value to be returned if the option is not specified.`
`@@ -273,7 +275,7 @@ public String getOptionValue(final Option option, final String defaultValue) {`
`273`	`275`	`}`
`274`	`276`
`275`	`277`	`/**`
`276`		`- * Retrieve the first argument, if any, of this option.`
	`278`	`+ * Gets the first argument, if any, of this option.`
`277`	`279`	`*`
`278`	`280`	`* @param opt the name of the option.`
`279`	`281`	`* @return Value of the argument if option is set, and has an argument, otherwise null.`
`@@ -283,7 +285,7 @@ public String getOptionValue(final String opt) {`
`283`	`285`	`}`
`284`	`286`
`285`	`287`	`/**`
`286`		`- * Retrieve the first argument, if any, of an option.`
	`288`	`+ * Gets the first argument, if any, of an option.`
`287`	`289`	`*`
`288`	`290`	`* @param opt name of the option.`
`289`	`291`	`* @param defaultValue is the default value to be returned if the option is not specified.`
`@@ -294,7 +296,7 @@ public String getOptionValue(final String opt, final String defaultValue) {`
`294`	`296`	`}`
`295`	`297`
`296`	`298`	`/**`
`297`		`- * Retrieves the array of values, if any, of an option.`
	`299`	`+ * Gets the array of values, if any, of an option.`
`298`	`300`	`*`
`299`	`301`	`* @param opt character name of the option.`
`300`	`302`	`* @return Values of the argument if option is set, and has an argument, otherwise null.`
`@@ -304,7 +306,7 @@ public String[] getOptionValues(final char opt) {`
`304`	`306`	`}`
`305`	`307`
`306`	`308`	`/**`
`307`		`- * Retrieves the array of values, if any, of an option.`
	`309`	`+ * Gets the array of values, if any, of an option.`
`308`	`310`	`*`
`309`	`311`	`* @param option string name of the option.`
`310`	`312`	`* @return Values of the argument if option is set, and has an argument, otherwise null.`
`@@ -323,7 +325,7 @@ public String[] getOptionValues(final Option option) {`
`323`	`325`	`}`
`324`	`326`
`325`	`327`	`/**`
`326`		`- * Retrieves the array of values, if any, of an option.`
	`328`	`+ * Gets the array of values, if any, of an option.`
`327`	`329`	`*`
`328`	`330`	`* @param opt string name of the option.`
`329`	`331`	`* @return Values of the argument if option is set, and has an argument, otherwise null.`
`@@ -333,7 +335,7 @@ public String[] getOptionValues(final String opt) {`
`333`	`335`	`}`
`334`	`336`
`335`	`337`	`/**`
`336`		`- * Return a version of this {@code Option} converted to a particular type.`
	`338`	`+ * Gets a version of this {@code Option} converted to a particular type.`
`337`	`339`	`*`
`338`	`340`	`* @param opt the name of the option.`
`339`	`341`	`* @return the value parsed into a particular object.`
`@@ -346,7 +348,7 @@ public Object getParsedOptionValue(final char opt) throws ParseException {`
`346`	`348`	`}`
`347`	`349`
`348`	`350`	`/**`
`349`		`- * Return a version of this {@code Option} converted to a particular type.`
	`351`	`+ * Gets a version of this {@code Option} converted to a particular type.`
`350`	`352`	`*`
`351`	`353`	`* @param option the name of the option.`
`352`	`354`	`* @return the value parsed into a particular object.`
`@@ -366,7 +368,7 @@ public Object getParsedOptionValue(final Option option) throws ParseException {`
`366`	`368`	`}`
`367`	`369`
`368`	`370`	`/**`
`369`		`- * Return a version of this {@code Option} converted to a particular type.`
	`371`	`+ * Gets a version of this {@code Option} converted to a particular type.`
`370`	`372`	`*`
`371`	`373`	`* @param opt the name of the option.`
`372`	`374`	`* @return the value parsed into a particular object.`