[CLI-241] Clarified javadoc of OptionValidator. Thanks to Beluga Behr.

netomi · netomi · commit b1ffe271a5f8 · 2013-11-23T15:34:31.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1544819 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -36,6 +36,8 @@ NEW FEATURES:
 
 BUG FIXES:
 
+  * Clarified behavior of "OptionValidator#validateOption(String)" in case of null input. Thanks to Beluga Behr. (CLI-241)
+
   * Default options will now work correctly with required options that are missing. (CLI-202)
 
   * Default options will now work correctly together with option groups. (CLI-203) 
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -23,6 +23,9 @@
   <body>
     
     <release version="1.3" date="in SVN" description="This is a maintenance release containing bug fixes.">
+      <action type="fix" dev="tn" issue="CLI-241" due-to="Beluga Behr">
+        Clarified behavior of "OptionValidator#validateOption(String)" in case of null input.
+      </action>
       <action type="update" dev="tn" issue="CLI-240" due-to="Beluga Behr">
         Small cleanup of Option class.
       </action>
diff --git a/src/main/java/org/apache/commons/cli/OptionValidator.java b/src/main/java/org/apache/commons/cli/OptionValidator.java
@@ -31,19 +31,20 @@ final class OptionValidator
      * is valid are:
      *
      * <ul>
-     *  <li><code>opt</code> is not NULL</li>
      *  <li>a single character <code>opt</code> that is either
      *  ' '(special case), '?', '@' or a letter</li>
      *  <li>a multi character <code>opt</code> that only contains
      *  letters.</li>
      * </ul>
+     * <p>
+     * In case {@code opt} is {@code null} no further validation is performed.
      *
-     * @param opt The option string to validate
+     * @param opt The option string to validate, may be null
      * @throws IllegalArgumentException if the Option is not valid.
      */
     static void validateOption(String opt) throws IllegalArgumentException
     {
-        // check that opt is not NULL
+        // if opt is NULL do not check further
         if (opt == null)
         {
             return;

Original file line number	Diff line number	Diff line change
`@@ -31,19 +31,20 @@ final class OptionValidator`
`31`	`31`	`* is valid are:`
`32`	`32`	`*`
`33`	`33`	`* <ul>`
`34`		`- * <li><code>opt</code> is not NULL</li>`
`35`	`34`	`* <li>a single character <code>opt</code> that is either`
`36`	`35`	`* ' '(special case), '?', '@' or a letter</li>`
`37`	`36`	`* <li>a multi character <code>opt</code> that only contains`
`38`	`37`	`* letters.</li>`
`39`	`38`	`* </ul>`
	`39`	`+ * <p>`
	`40`	`+ * In case {@code opt} is {@code null} no further validation is performed.`
`40`	`41`	`*`
`41`		`- * @param opt The option string to validate`
	`42`	`+ * @param opt The option string to validate, may be null`
`42`	`43`	`* @throws IllegalArgumentException if the Option is not valid.`
`43`	`44`	`*/`
`44`	`45`	`static void validateOption(String opt) throws IllegalArgumentException`
`45`	`46`	`{`
`46`		`- // check that opt is not NULL`
	`47`	`+ // if opt is NULL do not check further`
`47`	`48`	`if (opt == null)`
`48`	`49`	`{`
`49`	`50`	`return;`