|
| 1 | +<?xml version="1.0"?> |
| 2 | +<!-- |
| 3 | +Licensed to the Apache Software Foundation (ASF) under one or more |
| 4 | +contributor license agreements. See the NOTICE file distributed with |
| 5 | +this work for additional information regarding copyright ownership. |
| 6 | +The ASF licenses this file to You under the Apache License, Version 2.0 |
| 7 | +(the "License"); you may not use this file except in compliance with |
| 8 | +the License. You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | +Unless required by applicable law or agreed to in writing, software |
| 13 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | +See the License for the specific language governing permissions and |
| 16 | +limitations under the License. |
| 17 | +--> |
| 18 | +<document> |
| 19 | + <properties> |
| 20 | + <title>Release notes for CLI 1.3</title> |
| 21 | + <author email="dev@commons.apache.org">Commons Documentation Team</author> |
| 22 | + </properties> |
| 23 | +<body> |
| 24 | + |
| 25 | +<section name="Release notes"> |
| 26 | + |
| 27 | + <p>These are the release notes for Commons CLI 1.3.</p> |
| 28 | + |
| 29 | +<source> |
| 30 | +INTRODUCTION: |
| 31 | + |
| 32 | +This document contains the release notes for this version of the Commons CLI |
| 33 | +package. Commons CLI provides a simple API for working with the command line |
| 34 | +arguments and options. |
| 35 | + |
| 36 | +Commons CLI 1.3 is a bugfix release and binary compatible with the previous versions, |
| 37 | +except for the OptionValidator class that is no longer public (change introduced in v1.2). |
| 38 | + |
| 39 | +More information can be found on the project site at http://commons.apache.org/cli |
| 40 | + |
| 41 | + |
| 42 | +NEW FEATURES: |
| 43 | + |
| 44 | + * Added new fluent API to create Option instances via builder class Option.Builder. |
| 45 | + This replaces the now deprecated OptionBuilder. Thanks to Duncan Jones, Brian Blount. (CLI-224) |
| 46 | + |
| 47 | + * Added new method Options.addOption(String, String). Thanks to Alexandru Mocanu. (CLI-214) |
| 48 | + |
| 49 | + * A new parser is available: DefaultParser. It combines the features of the GnuParser and the PosixParser. |
| 50 | + It also provides additional features like partial matching for the long options, and long options without |
| 51 | + separator (i.e like the JVM memory settings: -Xmx512m). This new parser deprecates the previous ones. |
| 52 | + (CLI-161, CLI-167, CLI-181) |
| 53 | + |
| 54 | + * PosixParser now supports partial long options (--ver instead of --version). (CLI-160) |
| 55 | + |
| 56 | + * HelpFormatter now supports setting the displayed separator of long options. Thanks to J. Lewis Muir. (CLI-169) |
| 57 | + |
| 58 | + |
| 59 | +BUG FIXES: |
| 60 | + |
| 61 | + * Default options will now work correctly with required options that are missing. (CLI-202) |
| 62 | + |
| 63 | + * Default options will now work correctly together with option groups. (CLI-203) |
| 64 | + |
| 65 | + * HelpFormatter.setArgName(String) now correctly sets the argument name. (CLI-205) |
| 66 | + |
| 67 | + * Passing default values for not defined options to a parser will now trigger |
| 68 | + a ParseException instead of a NullPointerException. (CLI-204) |
| 69 | + |
| 70 | + * Default properties provided as input to the Parser.parse() methods are now |
| 71 | + correctly processed. (CLI-201) |
| 72 | + |
| 73 | + * CommandLine.getParsedOptionValue() now returns a String object if no |
| 74 | + option type has been explicitly set. Thanks to Manuel Müller. (CLI-215) |
| 75 | + |
| 76 | + * HelpFormatter now prints command-line options in the same order as they |
| 77 | + have been added. Thanks to Per Cederberg. (CLI-212) |
| 78 | + |
| 79 | + * Standard help text now shows mandatory arguments also for the first option. Thanks to Kristoff Kiefer. (CLI-186) |
| 80 | + |
| 81 | + * HelpFormatter does not strip anymore leading whitespace in the footer text. Thanks to Uri Moszkowicz. (CLI-207) |
| 82 | + |
| 83 | + * Strip quotes contained in argument values only if there is exactly one at the |
| 84 | + beginning and one at the end. Thanks to Einar M R Rosenvinge. (CLI-185) |
| 85 | + |
| 86 | + * Negative numerical arguments take precedence over numerical options. (CLI-184) |
| 87 | + |
| 88 | + * Fix possible StringIndexOutOfBoundsException in HelpFormatter. Thanks to Travis McLeskey. (CLI-193) |
| 89 | + |
| 90 | + * OptionGroups no longer throw an AlreadySelectedException when reused for several parsings. (CLI-183) |
| 91 | + |
| 92 | + * OptionGroup now selects properly an option with no short name. (CLI-182) |
| 93 | + |
| 94 | + |
| 95 | +CHANGES: |
| 96 | + |
| 97 | + * Options.getRequiredOptions() now returns an unmodifiable list. (CLI-230) |
| 98 | + |
| 99 | + * Clarify javadoc for CommandLine.getOptionValue() that the first specified |
| 100 | + argument will be returned. Thanks to Sven. (CLI-218) |
| 101 | + |
| 102 | + * Changed unit tests to junit 4 annotation style. Thanks to Duncan Jones. (CLI-227) |
| 103 | + |
| 104 | + * The javadoc of OptionBuilder now states that the class is not thread-safe. Thanks to Thomas Herre. (CLI-209) |
| 105 | + |
| 106 | + * Fixed typo in javadoc of class CommandLine. Thanks to Gerard Weatherby. (CLI-200) |
| 107 | + |
| 108 | + * Source code now uses generic types instead of raw types where possible. Thanks to Gerard Weatherby. (CLI-223) |
| 109 | + |
| 110 | + * Corrected javadoc for return type of MissingOptionException.getMissingOptions(). Thanks to Joe Casadonte. (CLI-220) |
| 111 | + |
| 112 | + * Improve description of parameter "stopAtNonOption" in method |
| 113 | + CommandLine.parse(Options, String[], boolean). Thanks to Anders Larsson. (CLI-197) |
| 114 | +</source> |
| 115 | + |
| 116 | +</section> |
| 117 | + |
| 118 | +</body> |
| 119 | +</document> |
0 commit comments