Release picocli version 3.8.0

remkop · Nov 13, 2018 · 6234990 · 6234990
1 parent 3b12cb5
commit 6234990
Show file tree

Hide file tree

Showing 104 changed files with 604 additions and 479 deletions.
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ Picocli-based applications can easily [integrate](https://picocli.info/#_depende
 ![Picocli Demo help message with ANSI colors](docs/images/picocli.Demo.png?raw=true)
 
 ### Releases
-* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.7.0
+* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.8.0
 * [Picocli 3.0.0 Release Notes](https://github.com/remkop/picocli/releases/tag/v3.0.0) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v3.0.0#3.0.0-breaking-changes) from prior versions
 * [Picocli 2.0 Release Notes](https://github.com/remkop/picocli/releases/tag/v2.0.0) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v2.0.0#2.0-breaking-changes) from prior versions
 
@@ -175,35 +175,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
 
 ### Gradle
 ```
-compile 'info.picocli:picocli:3.7.0'
+compile 'info.picocli:picocli:3.8.0'
 ```
 ### Maven
 ```
 <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>3.7.0</version>
+  <version>3.8.0</version>
 </dependency>
 ```
 ### Scala SBT
 ```
-libraryDependencies += "info.picocli" % "picocli" % "3.7.0"
+libraryDependencies += "info.picocli" % "picocli" % "3.8.0"
 ```
 ### Ivy
 ```
-<dependency org="info.picocli" name="picocli" rev="3.7.0" />
+<dependency org="info.picocli" name="picocli" rev="3.8.0" />
 ```
 ### Grape
 ```groovy
 @Grapes(
-    @Grab(group='info.picocli', module='picocli', version='3.7.0')
+    @Grab(group='info.picocli', module='picocli', version='3.8.0')
 )
 ```
 ### Leiningen
 ```
-[info.picocli/picocli "3.7.0"]
+[info.picocli/picocli "3.8.0"]
 ```
 ### Buildr
 ```
-'info.picocli:picocli:jar:3.7.0'
+'info.picocli:picocli:jar:3.8.0'
 ```
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,7 +1,7 @@
 # picocli Release Notes
 
 
-# <a name="3.8.0"></a> Picocli 3.8.0 (UNRELEASED)
+# <a name="3.8.0"></a> Picocli 3.8.0
 The picocli community is pleased to announce picocli 3.8.0.
 
 This release contains bugfixes and minor enhancements.
@@ -61,6 +61,9 @@ In the above example, the `-x` and `-y` options are added to the other options o
 No features were deprecated in this release.
 
 ## <a name="3.8.0-breaking-changes"></a> Potential breaking changes
+
+### Help Layout
+
 The usage help no longer shows a space between short option names and the parameter (for options that only have a short name).
 This may break tests that rely on the exact output format.
 
@@ -78,11 +81,14 @@ Usage: times [-l=<arg0>] [-r=<arg1>]
   -r=<arg1>
 ```
 
-Another behaviour change is that command methods now pass in `null` for primitive wrapper options that were not matched on the command line.
+### Unmatched Primitive Wrapper Type Options
+
+Another behavioral change is that command methods now pass in `null` for primitive wrapper options that were not matched on the command line.
 This impacts methods annotated with `@Command`, and interface methods annotated with `@Option`. Classes annotated with `@Command` already behaved like this and this has not changed.
 
 This behaviour is now consistent for all annotation-based and programmatic ways of defining commands.
 
+
 # <a name="3.7.0"></a> Picocli 3.7.0
 The picocli community is pleased to announce picocli 3.7.0.
 

diff --git a/build.gradle b/build.gradle
@@ -138,7 +138,8 @@ task bumpReadmeVersion {
         // README.md
         ant.replaceregexp(match: "$projectPreviousReleaseVersion", replace: "$version", flags: 'g', byline: true, encoding: 'UTF8') {
             fileset(dir: '.', includes: 'README.md')
-            fileset(dir: './picocli-codegen/README.md', includes: 'README.md')
+            fileset(dir: './picocli-codegen/', includes: 'README.md')
+            fileset(dir: './picocli-shell-jline2/', includes: 'README.md')
         }
     }
 }

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>All Classes (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>All Classes (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>All Classes (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>All Classes (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/constant-values.html b/docs/apidocs/constant-values.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:02 JST 2018 -->
-<title>Constant Field Values (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Constant Field Values (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (picocli 3.7.0 API)";
+            parent.document.title="Constant Field Values (picocli 3.8.0 API)";
         }
     }
     catch(err) {
@@ -94,7 +94,7 @@ <h2 title="picocli">picocli.*</h2>
 <!--   -->
 </a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
 <td><code><a href="picocli/CommandLine.html#VERSION">VERSION</a></code></td>
-<td class="colLast"><code>"3.7.0"</code></td>
+<td class="colLast"><code>"3.8.0"</code></td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/apidocs/deprecated-list.html b/docs/apidocs/deprecated-list.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>Deprecated List (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Deprecated List (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Deprecated List (picocli 3.7.0 API)";
+            parent.document.title="Deprecated List (picocli 3.8.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>API Help (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>API Help (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="API Help (picocli 3.7.0 API)";
+            parent.document.title="API Help (picocli 3.8.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>Index (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Index (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Index (picocli 3.7.0 API)";
+            parent.document.title="Index (picocli 3.8.0 API)";
         }
     }
     catch(err) {
@@ -114,6 +114,11 @@ <h2 class="title">A</h2>
 <div class="block">Reflects on the class of the <a href="picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
  (class methods annotated with <code>@Command</code>) as subcommands.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.Model.CommandSpec.html#addMethodSubcommands-picocli.CommandLine.IFactory-">addMethodSubcommands(CommandLine.IFactory)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></dt>
+<dd>
+<div class="block">Reflects on the class of the <a href="picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
+ (class methods annotated with <code>@Command</code>) as subcommands.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#addMixin-java.lang.String-java.lang.Object-">addMixin(String, Object)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Adds the options and positional parameters in the specified mixin to this command.</div>
@@ -1205,6 +1210,10 @@ <h2 class="title">G</h2>
 <dd>
 <div class="block">Return the CommandLine for this script.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.OverwrittenOptionException.html#getOverwritten--">getOverwritten()</a></span> - Method in exception picocli.<a href="picocli/CommandLine.OverwrittenOptionException.html" title="class in picocli">CommandLine.OverwrittenOptionException</a></dt>
+<dd>
+<div class="block">Returns the <a href="picocli/CommandLine.Model.ArgSpec.html" title="class in picocli"><code>CommandLine.Model.ArgSpec</code></a> for the option which was being overwritten.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#getParent--">getParent()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Returns the command that this is a subcommand of, or <code>null</code> if this is a top-level command.</div>
@@ -1951,7 +1960,7 @@ <h2 class="title">O</h2>
 <dd>
 <div class="block">Policy that determines how to handle values larger than the column width.</div>
 </dd>
-<dt><span class="memberNameLink"><a href="picocli/CommandLine.OverwrittenOptionException.html#OverwrittenOptionException-picocli.CommandLine-java.lang.String-">OverwrittenOptionException(CommandLine, String)</a></span> - Constructor for exception picocli.<a href="picocli/CommandLine.OverwrittenOptionException.html" title="class in picocli">CommandLine.OverwrittenOptionException</a></dt>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.OverwrittenOptionException.html#OverwrittenOptionException-picocli.CommandLine-picocli.CommandLine.Model.ArgSpec-java.lang.String-">OverwrittenOptionException(CommandLine, CommandLine.Model.ArgSpec, String)</a></span> - Constructor for exception picocli.<a href="picocli/CommandLine.OverwrittenOptionException.html" title="class in picocli">CommandLine.OverwrittenOptionException</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Model.ParserSpec.html#overwrittenOptionsAllowed--">overwrittenOptionsAllowed()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a></dt>
 <dd>&nbsp;</dd>
@@ -2859,7 +2868,7 @@ <h2 class="title">V</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#VERSION">VERSION</a></span> - Static variable in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">This is picocli version "3.7.0".</div>
+<div class="block">This is picocli version "3.8.0".</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Model.OptionSpec.Builder.html#versionHelp--">versionHelp()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a></dt>
 <dd>

diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>picocli 3.7.0 API</title>
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>picocli 3.8.0 API</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;
     if (tmpTargetPage != "" && tmpTargetPage != "undefined")

diff --git a/docs/apidocs/overview-frame.html b/docs/apidocs/overview-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:01 JST 2018 -->
-<title>Overview List (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Overview List (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/overview-summary.html b/docs/apidocs/overview-summary.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:03 JST 2018 -->
-<title>Overview (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Overview (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Overview (picocli 3.7.0 API)";
+            parent.document.title="Overview (picocli 3.8.0 API)";
         }
     }
     catch(err) {
@@ -69,7 +69,7 @@
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="header">
-<h1 class="title">picocli 3.7.0 API</h1>
+<h1 class="title">picocli 3.8.0 API</h1>
 </div>
 <div class="header">
 <div class="subTitle">

diff --git a/docs/apidocs/overview-tree.html b/docs/apidocs/overview-tree.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:39:02 JST 2018 -->
-<title>Class Hierarchy (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:52 JST 2018 -->
+<title>Class Hierarchy (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Class Hierarchy (picocli 3.7.0 API)";
+            parent.document.title="Class Hierarchy (picocli 3.8.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/picocli/AutoComplete.html b/docs/apidocs/picocli/AutoComplete.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:38:52 JST 2018 -->
-<title>AutoComplete (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:49 JST 2018 -->
+<title>AutoComplete (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AutoComplete (picocli 3.7.0 API)";
+            parent.document.title="AutoComplete (picocli 3.8.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/picocli/CommandLine.AbstractHandler.html b/docs/apidocs/picocli/CommandLine.AbstractHandler.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Sun Oct 21 14:38:54 JST 2018 -->
-<title>CommandLine.AbstractHandler (picocli 3.7.0 API)</title>
-<meta name="date" content="2018-10-21">
+<!-- Generated by javadoc (1.8.0_161) on Tue Nov 13 21:04:49 JST 2018 -->
+<title>CommandLine.AbstractHandler (picocli 3.8.0 API)</title>
+<meta name="date" content="2018-11-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="CommandLine.AbstractHandler (picocli 3.7.0 API)";
+            parent.document.title="CommandLine.AbstractHandler (picocli 3.8.0 API)";
         }
     }
     catch(err) {