CLI-326: make option.getKey() public (#239)

Claudenw · web-flow · commit cb334bdf9d94 · 2024-02-29T08:27:44.000-05:00
* Made option.getKey public

* added 'since' and javadoc

* Removed extraneous space.
diff --git a/src/main/java/org/apache/commons/cli/Option.java b/src/main/java/org/apache/commons/cli/Option.java
@@ -573,11 +573,13 @@ public int getId() {
     }
 
     /**
-     * Gets the 'unique' Option identifier.
+     * Gets the 'unique' Option identifier.  This is the option value if set or the long value
+     * if the options value is not set.
      *
      * @return the 'unique' Option identifier
+     * @since 1.7.0
      */
-    String getKey() {
+    public String getKey() {
         // if 'opt' is null, then it is a 'long' option
         return option == null ? longOption : option;
     }

Original file line number	Diff line number	Diff line change
`@@ -573,11 +573,13 @@ public int getId() {`
`573`	`573`	`}`
`574`	`574`
`575`	`575`	`/**`
`576`		`- * Gets the 'unique' Option identifier.`
	`576`	`+ * Gets the 'unique' Option identifier. This is the option value if set or the long value`
	`577`	`+ * if the options value is not set.`
`577`	`578`	`*`
`578`	`579`	`* @return the 'unique' Option identifier`
	`580`	`+ * @since 1.7.0`
`579`	`581`	`*/`
`580`		`- String getKey() {`
	`582`	`+ public String getKey() {`
`581`	`583`	`// if 'opt' is null, then it is a 'long' option`
`582`	`584`	`return option == null ? longOption : option;`
`583`	`585`	`}`