Skip to content

Commit c580475

Browse files
henhen
committed
Upgrading release notes
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@552192 13f79535-47bb-0310-9956-ffa450edef68
1 parent 2b7190a commit c580475

2 files changed

Lines changed: 16 additions & 10 deletions

File tree

‎xdocs/changes.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@
4747
<action type="fix" issue="CLI-35">HelpFormatter doesn't sort options properly. </action>
4848
<action type="fix" issue="CLI-130">Remove the Commons Lang dependency. </action>
4949
<action type="add" issue="CLI-78">Setting description of a Option. </action>
50+
<action type="fix" issue="CLI-131">Options class returns options in random order. </action>
51+
<action type="fix" issue="CLI-132">MissingOptionException should contain a useful error message. </action>
52+
<action type="fix" issue="CLI-133">NullPointerException in Util.stripLeadingHyphens when passed a null argument. </action>
53+
<action type="fix" issue="CLI-134">1.1 is not backwards compatible because it adds methods to the CommandLineParser interface. </action>
54+
<action type="fix" issue="CLI-135">Backwards compatibility between 1.1 and 1.0 broken due to Option.addValue removal. </action>
5055

5156
</release>
5257

‎xdocs/upgrading-1.0-to-1.1.xml‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,21 @@ limitations under the License.
2323
<body>
2424
<!-- ================================================== -->
2525
<section name="Upgrading from 1.0 to 1.1">
26-
<p>CLI 1.1 is a bugfix release of CLI. The following changes were not backward compatible: </p>
26+
<p>CLI 1.1 is a bugfix release of CLI. The following changes notable API changes were made: </p>
2727

2828
<ul>
29-
<li>The CommandLineParser interface has two additional methods. If you were extending this,
30-
then you will need to add methods to your classes. If you were extending the abstract
31-
Parser class, then you should be okay. </li>
32-
<li>The HelpFormatter class had publicly accessible fields. These are now accessed via
33-
get/set methods. </li>
34-
<li>Two of HelpFormatter's methods no longer throw IllegalArgumentException. </li>
35-
<li>The Option class is no longer cloneable, and no longer has an addValue(String) method. </li>
29+
<li>The Parser abstract class has two additional parse methods that take a Properties parameter. </li>
30+
<li>The HelpFormatter class had publicly accessible fields. These should now be accessed via
31+
get/set methods and the public fields are deprecated. </li>
32+
<li>The Option class addValue(String) method now throws UnsupportedOperationException. </li>
33+
<li>OptionValidator is a newly added class. </li>
34+
<li>Option's now have equals(Object) and hashCode() methods. </li>
35+
<li>The Option class also received two new methods, setDescription(String) and hasValueSeparator();boolean. </li>
3636
</ul>
3737

38-
<p>The best way to test any of the above is to recompile your code against CLI 1.1. All of the above
39-
should result in compile time errors. </p>
38+
<p>The jar should be API backwards compatible, though if you were calling addValue(String) then you won't be happy. Please
39+
let us know your use case if that is so. </p>
40+
4041
</section>
4142
<section name="Bugs fixed in 1.1">
4243
<p>The list of bugs fixed in 1.1 may be seen via the

0 commit comments

Comments
 (0)