Release picocli version 3.3.0

remkop · Jul 13, 2018 · 4a89f6e · 4a89f6e
1 parent 86f909e
commit 4a89f6e
Show file tree

Hide file tree

Showing 98 changed files with 552 additions and 396 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ Picocli-based applications can easily [integrate](http://picocli.info/#_dependen
 ![Picocli Demo help message with ANSI colors](docs/images/picocli.Demo.png?raw=true)
 
 #### Releases
-* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.2.0
+* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.3.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
 
@@ -151,35 +151,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
 
 ### Gradle
 ```
-compile 'info.picocli:picocli:3.2.0'
+compile 'info.picocli:picocli:3.3.0'
 ```
 ### Maven
 ```
 <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>3.2.0</version>
+  <version>3.3.0</version>
 </dependency>
 ```
 ### Scala SBT
 ```
-libraryDependencies += "info.picocli" % "picocli" % "3.2.0"
+libraryDependencies += "info.picocli" % "picocli" % "3.3.0"
 ```
 ### Ivy
 ```
-<dependency org="info.picocli" name="picocli" rev="3.2.0" />
+<dependency org="info.picocli" name="picocli" rev="3.3.0" />
 ```
 ### Grape
 ```groovy
 @Grapes(
-    @Grab(group='info.picocli', module='picocli', version='3.2.0')
+    @Grab(group='info.picocli', module='picocli', version='3.3.0')
 )
 ```
 ### Leiningen
 ```
-[info.picocli/picocli "3.2.0"]
+[info.picocli/picocli "3.3.0"]
 ```
 ### Buildr
 ```
-'info.picocli:picocli:jar:3.2.0'
+'info.picocli:picocli:jar:3.3.0'
 ```
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,6 +1,6 @@
 # picocli Release Notes
 
-# <a name="3.3.0"></a> Picocli 3.3.0 (UNRELEASED)
+# <a name="3.3.0"></a> Picocli 3.3.0
 The picocli community is pleased to announce picocli 3.3.0.
 
 This release contains a bugfix for the JLine TAB completion support and improves the error messages for missing required parameters and unmatched arguments.

diff --git a/build.gradle b/build.gradle
@@ -1,11 +1,11 @@
 group 'info.picocli'
 description 'Java command line parser with both an annotations API and a programmatic API. Usage help with ANSI styles and colors. Autocomplete. Nested subcommands. Easily included as source to avoid adding a dependency.'
-version '3.2.1-SNAPSHOT'
+version '3.3.0'
 
 // for bumpVersion task
-def oldVersion = '3\\.2\\.0'
+def oldVersion = '3\\.2\\.1-SNAPSHOT'
 def oldRevdate = '2018\\-07\\-06'
-def revDate    = '2018-07-06'
+def revDate    = '2018-07-14'
 
 // for bumpReadmeVersion task
 def previousReleaseVersion = '3.2.0'

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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>All Classes (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>All Classes (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>All Classes (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>All Classes (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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 Fri Jul 06 20:57:24 JST 2018 -->
-<title>Constant Field Values (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:01 JST 2018 -->
+<title>Constant Field Values (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="Constant Field Values (picocli 3.3.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.2.0"</code></td>
+<td class="colLast"><code>"3.3.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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>Deprecated List (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>Deprecated List (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="Deprecated List (picocli 3.3.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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>API Help (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>API Help (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="API Help (picocli 3.3.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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>Index (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>Index (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="Index (picocli 3.3.0 API)";
         }
     }
     catch(err) {
@@ -1139,6 +1139,10 @@ <h2 class="title">G</h2>
 <dd>
 <div class="block">Returns a map with the subcommands <a href="picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-">registered</a> on this instance.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.UnmatchedArgumentException.html#getSuggestions--">getSuggestions()</a></span> - Method in exception picocli.<a href="picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></dt>
+<dd>
+<div class="block">Returns suggested solutions if such solutions exist, otherwise returns an empty list.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Model.ArgSpec.html#getter--">getter()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a></dt>
 <dd>
 <div class="block">Returns the <a href="picocli/CommandLine.Model.IGetter.html" title="interface in picocli"><code>CommandLine.Model.IGetter</code></a> that is responsible for supplying the value of this argument.</div>
@@ -1147,6 +1151,10 @@ <h2 class="title">G</h2>
 <dd>
 <div class="block">Returns the getter responsible for producing a <code>Collection</code> that the unmatched arguments can be added to.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.UnmatchedArgumentException.html#getUnmatched--">getUnmatched()</a></span> - Method in exception picocli.<a href="picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></dt>
+<dd>
+<div class="block">Returns the unmatched command line arguments.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#getUnmatchedArguments--">getUnmatchedArguments()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Returns the list of unmatched command line arguments, if any.</div>
@@ -1493,6 +1501,10 @@ <h2 class="title">I</h2>
 <dd>
 <div class="block">Returns whether the value of boolean flag options should be "toggled" when the option is matched.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.UnmatchedArgumentException.html#isUnknownOption--">isUnknownOption()</a></span> - Method in exception picocli.<a href="picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></dt>
+<dd>
+<div class="block">Returns <code>true</code> if the first unmatched command line arguments resembles an option, <code>false</code> otherwise.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#isUnmatchedArgumentsAllowed--">isUnmatchedArgumentsAllowed()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Returns whether the end user may specify arguments on the command line that are not matched to any option or parameter fields.</div>
@@ -2008,6 +2020,14 @@ <h2 class="title">P</h2>
 <dd>
 <div class="block">If an &#064;Option whose <code>usageHelp</code> attribute is annotated as true appears in the arguments.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.UnmatchedArgumentException.html#printSuggestions-picocli.CommandLine.ParameterException-java.io.PrintStream-">printSuggestions(CommandLine.ParameterException, PrintStream)</a></span> - Static method in exception picocli.<a href="picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></dt>
+<dd>
+<div class="block">Returns <code>true</code> and prints suggested solutions to the specified stream if such solutions exist, otherwise returns <code>false</code>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.UnmatchedArgumentException.html#printSuggestions-java.io.PrintStream-">printSuggestions(PrintStream)</a></span> - Method in exception picocli.<a href="picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></dt>
+<dd>
+<div class="block">Returns <code>true</code> and prints suggested solutions to the specified stream if such solutions exist, otherwise returns <code>false</code>.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#printVersionHelp-java.io.PrintStream-">printVersionHelp(PrintStream)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Delegates to <a href="picocli/CommandLine.html#printVersionHelp-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>CommandLine.printVersionHelp(PrintStream, Help.Ansi)</code></a> with the <a href="picocli/CommandLine.Help.Ansi.html#AUTO">platform default</a>.</div>
@@ -2594,7 +2614,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.2.0".</div>
+<div class="block">This is picocli version "3.3.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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>picocli 3.2.0 API</title>
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>picocli 3.3.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 Fri Jul 06 20:57:23 JST 2018 -->
-<title>Overview List (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:01 JST 2018 -->
+<title>Overview List (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>Overview (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:03 JST 2018 -->
+<title>Overview (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="Overview (picocli 3.3.0 API)";
         }
     }
     catch(err) {
@@ -69,7 +69,7 @@
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="header">
-<h1 class="title">picocli 3.2.0 API</h1>
+<h1 class="title">picocli 3.3.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 Fri Jul 06 20:57:25 JST 2018 -->
-<title>Class Hierarchy (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:06:02 JST 2018 -->
+<title>Class Hierarchy (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="Class Hierarchy (picocli 3.3.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 Fri Jul 06 20:57:12 JST 2018 -->
-<title>AutoComplete (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:05:48 JST 2018 -->
+<title>AutoComplete (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="AutoComplete (picocli 3.3.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 Fri Jul 06 20:57:15 JST 2018 -->
-<title>CommandLine.AbstractHandler (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:05:51 JST 2018 -->
+<title>CommandLine.AbstractHandler (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.2.0 API)";
+            parent.document.title="CommandLine.AbstractHandler (picocli 3.3.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/picocli/CommandLine.AbstractParseResultHandler.html b/docs/apidocs/picocli/CommandLine.AbstractParseResultHandler.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_161) on Fri Jul 06 20:57:15 JST 2018 -->
-<title>CommandLine.AbstractParseResultHandler (picocli 3.2.0 API)</title>
-<meta name="date" content="2018-07-06">
+<!-- Generated by javadoc (1.8.0_161) on Sat Jul 14 04:05:51 JST 2018 -->
+<title>CommandLine.AbstractParseResultHandler (picocli 3.3.0 API)</title>
+<meta name="date" content="2018-07-14">
 <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.AbstractParseResultHandler (picocli 3.2.0 API)";
+            parent.document.title="CommandLine.AbstractParseResultHandler (picocli 3.3.0 API)";
         }
     }
     catch(err) {