Fixed backwards compatiblity fail: ParameterDescription.getDefault() …

…must not produce different result as existing code relies on current behavior
cbeust · Oct 2, 2023 · 6e44352 · 6e44352
1 parent bffc92d
commit 6e44352
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/src/main/java/com/beust/jcommander/DefaultUsageFormatter.java b/src/main/java/com/beust/jcommander/DefaultUsageFormatter.java
@@ -187,7 +187,7 @@ public void appendAllParametersDetails(StringBuilder out, int indentCount, Strin
             if (hasDescription) {
                 wrapDescription(out, indentCount, s(indentCount) + description);
             }
-            Object def = pd.getDefault();
+            Object def = pd.getDefaultValueDescription();
 
             if (pd.isDynamicParameter()) {
                 String syntax = "Syntax: " + parameter.names()[0] + "key" + parameter.getAssignment() + "value";

diff --git a/src/main/java/com/beust/jcommander/ParameterDescription.java b/src/main/java/com/beust/jcommander/ParameterDescription.java
@@ -166,10 +166,14 @@ public String getLongestName() {
     return longestName;
   }
 
+  public Object getDefault() {
+    return defaultObject;
+  }
+
   /**
    * @return defaultValueDescription, if description is empty string, return default Object.
    */
-  public Object getDefault() {
+  public Object getDefaultValueDescription() {
     return parameterAnnotation == null ? defaultObject : parameterAnnotation.defaultValueDescription().isEmpty() ? defaultObject : parameterAnnotation.defaultValueDescription();
   }
 

diff --git a/src/main/java/com/beust/jcommander/UnixStyleUsageFormatter.java b/src/main/java/com/beust/jcommander/UnixStyleUsageFormatter.java
@@ -73,7 +73,7 @@ public void appendAllParametersDetails(StringBuilder out, int indentCount, Strin
 
             // Generate description
             String description = pd.getDescription();
-            Object def = pd.getDefault();
+            Object def = pd.getDefaultValueDescription();
 
             if (pd.isDynamicParameter()) {
                 String syntax = "(syntax: " + parameter.names()[0] + "key" + parameter.getAssignment() + "value)";