Rename some internals.

Author: garydgregory

src/main/java/org/apache/commons/cli/Option.java

@@ -83,8 +83,7 @@ public static final class Builder {
          * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}
          */
         private Builder(final String option) throws IllegalArgumentException {
-            OptionValidator.validateOption(option);
-            this.option = option;
+            this.option = OptionValidator.validate(option);
         }
 
         /**
@@ -332,44 +331,42 @@ private Option(final Builder builder) {
     /**
      * Creates an Option using the specified parameters.
      *
-     * @param opt short representation of the option
+     * @param option short representation of the option
      * @param hasArg specifies whether the Option takes an argument or not
      * @param description describes the function of the option
      *
      * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}.
      */
-    public Option(final String opt, final boolean hasArg, final String description) throws IllegalArgumentException {
-        this(opt, null, hasArg, description);
+    public Option(final String option, final boolean hasArg, final String description) throws IllegalArgumentException {
+        this(option, null, hasArg, description);
     }
 
     /**
      * Creates an Option using the specified parameters. The option does not take an argument.
      *
-     * @param opt short representation of the option
+     * @param option short representation of the option
      * @param description describes the function of the option
      *
      * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}.
      */
-    public Option(final String opt, final String description) throws IllegalArgumentException {
-        this(opt, null, false, description);
+    public Option(final String option, final String description) throws IllegalArgumentException {
+        this(option, null, false, description);
     }
 
     /**
      * Creates an Option using the specified parameters.
      *
-     * @param opt short representation of the option
-     * @param longOpt the long representation of the option
+     * @param option short representation of the option
+     * @param longOption the long representation of the option
      * @param hasArg specifies whether the Option takes an argument or not
      * @param description describes the function of the option
      *
      * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}.
      */
-    public Option(final String opt, final String longOpt, final boolean hasArg, final String description) throws IllegalArgumentException {
+    public Option(final String option, final String longOption, final boolean hasArg, final String description) throws IllegalArgumentException {
         // ensure that the option is valid
-        OptionValidator.validateOption(opt);
-
-        this.opt = opt;
-        this.longOpt = longOpt;
+        this.opt = OptionValidator.validate(option);
+        this.longOpt = longOption;
 
         // if hasArg is set then the number of arguments is 1
         if (hasArg) {

src/main/java/org/apache/commons/cli/OptionValidator.java

@@ -54,31 +54,30 @@ private static boolean isValidOpt(final char c) {
      * <p>
      * In case {@code opt} is {@code null} no further validation is performed.
      *
-     * @param opt The option string to validate, may be null
+     * @param option The option string to validate, may be null
      * @throws IllegalArgumentException if the Option is not valid.
      */
-    static void validateOption(final String opt) throws IllegalArgumentException {
+    static String validate(final String option) throws IllegalArgumentException {
         // if opt is NULL do not check further
-        if (opt == null) {
-            return;
+        if (option == null) {
+            return option;
         }
 
         // handle the single character opt
-        if (opt.length() == 1) {
-            final char ch = opt.charAt(0);
+        if (option.length() == 1) {
+            final char ch = option.charAt(0);
 
             if (!isValidOpt(ch)) {
                 throw new IllegalArgumentException("Illegal option name '" + ch + "'");
             }
-        }
-
-        // handle the multi character opt
-        else {
-            for (final char ch : opt.toCharArray()) {
+        } else {
+            // handle the multi character opt
+            for (final char ch : option.toCharArray()) {
                 if (!isValidChar(ch)) {
-                    throw new IllegalArgumentException("The option '" + opt + "' contains an illegal " + "character : '" + ch + "'");
+                    throw new IllegalArgumentException("The option '" + option + "' contains an illegal " + "character : '" + ch + "'");
                 }
             }
         }
+        return option;
     }
 }