Release picocli version 4.0.0

remkop · Jul 17, 2019 · 9ffd9c4 · 9ffd9c4
1 parent ff962e7
commit 9ffd9c4
Show file tree

Hide file tree

Showing 130 changed files with 1,721 additions and 1,032 deletions.
diff --git a/README.md b/README.md
@@ -46,8 +46,8 @@ Picocli-based applications can easily [integrate](https://picocli.info/#_depende
 
 ### Releases
 * [All Releases](https://github.com/remkop/picocli/releases)
-* Latest: 4.0.0-beta-2 [Release Notes](https://github.com/remkop/picocli/releases/tag/v4.0.0-beta-2)
-* Stable: Picocli 3.9.6 [Release Notes](https://github.com/remkop/picocli/releases/tag/v3.9.6)
+* Latest: 4.0.0 [Release Notes](https://github.com/remkop/picocli/releases/tag/v4.0.0)
+* Older: Picocli 3.9.6 [Release Notes](https://github.com/remkop/picocli/releases/tag/v3.9.6)
 * Older: Picocli 3.0.0 [Release Notes](https://github.com/remkop/picocli/releases/tag/v3.0.0)
 * Older: Picocli 2.0 [Release Notes](https://github.com/remkop/picocli/releases/tag/v2.0.0)
 
@@ -209,35 +209,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
 
 ### Gradle
 ```
-compile 'info.picocli:picocli:4.0.0-beta-2'
+compile 'info.picocli:picocli:4.0.0'
 ```
 ### Maven
 ```
 <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>4.0.0-beta-2</version>
+  <version>4.0.0</version>
 </dependency>
 ```
 ### Scala SBT
 ```
-libraryDependencies += "info.picocli" % "picocli" % "4.0.0-beta-2"
+libraryDependencies += "info.picocli" % "picocli" % "4.0.0"
 ```
 ### Ivy
 ```
-<dependency org="info.picocli" name="picocli" rev="4.0.0-beta-2" />
+<dependency org="info.picocli" name="picocli" rev="4.0.0" />
 ```
 ### Grape
 ```groovy
 @Grapes(
-    @Grab(group='info.picocli', module='picocli', version='4.0.0-beta-2')
+    @Grab(group='info.picocli', module='picocli', version='4.0.0')
 )
 ```
 ### Leiningen
 ```
-[info.picocli/picocli "4.0.0-beta-2"]
+[info.picocli/picocli "4.0.0"]
 ```
 ### Buildr
 ```
-'info.picocli:picocli:jar:4.0.0-beta-2'
+'info.picocli:picocli:jar:4.0.0'
 ```
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,7 +1,7 @@
 # picocli Release Notes
 
 
-# <a name="4.0.0"></a> Picocli 4.0.0 GA (UNRELEASED)
+# <a name="4.0.0"></a> Picocli 4.0.0 GA
 The picocli community is pleased to announce picocli 4.0. This is a big release.
 
 First, the `picocli-codegen` module now includes an [annotation processor](#4.0.0-annotation-processor) that instantly enables your JAR for GraalVM native images. It also gives compile-time errors for invalid annotations and attributes. We recommend that all projects using picocli enable this annotation processor.

diff --git a/build.gradle b/build.gradle
@@ -289,6 +289,14 @@ task bumpVersion {
             fileset(dir: 'docs', includes: 'autocomplete.adoc')
             fileset(dir: 'docs', includes: 'picocli-3.0-programmatic-api.adoc')
         }
+        // Annotation Processor section
+        ant.replaceregexp(match: ":picocli-codegen:$projectPreviousVersionRegex", replace: ":picocli-codegen:$version", flags: 'g', byline: true, encoding: 'UTF8') {
+            fileset(dir: 'docs', includes: 'index.adoc')
+        }
+        // Groovy section
+        ant.replaceregexp(match: ":picocli-groovy:$projectPreviousVersionRegex", replace: ":picocli-groovy:$version", flags: 'g', byline: true, encoding: 'UTF8') {
+            fileset(dir: 'docs', includes: 'index.adoc')
+        }
         // Downloads section, Gradle
         ant.replaceregexp(match: ":picocli:$projectPreviousVersionRegex", replace: ":picocli:$version", flags: 'g', byline: true, encoding: 'UTF8') {
             fileset(dir: 'docs', includes: 'index.adoc')

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_202) on Thu Jun 20 00:39:56 JST 2019 -->
-<title>All Classes (picocli 4.0.0-beta-2 API)</title>
-<meta name="date" content="2019-06-20">
+<!-- Generated by javadoc (1.8.0_202) on Wed Jul 17 12:54:19 JST 2019 -->
+<title>All Classes (picocli 4.0.0 API)</title>
+<meta name="date" content="2019-07-17">
 <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_202) on Thu Jun 20 00:39:56 JST 2019 -->
-<title>All Classes (picocli 4.0.0-beta-2 API)</title>
-<meta name="date" content="2019-06-20">
+<!-- Generated by javadoc (1.8.0_202) on Wed Jul 17 12:54:19 JST 2019 -->
+<title>All Classes (picocli 4.0.0 API)</title>
+<meta name="date" content="2019-07-17">
 <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_202) on Thu Jun 20 00:39:56 JST 2019 -->
-<title>Constant Field Values (picocli 4.0.0-beta-2 API)</title>
-<meta name="date" content="2019-06-20">
+<!-- Generated by javadoc (1.8.0_202) on Wed Jul 17 12:54:18 JST 2019 -->
+<title>Constant Field Values (picocli 4.0.0 API)</title>
+<meta name="date" content="2019-07-17">
 <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 4.0.0-beta-2 API)";
+            parent.document.title="Constant Field Values (picocli 4.0.0 API)";
         }
     }
     catch(err) {
@@ -141,7 +141,7 @@ <h2 title="picocli">picocli.*</h2>
 <!--   -->
 </a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td><code><a href="picocli/CommandLine.html#VERSION">VERSION</a></code></td>
-<td class="colLast"><code>"4.0.0-beta-2"</code></td>
+<td class="colLast"><code>"4.0.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_202) on Thu Jun 20 00:39:56 JST 2019 -->
-<title>Deprecated List (picocli 4.0.0-beta-2 API)</title>
-<meta name="date" content="2019-06-20">
+<!-- Generated by javadoc (1.8.0_202) on Wed Jul 17 12:54:19 JST 2019 -->
+<title>Deprecated List (picocli 4.0.0 API)</title>
+<meta name="date" content="2019-07-17">
 <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 4.0.0-beta-2 API)";
+            parent.document.title="Deprecated List (picocli 4.0.0 API)";
         }
     }
     catch(err) {
@@ -306,95 +306,107 @@ <h2 title="Contents">Contents</h2>
 </td>
 </tr>
 <tr class="altColor">
+<td class="colOne"><a href="picocli/CommandLine.html#isSplitQuotedStrings--">picocli.CommandLine.isSplitQuotedStrings()</a>
+<div class="block"><span class="deprecationComment">Most applications should not change the default. The rare application that <em>does</em> need to split parameter values
+ without respecting quotes should use <a href="picocli/CommandLine.Model.ParserSpec.html#splitQuotedStrings-boolean-"><code>CommandLine.Model.ParserSpec.splitQuotedStrings(boolean)</code></a>.</span></div>
+</td>
+</tr>
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.Help.html#join-picocli.CommandLine.Help.Ansi-int-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">picocli.CommandLine.Help.join(CommandLine.Help.Ansi, int, String[], StringBuilder, Object...)</a>
 <div class="block"><span class="deprecationComment">Use <a href="picocli/CommandLine.Help.html#join-picocli.CommandLine.Help.Ansi-int-boolean-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-"><code>CommandLine.Help.join(Ansi, int, boolean, String[], StringBuilder, Object...)</code></a>  instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#parse-java.lang.String...-">picocli.CommandLine.parse(String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#parseArgs-java.lang.String...-"><code>CommandLine.parseArgs(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#parseWithHandler-picocli.CommandLine.IParseResultHandler2-java.lang.String:A-">picocli.CommandLine.parseWithHandler(CommandLine.IParseResultHandler2&lt;R&gt;, String[])</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#parseWithHandler-picocli.CommandLine.IParseResultHandler-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#parseWithHandlers-picocli.CommandLine.IParseResultHandler2-picocli.CommandLine.IExceptionHandler2-java.lang.String...-">picocli.CommandLine.parseWithHandlers(CommandLine.IParseResultHandler2&lt;R&gt;, CommandLine.IExceptionHandler2&lt;R&gt;, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#parseWithHandlers-picocli.CommandLine.IParseResultHandler-java.io.PrintStream-picocli.CommandLine.Help.Ansi-picocli.CommandLine.IExceptionHandler-java.lang.String...-">picocli.CommandLine.parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">picocli.CommandLine.printHelpIfRequested(List&lt;CommandLine&gt;, PrintStream, CommandLine.Help.Ansi)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#printHelpIfRequested-picocli.CommandLine.ParseResult-"><code>CommandLine.printHelpIfRequested(ParseResult)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">picocli.CommandLine.printHelpIfRequested(List&lt;CommandLine&gt;, PrintStream, PrintStream, CommandLine.Help.Ansi)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#executeHelpRequest-picocli.CommandLine.ParseResult-"><code>CommandLine.executeHelpRequest(ParseResult)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-">picocli.CommandLine.printHelpIfRequested(List&lt;CommandLine&gt;, PrintStream, PrintStream, CommandLine.Help.ColorScheme)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#executeHelpRequest-picocli.CommandLine.ParseResult-"><code>CommandLine.executeHelpRequest(ParseResult)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.Model.ArgSpec.html#renderedDescription--">picocli.CommandLine.Model.ArgSpec.renderedDescription()</a>
 <div class="block"><span class="deprecationComment">Use <a href="picocli/CommandLine.Model.ArgSpec.html#description--"><code>CommandLine.Model.ArgSpec.description()</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.run(Class&lt;R&gt;, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.run(Class&lt;R&gt;, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.run(Class&lt;R&gt;, CommandLine.IFactory, PrintStream, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-java.lang.Class-picocli.CommandLine.IFactory-java.lang.String...-">picocli.CommandLine.run(Class&lt;R&gt;, CommandLine.IFactory, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-R-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.run(R, PrintStream, CommandLine.Help.Ansi, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-R-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-R-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.run(R, PrintStream, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="picocli/CommandLine.html#run-R-java.lang.String...-">picocli.CommandLine.run(R, String...)</a>
 <div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colOne"><a href="picocli/CommandLine.html#setSplitQuotedStrings-boolean-">picocli.CommandLine.setSplitQuotedStrings(boolean)</a>
+<div class="block"><span class="deprecationComment">Most applications should not change the default. The rare application that <em>does</em> need to split parameter values
+ without respecting quotes should use <a href="picocli/CommandLine.Model.ParserSpec.html#splitQuotedStrings-boolean-"><code>CommandLine.Model.ParserSpec.splitQuotedStrings(boolean)</code></a>.</span></div>
+</td>
+</tr>
 <tr class="altColor">
 <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>

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_202) on Thu Jun 20 00:39:56 JST 2019 -->
-<title>API Help (picocli 4.0.0-beta-2 API)</title>
-<meta name="date" content="2019-06-20">
+<!-- Generated by javadoc (1.8.0_202) on Wed Jul 17 12:54:19 JST 2019 -->
+<title>API Help (picocli 4.0.0 API)</title>
+<meta name="date" content="2019-07-17">
 <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 4.0.0-beta-2 API)";
+            parent.document.title="API Help (picocli 4.0.0 API)";
         }
     }
     catch(err) {