Release picocli version 0.9.8

remkop · Aug 6, 2017 · 57dc68e · 57dc68e
1 parent 7a28f69
commit 57dc68e
Show file tree

Hide file tree

Showing 43 changed files with 1,207 additions and 352 deletions.
diff --git a/build.gradle b/build.gradle
@@ -1,11 +1,11 @@
 group 'info.picocli'
 description 'Annotation-based Java command line parser. Usage help with ANSI styles and colors. Easily included as source to avoid adding a dependency.'
-version '0.9.8-SNAPSHOT'
+version '0.9.8'
 
 // for bumpVersion task
-def oldVersion = '0\\.9\\.7'
+def oldVersion = '0\\.9\\.8-SNAPSHOT'
 def oldRevdate = '2017\\-06\\-08'
-def revDate    = '2017-06-08'
+def revDate    = '2017-08-07'
 
 buildscript {
     repositories {

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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>All Classes (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>All Classes (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>All Classes (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>All Classes (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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_131) on Thu Jun 08 01:04:08 JST 2017 -->
-<title>Constant Field Values (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>Constant Field Values (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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 0.9.7 API)";
+            parent.document.title="Constant Field Values (picocli 0.9.8 API)";
         }
     }
     catch(err) {
@@ -93,7 +93,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>"0.9.7"</code></td>
+<td class="colLast"><code>"0.9.8"</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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>Deprecated List (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>Deprecated List (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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 0.9.7 API)";
+            parent.document.title="Deprecated List (picocli 0.9.8 API)";
         }
     }
     catch(err) {
@@ -70,6 +70,35 @@
 <div class="header">
 <h1 title="Deprecated API" class="title">Deprecated API</h1>
 <h2 title="Contents">Contents</h2>
+<ul>
+<li><a href="#method">Deprecated Methods</a></li>
+</ul>
+</div>
+<div class="contentContainer"><a name="method">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Methods table, listing deprecated methods, and an explanation">
+<caption><span>Deprecated Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Method and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colOne"><a href="picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-">picocli.CommandLine.Help.detailedSynopsis(Comparator&lt;Field&gt;, boolean)</a>
+<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>CommandLine.Help.detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div>
+</td>
+</tr>
+<tr class="rowColor">
+<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>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
 </div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">

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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>API Help (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>API Help (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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 0.9.7 API)";
+            parent.document.title="API Help (picocli 0.9.8 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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>Index (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>Index (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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 0.9.7 API)";
+            parent.document.title="Index (picocli 0.9.8 API)";
         }
     }
     catch(err) {
@@ -231,8 +231,7 @@ <h2 class="title">C</h2>
 </dd>
 <dt><a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.Ansi.Text</span></a> - Class in <a href="picocli/package-summary.html">picocli</a></dt>
 <dd>
-<div class="block">Encapsulates rich text with styles and colors in a way that other components like <a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a>
- are unaware of the embedded ANSI escape codes.</div>
+<div class="block">Encapsulates rich text with styles and colors.</div>
 </dd>
 <dt><a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.ColorScheme</span></a> - Class in <a href="picocli/package-summary.html">picocli</a></dt>
 <dd>
@@ -450,6 +449,12 @@ <h2 class="title">D</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-">detailedSynopsis(Comparator&lt;Field&gt;, boolean)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>CommandLine.Help.detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div>
+</div>
+</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-">detailedSynopsis(int, Comparator&lt;Field&gt;, boolean)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
+<dd>
 <div class="block">Generates a detailed synopsis message showing all options and parameters.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html#DuplicateOptionAnnotationsException-java.lang.String-">DuplicateOptionAnnotationsException(String)</a></span> - Constructor for exception picocli.<a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli">CommandLine.DuplicateOptionAnnotationsException</a></dt>
@@ -504,6 +509,10 @@ <h2 class="title">G</h2>
 <dd>
 <div class="block">Returns the annotated object that this <code>CommandLine</code> instance was constructed with.</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>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#getSeparator--">getSeparator()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
 <div class="block">Returns the String that separates option names from option values when parsing command line options.</div>
@@ -583,8 +592,16 @@ <h2 class="title">I</h2>
 <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>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#isUsageHelpRequested--">isUsageHelpRequested()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Returns <code>true</code> if an option annotated with <a href="picocli/CommandLine.Option.html#usageHelp--"><code>CommandLine.Option.usageHelp()</code></a> was specified on the command line.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Range.html#isVariable">isVariable</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#isVersionHelpRequested--">isVersionHelpRequested()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Returns <code>true</code> if an option annotated with <a href="picocli/CommandLine.Option.html#versionHelp--"><code>CommandLine.Option.versionHelp()</code></a> was specified on the command line.</div>
+</dd>
 </dl>
 <a name="I:J">
 <!--   -->
@@ -811,6 +828,14 @@ <h2 class="title">P</h2>
 <dd>
 <div class="block">Immutable list of fields annotated with <a href="picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>, or an empty list if no such field exists.</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>
+</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#printVersionHelp-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">printVersionHelp(PrintStream, CommandLine.Help.Ansi)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Prints version information from the <a href="picocli/CommandLine.Command.html#version--"><code>CommandLine.Command.version()</code></a> annotation to the specified <code>PrintStream</code>.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#putValue-int-int-picocli.CommandLine.Help.Ansi.Text-">putValue(int, int, CommandLine.Help.Ansi.Text)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
 <div class="block">Writes the specified value into the cell at the specified row and column and returns the last row and
@@ -907,7 +932,13 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#synopsis--">synopsis()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
-<div class="block">Returns a synopsis for the command.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<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>
+</div>
+</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#synopsis-int-">synopsis(int)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
+<dd>
+<div class="block">Returns a synopsis for the command, reserving the specified space for the synopsis heading.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#synopsisHeading">synopsisHeading</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
@@ -917,6 +948,10 @@ <h2 class="title">S</h2>
 <dd>
 <div class="block">Returns the text displayed before the synopsis text; the result of <code>String.format(synopsisHeading, params)</code>.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#synopsisHeadingLength--">synopsisHeadingLength()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
+<dd>
+<div class="block">Returns the number of characters the synopsis heading will take on the same line as the synopsis.</div>
+</dd>
 </dl>
 <a name="I:T">
 <!--   -->
@@ -1003,7 +1038,7 @@ <h2 class="title">U</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-">usage(PrintStream, CommandLine.Help.ColorScheme)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">Prints a usage help message for the specified annotated class to the specified <code>PrintStream</code>.</div>
+<div class="block">Prints a usage help message for the annotated command class to the specified <code>PrintStream</code>.</div>
 </dd>
 </dl>
 <a name="I:V">
@@ -1044,7 +1079,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 "0.9.7".</div>
+<div class="block">This is picocli version "0.9.8".</div>
 </dd>
 </dl>
 <a name="I:W">

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_131) on Thu Jun 08 01:04:09 JST 2017 -->
-<title>picocli 0.9.7 API</title>
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>picocli 0.9.8 API</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;
     if (tmpTargetPage != "" && tmpTargetPage != "undefined")

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_131) on Thu Jun 08 01:04:08 JST 2017 -->
-<title>Class Hierarchy (picocli 0.9.7 API)</title>
-<meta name="date" content="2017-06-08">
+<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
+<title>Class Hierarchy (picocli 0.9.8 API)</title>
+<meta name="date" content="2017-08-07">
 <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 0.9.7 API)";
+            parent.document.title="Class Hierarchy (picocli 0.9.8 API)";
         }
     }
     catch(err) {