Release picocli version 3.9.0

remkop · Jan 4, 2019 · 668aa51 · 668aa51
1 parent 5e86817
commit 668aa51
Show file tree

Hide file tree

Showing 105 changed files with 3,066 additions and 720 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,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.8.2
+* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.9.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
 
@@ -177,35 +177,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
 
 ### Gradle
 ```
-compile 'info.picocli:picocli:3.8.2'
+compile 'info.picocli:picocli:3.9.0'
 ```
 ### Maven
 ```
 <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>3.8.2</version>
+  <version>3.9.0</version>
 </dependency>
 ```
 ### Scala SBT
 ```
-libraryDependencies += "info.picocli" % "picocli" % "3.8.2"
+libraryDependencies += "info.picocli" % "picocli" % "3.9.0"
 ```
 ### Ivy
 ```
-<dependency org="info.picocli" name="picocli" rev="3.8.2" />
+<dependency org="info.picocli" name="picocli" rev="3.9.0" />
 ```
 ### Grape
 ```groovy
 @Grapes(
-    @Grab(group='info.picocli', module='picocli', version='3.8.2')
+    @Grab(group='info.picocli', module='picocli', version='3.9.0')
 )
 ```
 ### Leiningen
 ```
-[info.picocli/picocli "3.8.2"]
+[info.picocli/picocli "3.9.0"]
 ```
 ### Buildr
 ```
-'info.picocli:picocli:jar:3.8.2'
+'info.picocli:picocli:jar:3.9.0'
 ```
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,6 +1,6 @@
 # picocli Release Notes
 
-# <a name="3.9.0"></a> Picocli 3.9.0 (UNRELEASED)
+# <a name="3.9.0"></a> Picocli 3.9.0
 The picocli community is pleased to announce picocli 3.9.0.
 
 This release contains bugfixes and enhancements in the main picocli module, and adds a new module: `picocli-shell-jline3`.

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 Wed Dec 05 07:04:26 JST 2018 -->
-<title>All Classes (picocli 3.8.2 API)</title>
-<meta name="date" content="2018-12-05">
+<!-- Generated by javadoc (1.8.0_161) on Fri Jan 04 21:45:47 JST 2019 -->
+<title>All Classes (picocli 3.9.0 API)</title>
+<meta name="date" content="2019-01-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -40,6 +40,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExceptionHandler2</span></a></li>
 <li><a href="picocli/CommandLine.IFactory.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IFactory</span></a></li>
 <li><a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IHelpCommandInitializable</span></a></li>
+<li><a href="picocli/CommandLine.IHelpFactory.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IHelpFactory</span></a></li>
+<li><a href="picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IHelpSectionRenderer</span></a></li>
 <li><a href="picocli/CommandLine.InitializationException.html" title="class in picocli" target="classFrame">CommandLine.InitializationException</a></li>
 <li><a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IParseResultHandler</span></a></li>
 <li><a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IParseResultHandler2</span></a></li>

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 Wed Dec 05 07:04:26 JST 2018 -->
-<title>All Classes (picocli 3.8.2 API)</title>
-<meta name="date" content="2018-12-05">
+<!-- Generated by javadoc (1.8.0_161) on Fri Jan 04 21:45:47 JST 2019 -->
+<title>All Classes (picocli 3.9.0 API)</title>
+<meta name="date" content="2019-01-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -40,6 +40,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExceptionHandler2</span></a></li>
 <li><a href="picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="interfaceName">CommandLine.IFactory</span></a></li>
 <li><a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="interfaceName">CommandLine.IHelpCommandInitializable</span></a></li>
+<li><a href="picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="interfaceName">CommandLine.IHelpFactory</span></a></li>
+<li><a href="picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="interfaceName">CommandLine.IHelpSectionRenderer</span></a></li>
 <li><a href="picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></li>
 <li><a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="interfaceName">CommandLine.IParseResultHandler</span></a></li>
 <li><a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><span class="interfaceName">CommandLine.IParseResultHandler2</span></a></li>

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 Wed Dec 05 07:04:26 JST 2018 -->
-<title>Constant Field Values (picocli 3.8.2 API)</title>
-<meta name="date" content="2018-12-05">
+<!-- Generated by javadoc (1.8.0_161) on Fri Jan 04 21:45:47 JST 2019 -->
+<title>Constant Field Values (picocli 3.9.0 API)</title>
+<meta name="date" content="2019-01-04">
 <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.8.2 API)";
+            parent.document.title="Constant Field Values (picocli 3.9.0 API)";
         }
     }
     catch(err) {
@@ -82,6 +82,53 @@ <h2 title="picocli">picocli.*</h2>
 <ul class="blockList">
 <li class="blockList">
 <table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
+<caption><span>picocli.<a href="picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th scope="col">Constant Field</th>
+<th class="colLast" scope="col">Value</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.AutoComplete.EXIT_CODE_COMMAND_SCRIPT_EXISTS">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
+<td><code><a href="picocli/AutoComplete.html#EXIT_CODE_COMMAND_SCRIPT_EXISTS">EXIT_CODE_COMMAND_SCRIPT_EXISTS</a></code></td>
+<td class="colLast"><code>2</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.AutoComplete.EXIT_CODE_COMPLETION_SCRIPT_EXISTS">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
+<td><code><a href="picocli/AutoComplete.html#EXIT_CODE_COMPLETION_SCRIPT_EXISTS">EXIT_CODE_COMPLETION_SCRIPT_EXISTS</a></code></td>
+<td class="colLast"><code>3</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.AutoComplete.EXIT_CODE_EXECUTION_ERROR">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
+<td><code><a href="picocli/AutoComplete.html#EXIT_CODE_EXECUTION_ERROR">EXIT_CODE_EXECUTION_ERROR</a></code></td>
+<td class="colLast"><code>4</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.AutoComplete.EXIT_CODE_INVALID_INPUT">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
+<td><code><a href="picocli/AutoComplete.html#EXIT_CODE_INVALID_INPUT">EXIT_CODE_INVALID_INPUT</a></code></td>
+<td class="colLast"><code>1</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.AutoComplete.EXIT_CODE_SUCCESS">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
+<td><code><a href="picocli/AutoComplete.html#EXIT_CODE_SUCCESS">EXIT_CODE_SUCCESS</a></code></td>
+<td class="colLast"><code>0</code></td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
 <caption><span>picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
@@ -94,7 +141,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.8.2"</code></td>
+<td class="colLast"><code>"3.9.0"</code></td>
 </tr>
 </tbody>
 </table>
@@ -160,6 +207,104 @@ <h2 title="picocli">picocli.*</h2>
 <td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#DEFAULT_USAGE_WIDTH">DEFAULT_USAGE_WIDTH</a></code></td>
 <td class="colLast"><code>80</code></td>
 </tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST">SECTION_KEY_COMMAND_LIST</a></code></td>
+<td class="colLast"><code>"commandList"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST_HEADING">SECTION_KEY_COMMAND_LIST_HEADING</a></code></td>
+<td class="colLast"><code>"commandListHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_DESCRIPTION">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION">SECTION_KEY_DESCRIPTION</a></code></td>
+<td class="colLast"><code>"description"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_DESCRIPTION_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION_HEADING">SECTION_KEY_DESCRIPTION_HEADING</a></code></td>
+<td class="colLast"><code>"descriptionHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_FOOTER">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_FOOTER">SECTION_KEY_FOOTER</a></code></td>
+<td class="colLast"><code>"footer"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_FOOTER_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_FOOTER_HEADING">SECTION_KEY_FOOTER_HEADING</a></code></td>
+<td class="colLast"><code>"footerHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_HEADER">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_HEADER">SECTION_KEY_HEADER</a></code></td>
+<td class="colLast"><code>"header"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_HEADER_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_HEADER_HEADING">SECTION_KEY_HEADER_HEADING</a></code></td>
+<td class="colLast"><code>"headerHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST">SECTION_KEY_OPTION_LIST</a></code></td>
+<td class="colLast"><code>"optionList"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST_HEADING">SECTION_KEY_OPTION_LIST_HEADING</a></code></td>
+<td class="colLast"><code>"optionListHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_PARAMETER_LIST">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST">SECTION_KEY_PARAMETER_LIST</a></code></td>
+<td class="colLast"><code>"parameterList"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_PARAMETER_LIST_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST_HEADING">SECTION_KEY_PARAMETER_LIST_HEADING</a></code></td>
+<td class="colLast"><code>"parameterListHeading"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_SYNOPSIS">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS">SECTION_KEY_SYNOPSIS</a></code></td>
+<td class="colLast"><code>"synopsis"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_SYNOPSIS_HEADING">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS_HEADING">SECTION_KEY_SYNOPSIS_HEADING</a></code></td>
+<td class="colLast"><code>"synopsisHeading"</code></td>
+</tr>
 </tbody>
 </table>
 </li>

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 Wed Dec 05 07:04:26 JST 2018 -->
-<title>Deprecated List (picocli 3.8.2 API)</title>
-<meta name="date" content="2018-12-05">
+<!-- Generated by javadoc (1.8.0_161) on Fri Jan 04 21:45:47 JST 2019 -->
+<title>Deprecated List (picocli 3.9.0 API)</title>
+<meta name="date" content="2019-01-04">
 <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.8.2 API)";
+            parent.document.title="Deprecated List (picocli 3.9.0 API)";
         }
     }
     catch(err) {
@@ -168,6 +168,11 @@ <h2 title="Contents">Contents</h2>
 </td>
 </tr>
 <tr class="rowColor">
+<td class="colOne"><a href="picocli/CommandLine.Model.ArgSpec.html#setValue-T-picocli.CommandLine-">picocli.CommandLine.Model.ArgSpec.setValue(T, CommandLine)</a>
+<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Model.ArgSpec.html#setValue-T-"><code>CommandLine.Model.ArgSpec.setValue(Object)</code></a> instead. This was a design mistake.</span></div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.Help.html#synopsis--">picocli.CommandLine.Help.synopsis()</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Help.html#synopsis-int-"><code>CommandLine.Help.synopsis(int)</code></a> instead</span></div>
 </td>

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 Wed Dec 05 07:04:26 JST 2018 -->
-<title>API Help (picocli 3.8.2 API)</title>
-<meta name="date" content="2018-12-05">
+<!-- Generated by javadoc (1.8.0_161) on Fri Jan 04 21:45:47 JST 2019 -->
+<title>API Help (picocli 3.9.0 API)</title>
+<meta name="date" content="2019-01-04">
 <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.8.2 API)";
+            parent.document.title="API Help (picocli 3.9.0 API)";
         }
     }
     catch(err) {