jlengrand/picocli
1
0
Fork 0
mirror of https://github.com/jlengrand/picocli.git synced 2026-03-10 08:41:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release picocli version 4.0.0-alpha-3

Browse Source
This commit is contained in:
Remko Popma
2019-05-13 21:13:48 +09:00
parent 9e22ccf0e4
commit 5bb3abcbb8
125 changed files with 9026 additions and 3828 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -46,7 +46,7 @@ Picocli-based applications can easily [integrate](https://picocli.info/#_depende
### Releases
* [All Releases](https://github.com/remkop/picocli/releases)
* Latest: 4.0.0-alpha-2 [Release Notes](https://github.com/remkop/picocli/releases/tag/v4.0.0-alpha-2)
* Latest: 4.0.0-alpha-3 [Release Notes](https://github.com/remkop/picocli/releases/tag/v4.0.0-alpha-3)
* Stable: 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)
@@ -199,35 +199,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
### Gradle
```
compile 'info.picocli:picocli:4.0.0-alpha-2'
compile 'info.picocli:picocli:4.0.0-alpha-3'
```
### Maven
```
<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli</artifactId>
<version>4.0.0-alpha-2</version>
<version>4.0.0-alpha-3</version>
</dependency>
```
### Scala SBT
```
libraryDependencies += "info.picocli" % "picocli" % "4.0.0-alpha-2"
libraryDependencies += "info.picocli" % "picocli" % "4.0.0-alpha-3"
```
### Ivy
```
<dependency org="info.picocli" name="picocli" rev="4.0.0-alpha-2" />
<dependency org="info.picocli" name="picocli" rev="4.0.0-alpha-3" />
```
### Grape
```groovy
@Grapes(
@Grab(group='info.picocli', module='picocli', version='4.0.0-alpha-2')
@Grab(group='info.picocli', module='picocli', version='4.0.0-alpha-3')
)
```
### Leiningen
```
[info.picocli/picocli "4.0.0-alpha-2"]
[info.picocli/picocli "4.0.0-alpha-3"]
```
### Buildr
```
'info.picocli:picocli:jar:4.0.0-alpha-2'
'info.picocli:picocli:jar:4.0.0-alpha-3'
```

2
RELEASE-NOTES.md
View File

@@ -1,7 +1,7 @@
# picocli Release Notes
# <a name="4.0.0-alpha-3"></a> Picocli 4.0.0-alpha-3 (UNRELEASED)
# <a name="4.0.0-alpha-3"></a> Picocli 4.0.0-alpha-3
The picocli community is pleased to announce picocli 4.0.0-alpha-3.
This release adds improved support for command execution via the new `execute` method.

14
docs/apidocs/allclasses-frame.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>All Classes (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>All Classes (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -22,11 +22,13 @@
<li><a href="picocli/CommandLine.DuplicateNameException.html" title="class in picocli" target="classFrame">CommandLine.DuplicateNameException</a></li>
<li><a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli" target="classFrame">CommandLine.DuplicateOptionAnnotationsException</a></li>
<li><a href="picocli/CommandLine.ExecutionException.html" title="class in picocli" target="classFrame">CommandLine.ExecutionException</a></li>
<li><a href="picocli/CommandLine.ExitCode.html" title="class in picocli" target="classFrame">CommandLine.ExitCode</a></li>
<li><a href="picocli/CommandLine.Help.html" title="class in picocli" target="classFrame">CommandLine.Help</a></li>
<li><a href="picocli/CommandLine.Help.Ansi.html" title="enum in picocli" target="classFrame">CommandLine.Help.Ansi</a></li>
<li><a href="picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.Help.Ansi.IStyle</span></a></li>
<li><a href="picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli" target="classFrame">CommandLine.Help.Ansi.Style</a></li>
<li><a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli" target="classFrame">CommandLine.Help.ColorScheme</a></li>
<li><a href="picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli" target="classFrame">CommandLine.Help.ColorScheme.Builder</a></li>
<li><a href="picocli/CommandLine.Help.Column.html" title="class in picocli" target="classFrame">CommandLine.Help.Column</a></li>
<li><a href="picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli" target="classFrame">CommandLine.Help.Column.Overflow</a></li>
<li><a href="picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.Help.IOptionRenderer</span></a></li>
@@ -40,11 +42,17 @@
<li><a href="picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IDefaultValueProvider</span></a></li>
<li><a href="picocli/CommandLine.IExceptionHandler.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExceptionHandler</span></a></li>
<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.IExecutionExceptionHandler.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExecutionExceptionHandler</span></a></li>
<li><a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExecutionStrategy</span></a></li>
<li><a href="picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExitCodeExceptionMapper</span></a></li>
<li><a href="picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IExitCodeGenerator</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.IHelpCommandInitializable2.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IHelpCommandInitializable2</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.IParameterExceptionHandler.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.IParameterExceptionHandler</span></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>
<li><a href="picocli/CommandLine.ITypeConverter.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.ITypeConverter</span></a></li>

14
docs/apidocs/allclasses-noframe.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>All Classes (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>All Classes (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -22,11 +22,13 @@
<li><a href="picocli/CommandLine.DuplicateNameException.html" title="class in picocli">CommandLine.DuplicateNameException</a></li>
<li><a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli">CommandLine.DuplicateOptionAnnotationsException</a></li>
<li><a href="picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></li>
<li><a href="picocli/CommandLine.ExitCode.html" title="class in picocli">CommandLine.ExitCode</a></li>
<li><a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></li>
<li><a href="picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></li>
<li><a href="picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli"><span class="interfaceName">CommandLine.Help.Ansi.IStyle</span></a></li>
<li><a href="picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a></li>
<li><a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></li>
<li><a href="picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></li>
<li><a href="picocli/CommandLine.Help.Column.html" title="class in picocli">CommandLine.Help.Column</a></li>
<li><a href="picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a></li>
<li><a href="picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli"><span class="interfaceName">CommandLine.Help.IOptionRenderer</span></a></li>
@@ -40,11 +42,17 @@
<li><a href="picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><span class="interfaceName">CommandLine.IDefaultValueProvider</span></a></li>
<li><a href="picocli/CommandLine.IExceptionHandler.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExceptionHandler</span></a></li>
<li><a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExceptionHandler2</span></a></li>
<li><a href="picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExecutionExceptionHandler</span></a></li>
<li><a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExecutionStrategy</span></a></li>
<li><a href="picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExitCodeExceptionMapper</span></a></li>
<li><a href="picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="interfaceName">CommandLine.IExitCodeGenerator</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.IHelpCommandInitializable2.html" title="interface in picocli"><span class="interfaceName">CommandLine.IHelpCommandInitializable2</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.IParameterExceptionHandler.html" title="interface in picocli"><span class="interfaceName">CommandLine.IParameterExceptionHandler</span></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>
<li><a href="picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><span class="interfaceName">CommandLine.ITypeConverter</span></a></li>

95
docs/apidocs/constant-values.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>Constant Field Values (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>Constant Field Values (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (picocli 4.0.0-alpha-2 API)";
parent.document.title="Constant Field Values (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -139,9 +139,42 @@
<tr class="altColor">
<td class="colFirst"><a name="picocli.CommandLine.VERSION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
</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-alpha-2"</code></td>
<td class="colLast"><code>"4.0.0-alpha-3"</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.ExitCode.html" title="class in picocli">CommandLine.ExitCode</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.CommandLine.ExitCode.OK">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="picocli/CommandLine.ExitCode.html#OK">OK</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="picocli.CommandLine.ExitCode.SOFTWARE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="picocli/CommandLine.ExitCode.html#SOFTWARE">SOFTWARE</a></code></td>
<td class="colLast"><code>70</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="picocli.CommandLine.ExitCode.USAGE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="picocli/CommandLine.ExitCode.html#USAGE">USAGE</a></code></td>
<td class="colLast"><code>64</code></td>
</tr>
</tbody>
</table>
@@ -158,14 +191,14 @@
<tr class="altColor">
<td class="colFirst"><a name="picocli.CommandLine.Help.DEFAULT_COMMAND_NAME">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
</a><code>protected&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.Help.html#DEFAULT_COMMAND_NAME">DEFAULT_COMMAND_NAME</a></code></td>
<td class="colLast"><code>"&lt;main class&gt;"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="picocli.CommandLine.Help.DEFAULT_SEPARATOR">
<!-- -->
</a><code>protected&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
</a><code>protected&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.Help.html#DEFAULT_SEPARATOR">DEFAULT_SEPARATOR</a></code></td>
<td class="colLast"><code>"="</code></td>
</tr>
@@ -184,7 +217,7 @@
<tr class="altColor">
<td class="colFirst"><a name="picocli.CommandLine.Help.Ansi.IStyle.CSI">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
</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.Help.Ansi.IStyle.html#CSI">CSI</a></code></td>
<td class="colLast"><code>"\u001b["</code></td>
</tr>
@@ -210,98 +243,112 @@
<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>
</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.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>
</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.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>
</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.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>
</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.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_EXIT_CODE_LIST">
<!-- -->
</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.Model.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST">SECTION_KEY_EXIT_CODE_LIST</a></code></td>
<td class="colLast"><code>"exitCodeList"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_EXIT_CODE_LIST_HEADING">
<!-- -->
</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.Model.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST_HEADING">SECTION_KEY_EXIT_CODE_LIST_HEADING</a></code></td>
<td class="colLast"><code>"exitCodeListHeading"</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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.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>
</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.Model.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS_HEADING">SECTION_KEY_SYNOPSIS_HEADING</a></code></td>
<td class="colLast"><code>"synopsisHeading"</code></td>
</tr>
@@ -326,7 +373,7 @@
<tr class="altColor">
<td class="colFirst"><a name="picocli.groovy.PicocliBaseScript.COMMAND_LINE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
</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/groovy/PicocliBaseScript.html#COMMAND_LINE">COMMAND_LINE</a></code></td>
<td class="colLast"><code>"commandLine"</code></td>
</tr>

250
docs/apidocs/deprecated-list.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>Deprecated List (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>Deprecated List (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (picocli 4.0.0-alpha-2 API)";
parent.document.title="Deprecated List (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -73,6 +73,8 @@
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#interface">Deprecated Interfaces</a></li>
<li><a href="#class">Deprecated Classes</a></li>
<li><a href="#field">Deprecated Fields</a></li>
<li><a href="#method">Deprecated Methods</a></li>
<li><a href="#constructor">Deprecated Constructors</a></li>
<li><a href="#annotation.type.member">Deprecated Annotation Type Elements</a></li>
@@ -91,12 +93,87 @@
<tbody>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.IExceptionHandler.html" title="interface in picocli">picocli.CommandLine.IExceptionHandler</a>
<div class="block"><span class="deprecationComment">Use <a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a> instead.</span></div>
<div class="block"><span class="deprecationComment">see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><code>CommandLine.IParameterExceptionHandler</code></a> and <a href="picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><code>CommandLine.IExecutionExceptionHandler</code></a></span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli">picocli.CommandLine.IExceptionHandler2</a>
<div class="block"><span class="deprecationComment">see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><code>CommandLine.IParameterExceptionHandler</code></a> and <a href="picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><code>CommandLine.IExecutionExceptionHandler</code></a></span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">picocli.CommandLine.IHelpCommandInitializable</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><code>CommandLine.IHelpCommandInitializable2</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">picocli.CommandLine.IParseResultHandler</a>
<div class="block"><span class="deprecationComment">Use <a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><code>CommandLine.IParseResultHandler2</code></a> instead.</span></div>
<div class="block"><span class="deprecationComment">Use <a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><code>CommandLine.IExecutionStrategy</code></a> instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">picocli.CommandLine.IParseResultHandler2</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><code>CommandLine.IExecutionStrategy</code></a> instead, see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></span></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="class">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Classes table, listing deprecated classes, and an explanation">
<caption><span>Deprecated Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>
<div class="block"><span class="deprecationComment">see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>
<div class="block"><span class="deprecationComment">see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="picocli/CommandLine.html#getExecutionStrategy--"><code>CommandLine.getExecutionStrategy()</code></a>, <a href="picocli/CommandLine.html#getParameterExceptionHandler--"><code>CommandLine.getParameterExceptionHandler()</code></a>, <a href="picocli/CommandLine.html#getExecutionExceptionHandler--"><code>CommandLine.getExecutionExceptionHandler()</code></a></span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">picocli.CommandLine.DefaultExceptionHandler</a>
<div class="block"><span class="deprecationComment">see <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="picocli/CommandLine.html#getParameterExceptionHandler--"><code>CommandLine.getParameterExceptionHandler()</code></a> and <a href="picocli/CommandLine.html#getExecutionExceptionHandler--"><code>CommandLine.getExecutionExceptionHandler()</code></a></span></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="field">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Fields table, listing deprecated fields, and an explanation">
<caption><span>Deprecated Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Field and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.Range.html#isVariable">picocli.CommandLine.Range.isVariable</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Range.html#isVariable--"><code>CommandLine.Range.isVariable()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.Range.html#max">picocli.CommandLine.Range.max</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Range.html#max--"><code>CommandLine.Range.max()</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.Range.html#min">picocli.CommandLine.Range.min</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Range.html#min--"><code>CommandLine.Range.min()</code></a> instead</span></div>
</td>
</tr>
</tbody>
@@ -118,6 +195,16 @@
<td class="colOne"><a href="picocli/CommandLine.Help.html#addSubcommand-java.lang.String-java.lang.Object-">picocli.CommandLine.Help.addSubcommand(String, Object)</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractHandler.html#andExit-int-">picocli.CommandLine.AbstractHandler.andExit(int)</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead, and call <code>System.exit()</code> in the application.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractHandler.html#ansi--">picocli.CommandLine.AbstractHandler.ansi()</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.AbstractHandler.html#colorScheme--"><code>CommandLine.AbstractHandler.colorScheme()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.Help.Ansi.Text.html#append-picocli.CommandLine.Help.Ansi.Text-">picocli.CommandLine.Help.Ansi.Text.append(CommandLine.Help.Ansi.Text)</a>
<div class="block"><span class="deprecationComment">use <code>#concat(Text)</code> instead</span></div>
</td>
@@ -128,6 +215,46 @@
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.call(Class&lt;C&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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.call(Class&lt;C&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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-java.lang.Class-picocli.CommandLine.IFactory-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.call(Class&lt;C&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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-java.lang.Class-picocli.CommandLine.IFactory-java.lang.String...-">picocli.CommandLine.call(Class&lt;C&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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-C-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.call(C, 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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-C-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.call(C, 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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#call-C-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.call(C, 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">
<td class="colOne"><a href="picocli/CommandLine.html#call-C-java.lang.String...-">picocli.CommandLine.call(C, 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">
<td class="colOne"><a href="picocli/CommandLine.Help.TextTable.html#cellAt-int-int-">picocli.CommandLine.Help.TextTable.cellAt(int, int)</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.Help.TextTable.html#textAt-int-int-"><code>CommandLine.Help.TextTable.textAt(int, int)</code></a> instead</span></div>
</td>
@@ -153,23 +280,69 @@
</td>
</tr>
<tr class="altColor">
<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-java.lang.String:A-int-int-java.lang.String-"><code>CommandLine.Help.join(String[], int, int, String)</code></a> instead</span></div>
<td class="colOne"><a href="picocli/CommandLine.HelpCommand.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">picocli.CommandLine.HelpCommand.init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream)</a></td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.IHelpCommandInitializable.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">picocli.CommandLine.IHelpCommandInitializable.init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream)</a></td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.html#invoke-java.lang.String-java.lang.Class-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.invoke(String, Class&lt;?&gt;, 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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#invoke-java.lang.String-java.lang.Class-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">picocli.CommandLine.invoke(String, Class&lt;?&gt;, 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> and <a href="picocli/CommandLine.html#getExecutionResult--"><code>CommandLine.getExecutionResult()</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.html#invoke-java.lang.String-java.lang.Class-java.io.PrintStream-java.lang.String...-">picocli.CommandLine.invoke(String, Class&lt;?&gt;, 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="rowColor">
<td class="colOne"><a href="picocli/CommandLine.html#invoke-java.lang.String-java.lang.Class-java.lang.String...-">picocli.CommandLine.invoke(String, Class&lt;?&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="altColor">
<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">
<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="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#parseWithHandler-picocli.CommandLine.IParseResultHandler2-java.lang.String:A-"><code>CommandLine.parseWithHandler(IParseResultHandler2, String[])</code></a> instead</span></div>
<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">
<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="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#parseWithHandlers-picocli.CommandLine.IParseResultHandler2-picocli.CommandLine.IExceptionHandler2-java.lang.String...-"><code>CommandLine.parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...)</code></a> instead</span></div>
<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">
<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-java.util.List-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>CommandLine.printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi)</code></a> instead</span></div>
<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="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="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="altColor">
@@ -178,6 +351,46 @@
</td>
</tr>
<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="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="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="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="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="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="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="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.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>
@@ -187,6 +400,21 @@
<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>
<tr class="rowColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">picocli.CommandLine.AbstractHandler.useAnsi(CommandLine.Help.Ansi)</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#setColorScheme-picocli.CommandLine.Help.ColorScheme-"><code>CommandLine.setColorScheme(Help.ColorScheme)</code></a> and <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">picocli.CommandLine.AbstractHandler.useErr(PrintStream)</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#setErr-java.io.PrintWriter-"><code>CommandLine.setErr(PrintWriter)</code></a> and <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.AbstractHandler.html#useOut-java.io.PrintStream-">picocli.CommandLine.AbstractHandler.useOut(PrintStream)</a>
<div class="block"><span class="deprecationComment">use <a href="picocli/CommandLine.html#setOut-java.io.PrintWriter-"><code>CommandLine.setOut(PrintWriter)</code></a> and <a href="picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
</td>
</tr>
</tbody>
</table>
</li>

8
docs/apidocs/help-doc.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>API Help (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>API Help (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (picocli 4.0.0-alpha-2 API)";
parent.document.title="API Help (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {

661
docs/apidocs/index-all.html
View File

File diff suppressed because it is too large Load Diff

4
docs/apidocs/index.html
View File

@@ -2,8 +2,8 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>picocli 4.0.0-alpha-2 API</title>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>picocli 4.0.0-alpha-3 API</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")

6
docs/apidocs/overview-frame.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>Overview List (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>Overview List (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>

27
docs/apidocs/overview-summary.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>Overview (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>Overview (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (picocli 4.0.0-alpha-2 API)";
parent.document.title="Overview (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -69,7 +69,7 @@
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">picocli 4.0.0-alpha-2 API</h1>
<h1 class="title">picocli 4.0.0-alpha-3 API</h1>
</div>
<div class="header">
<div class="subTitle">
@@ -120,16 +120,16 @@
<p>
Picocli provides a number of <a href="http://picocli.info/#_less_boilerplate">convenience methods</a>
that allow you to omit error handling and other boilerplate code for common use cases.
Here is a small example application that uses the <code>CommandLine.call</code> convenience method
Here is a small example application that uses the <code>CommandLine.execute</code> convenience method
to do parsing and error handling in one line of code.
</p>
<p>
The full user manual is hosted at <a href="http://picocli.info/">http://picocli.info</a>.
</p>
<pre>
&#064;Command(name = "checksum", mixinStandardHelpOptions = true, version = "Checksum 2.0",
&#064;Command(name = "checksum", mixinStandardHelpOptions = true, version = "Checksum 4.0",
description = "Prints the checksum (MD5 by default) of a file to STDOUT.")
class CheckSum implements Callable&lt;Void&gt; {
class CheckSum implements Callable&lt;Integer&gt; {
&#064;Parameters(index = "0", description = "The file whose checksum to calculate.")
private File file;
@@ -140,16 +140,17 @@ class CheckSum implements Callable&lt;Void&gt; {
public static void main(String[] args) throws Exception {
// CheckSum implements Callable, so parsing, error handling and handling user
// requests for usage help or version help can be done with one line of code.
CommandLine.call(new CheckSum(), args);
int exitCode = new CommandLine(new CheckSum()).execute(args);
System.exit(exitCode);
}
&#064;Override
public Void call() throws Exception {
// your business logic goes here
public Integer call() throws Exception { // your business logic goes here
byte[] fileContents = Files.readAllBytes(file.toPath());
byte[] digest = MessageDigest.getInstance(algorithm).digest(fileContents);
System.out.println(javax.xml.bind.DatatypeConverter.printHexBinary(digest));
return null;
System.out.printf("%0" + (digest.length*2) + "x%n", new BigInteger(1, digest));
return 0;
}
}
</pre></div>

62
docs/apidocs/overview-tree.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:13 JST 2019 -->
<title>Class Hierarchy (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>Class Hierarchy (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Class Hierarchy (picocli 4.0.0-alpha-2 API)";
parent.document.title="Class Hierarchy (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -79,14 +79,14 @@
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Object</span></a>
<ul>
<li type="circle">org.codehaus.groovy.transform.AbstractASTTransformation (implements org.codehaus.groovy.transform.ASTTransformation, groovyjarjarasm.asm.Opcodes)
<li type="circle">org.codehaus.groovy.transform.<a href="http://docs.groovy-lang.org/2.4.9/html/gapi/org/codehaus/groovy/transform/AbstractASTTransformation.html?is-external=true" title="class or interface in org.codehaus.groovy.transform"><span class="typeNameLink">AbstractASTTransformation</span></a> (implements org.codehaus.groovy.transform.<a href="http://docs.groovy-lang.org/2.4.9/html/gapi/org/codehaus/groovy/transform/ASTTransformation.html?is-external=true" title="class or interface in org.codehaus.groovy.transform">ASTTransformation</a>, groovyjarjarasm.asm.Opcodes)
<ul>
<li type="circle">picocli.groovy.<a href="picocli/groovy/PicocliScriptASTTransformation.html" title="class in picocli.groovy"><span class="typeNameLink">PicocliScriptASTTransformation</span></a></li>
</ul>
</li>
<li type="circle">java.lang.reflect.AccessibleObject (implements java.lang.reflect.AnnotatedElement)
<li type="circle">java.lang.reflect.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect"><span class="typeNameLink">AccessibleObject</span></a> (implements java.lang.reflect.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a>)
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.Model.MethodParam.html" title="class in picocli"><span class="typeNameLink">CommandLine.Model.MethodParam</span></a></li>
</ul>
@@ -95,7 +95,7 @@
<li type="circle">picocli.<a href="picocli/CommandLine.html" title="class in picocli"><span class="typeNameLink">CommandLine</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.AbstractHandler.html" title="class in picocli"><span class="typeNameLink">CommandLine.AbstractHandler</span></a>&lt;R,T&gt;
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli"><span class="typeNameLink">CommandLine.AbstractParseResultHandler</span></a>&lt;R&gt; (implements picocli.<a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;)
<li type="circle">picocli.<a href="picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli"><span class="typeNameLink">CommandLine.AbstractParseResultHandler</span></a>&lt;R&gt; (implements picocli.<a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a>, picocli.<a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;)
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.RunAll.html" title="class in picocli"><span class="typeNameLink">CommandLine.RunAll</span></a> (implements picocli.<a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.RunFirst.html" title="class in picocli"><span class="typeNameLink">CommandLine.RunFirst</span></a> (implements picocli.<a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>)</li>
@@ -105,14 +105,16 @@
<li type="circle">picocli.<a href="picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli"><span class="typeNameLink">CommandLine.DefaultExceptionHandler</span></a>&lt;R&gt; (implements picocli.<a href="picocli/CommandLine.IExceptionHandler.html" title="interface in picocli">CommandLine.IExceptionHandler</a>, picocli.<a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli">CommandLine.IExceptionHandler2</a>&lt;R&gt;)</li>
</ul>
</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ExitCode.html" title="class in picocli"><span class="typeNameLink">CommandLine.ExitCode</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.Ansi.Text</span></a> (implements java.lang.Cloneable)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.Ansi.Text</span></a> (implements java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.ColorScheme</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.ColorScheme.Builder</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Column.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.Column</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Layout.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.Layout</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.TextTable</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.TextTable.Cell.html" title="class in picocli"><span class="typeNameLink">CommandLine.Help.TextTable.Cell</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.HelpCommand.html" title="class in picocli"><span class="typeNameLink">CommandLine.HelpCommand</span></a> (implements picocli.<a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, java.lang.Runnable)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.HelpCommand.html" title="class in picocli"><span class="typeNameLink">CommandLine.HelpCommand</span></a> (implements picocli.<a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, picocli.<a href="picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a>, java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Model.html" title="class in picocli"><span class="typeNameLink">CommandLine.Model</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli"><span class="typeNameLink">CommandLine.Model.ArgGroupSpec</span></a> (implements picocli.<a href="picocli/CommandLine.Model.IOrdered.html" title="interface in picocli">CommandLine.Model.IOrdered</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli"><span class="typeNameLink">CommandLine.Model.ArgGroupSpec.Builder</span></a></li>
@@ -133,21 +135,21 @@
<li type="circle">picocli.<a href="picocli/CommandLine.ParseResult.Builder.html" title="class in picocli"><span class="typeNameLink">CommandLine.ParseResult.Builder</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli"><span class="typeNameLink">CommandLine.ParseResult.GroupMatch</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli"><span class="typeNameLink">CommandLine.ParseResult.GroupMatchContainer</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Range.html" title="class in picocli"><span class="typeNameLink">CommandLine.Range</span></a> (implements java.lang.Comparable&lt;T&gt;)</li>
<li type="circle">groovy.lang.GroovyObjectSupport (implements groovy.lang.GroovyObject)
<li type="circle">picocli.<a href="picocli/CommandLine.Range.html" title="class in picocli"><span class="typeNameLink">CommandLine.Range</span></a> (implements java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;)</li>
<li type="circle">groovy.lang.<a href="http://docs.groovy-lang.org/2.4.9/html/gapi/groovy/lang/GroovyObjectSupport.html?is-external=true" title="class or interface in groovy.lang"><span class="typeNameLink">GroovyObjectSupport</span></a> (implements groovy.lang.<a href="http://docs.groovy-lang.org/2.4.9/html/gapi/groovy/lang/GroovyObject.html?is-external=true" title="class or interface in groovy.lang">GroovyObject</a>)
<ul>
<li type="circle">groovy.lang.Script
<li type="circle">groovy.lang.<a href="http://docs.groovy-lang.org/2.4.9/html/gapi/groovy/lang/Script.html?is-external=true" title="class or interface in groovy.lang"><span class="typeNameLink">Script</span></a>
<ul>
<li type="circle">picocli.groovy.<a href="picocli/groovy/PicocliBaseScript.html" title="class in picocli.groovy"><span class="typeNameLink">PicocliBaseScript</span></a></li>
</ul>
</li>
</ul>
</li>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Throwable</span></a> (implements java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>)
<ul>
<li type="circle">java.lang.Exception
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Exception</span></a>
<ul>
<li type="circle">java.lang.RuntimeException
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">RuntimeException</span></a>
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.PicocliException.html" title="class in picocli"><span class="typeNameLink">CommandLine.PicocliException</span></a>
<ul>
@@ -193,10 +195,16 @@
<li type="circle">picocli.<a href="picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IDefaultValueProvider</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExceptionHandler</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExceptionHandler2</span></a>&lt;R&gt;</li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExecutionExceptionHandler</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExecutionStrategy</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExitCodeExceptionMapper</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IExitCodeGenerator</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IFactory</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IHelpCommandInitializable</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IHelpCommandInitializable2</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IHelpFactory</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IHelpSectionRenderer</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IParameterExceptionHandler</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IParseResultHandler</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><span class="typeNameLink">CommandLine.IParseResultHandler2</span></a>&lt;R&gt;</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><span class="typeNameLink">CommandLine.ITypeConverter</span></a>&lt;K&gt;</li>
@@ -217,21 +225,21 @@
</ul>
<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2>
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.Option.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Option</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Parameters.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Parameters</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ParentCommand.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.ParentCommand</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Unmatched.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Unmatched</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Mixin.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Mixin</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Spec.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Spec</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Command.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Command</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ArgGroup.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.ArgGroup</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.groovy.<a href="picocli/groovy/PicocliScript.html" title="annotation in picocli.groovy"><span class="typeNameLink">PicocliScript</span></a> (implements java.lang.annotation.Annotation)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Option.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Option</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Parameters.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Parameters</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ParentCommand.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.ParentCommand</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Unmatched.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Unmatched</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Mixin.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Mixin</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Spec.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Spec</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.Command.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.Command</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.<a href="picocli/CommandLine.ArgGroup.html" title="annotation in picocli"><span class="typeNameLink">CommandLine.ArgGroup</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
<li type="circle">picocli.groovy.<a href="picocli/groovy/PicocliScript.html" title="annotation in picocli.groovy"><span class="typeNameLink">PicocliScript</span></a> (implements java.lang.annotation.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li>
</ul>
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Object</span></a>
<ul>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a>&lt;E&gt; (implements java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;, java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>)
<ul>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Visibility.html" title="enum in picocli"><span class="typeNameLink">CommandLine.Help.Visibility</span></a></li>
<li type="circle">picocli.<a href="picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli"><span class="typeNameLink">CommandLine.Help.Column.Overflow</span></a></li>

52
docs/apidocs/picocli/AutoComplete.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:10 JST 2019 -->
<title>AutoComplete (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:45 JST 2019 -->
<title>AutoComplete (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AutoComplete (picocli 4.0.0-alpha-2 API)";
parent.document.title="AutoComplete (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.AutoComplete</li>
@@ -109,7 +109,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public class <span class="typeNameLabel">AutoComplete</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.</div>
</li>
</ul>
@@ -175,17 +175,17 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#bash-java.lang.String-picocli.CommandLine-">bash</a></span>(java.lang.String&nbsp;scriptName,
<td class="colFirst"><code>static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#bash-java.lang.String-picocli.CommandLine-">bash</a></span>(<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>&nbsp;scriptName,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)</code>
<div class="block">Generates and returns the source code for an autocompletion bash script for the specified picocli-based application.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#bash-java.lang.String-java.io.File-java.io.File-picocli.CommandLine-">bash</a></span>(java.lang.String&nbsp;scriptName,
java.io.File&nbsp;out,
java.io.File&nbsp;command,
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#bash-java.lang.String-java.io.File-java.io.File-picocli.CommandLine-">bash</a></span>(<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>&nbsp;scriptName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;command,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)</code>
<div class="block">Generates source code for an autocompletion bash script for the specified picocli-based application,
and writes this script to the specified <code>out</code> file, and optionally writes an invocation script
@@ -195,15 +195,15 @@ extends java.lang.Object</pre>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#complete-picocli.CommandLine.Model.CommandSpec-java.lang.String:A-int-int-int-java.util.List-">complete</a></span>(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String[]&nbsp;args,
<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>[]&nbsp;args,
int&nbsp;argIndex,
int&nbsp;positionInArg,
int&nbsp;cursor,
java.util.List&lt;java.lang.CharSequence&gt;&nbsp;candidates)</code>&nbsp;</td>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&gt;&nbsp;candidates)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#main-java.lang.String...-">main</a></span>(java.lang.String...&nbsp;args)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/AutoComplete.html#main-java.lang.String...-">main</a></span>(<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>...&nbsp;args)</code>
<div class="block">Generates a bash completion script for the specified command class.</div>
</td>
</tr>
@@ -212,8 +212,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -313,7 +313,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String...&nbsp;args)</pre>
<pre>public static&nbsp;void&nbsp;main(<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>...&nbsp;args)</pre>
<div class="block">Generates a bash completion script for the specified command class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -329,11 +329,11 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>bash</h4>
<pre>public static&nbsp;void&nbsp;bash(java.lang.String&nbsp;scriptName,
java.io.File&nbsp;out,
java.io.File&nbsp;command,
<pre>public static&nbsp;void&nbsp;bash(<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>&nbsp;scriptName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;command,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)
throws java.io.IOException</pre>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Generates source code for an autocompletion bash script for the specified picocli-based application,
and writes this script to the specified <code>out</code> file, and optionally writes an invocation script
to the specified <code>command</code> file.</div>
@@ -344,7 +344,7 @@ extends java.lang.Object</pre>
<dd><code>out</code> - the file to write the autocompletion bash script source code to</dd>
<dd><code>command</code> - the file to write a helper script to that invokes the command, or <code>null</code> if no helper script file should be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if a problem occurred writing to the specified files</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a problem occurred writing to the specified files</dd>
</dl>
</li>
</ul>
@@ -354,8 +354,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>bash</h4>
<pre>public static&nbsp;java.lang.String&nbsp;bash(java.lang.String&nbsp;scriptName,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)</pre>
<pre>public static&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>&nbsp;bash(<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>&nbsp;scriptName,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)</pre>
<div class="block">Generates and returns the source code for an autocompletion bash script for the specified picocli-based application.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -373,11 +373,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>complete</h4>
<pre>public static&nbsp;int&nbsp;complete(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String[]&nbsp;args,
<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>[]&nbsp;args,
int&nbsp;argIndex,
int&nbsp;positionInArg,
int&nbsp;cursor,
java.util.List&lt;java.lang.CharSequence&gt;&nbsp;candidates)</pre>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</a>&gt;&nbsp;candidates)</pre>
</li>
</ul>
</li>

189
docs/apidocs/picocli/CommandLine.AbstractHandler.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.AbstractHandler (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.AbstractHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.AbstractHandler (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.AbstractHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":38,"i10":42,"i11":42,"i12":42,"i13":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.AbstractHandler&lt;R,T&gt;</li>
@@ -120,9 +120,13 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></span></div>
</div>
<br>
<pre>public abstract static class <span class="typeNameLabel">CommandLine.AbstractHandler&lt;R,T extends CommandLine.AbstractHandler&lt;R,T&gt;&gt;</span>
extends java.lang.Object</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public abstract static class <span class="typeNameLabel">CommandLine.AbstractHandler&lt;R,T extends CommandLine.AbstractHandler&lt;R,T&gt;&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Abstract superclass for <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><code>CommandLine.IParseResultHandler2</code></a> and <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a> implementations.
<p>Note that <code>AbstractHandler</code> is a generic type. This, along with the abstract <code>self</code> method,
allows method chaining to work properly in subclasses, without the need for casts. An example subclass can look like this:</p>
@@ -156,7 +160,9 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#AbstractHandler--">AbstractHandler</a></span>()</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#AbstractHandler--">AbstractHandler</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
@@ -168,7 +174,7 @@ extends java.lang.Object</pre>
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -176,86 +182,111 @@ extends java.lang.Object</pre>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a></span>(int&nbsp;exitCode)</code>
<div class="block">Indicates that the handler should call <code>System.exit(int)</code> after processing completes and sets the exit code to use as the termination status.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead, and call <code>System.exit()</code> in the application.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a></span>()</code>
<div class="block">Returns the ANSI style to use.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--"><code>colorScheme()</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.io.PrintStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a></span>()</code>
<div class="block">Returns the stream to print diagnostic messages to.</div>
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the ColorScheme to use.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a></span>(int&nbsp;exitCode)</code>
<div class="block">Calls <code>System.exit(int)</code> with the specified exit code.</div>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the stream to print diagnostic messages to.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a></span>()</code>
<div class="block">Returns the exit code to use as the termination status, or <code>null</code> (the default) if the handler should
not call <code>System.exit(int)</code> after processing completes.</div>
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a></span>(int&nbsp;exitCode)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Calls <code>System.exit(int)</code> with the specified exit code.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a></span>()</code>
<div class="block">Returns <code>true</code> if an exit code was set with <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-"><code>andExit(int)</code></a>, or <code>false</code> (the default) if
the handler should not call <code>System.exit(int)</code> after processing completes.</div>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the exit code to use as the termination status, or <code>null</code> (the default) if the handler should
not call <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#exit-int-" title="class or interface in java.lang"><code>System.exit(int)</code></a> after processing completes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.io.PrintStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a></span>()</code>
<div class="block">Returns the stream to print command output to.</div>
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns <code>true</code> if an exit code was set with <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-"><code>andExit(int)</code></a>, or <code>false</code> (the default) if
the handler should not call <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#exit-int-" title="class or interface in java.lang"><code>System.exit(int)</code></a> after processing completes.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the stream to print command output to.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a></span>(<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a>&nbsp;result)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for subclasses that returns the specified result object if no exit code was set,
or otherwise, if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>, calls <code>System.exit</code> with the configured
exit code to terminate the currently running Java virtual machine.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a></span>(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for subclasses that throws the specified ExecutionException if no exit code was set,
or otherwise, if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>, prints the stacktrace of the specified exception
to the diagnostic error stream and calls <code>System.exit</code> with the configured
exit code to terminate the currently running Java virtual machine.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Sets the ANSI style to use.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a></span>(java.io.PrintStream&nbsp;err)</code>
<div class="block">Sets the stream to print diagnostic messages to.</div>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.html#setColorScheme-picocli.CommandLine.Help.ColorScheme-"><code>CommandLine.setColorScheme(Help.ColorScheme)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></span>(java.io.PrintStream&nbsp;out)</code>
<div class="block">Sets the stream to print command output to.</div>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.html#setErr-java.io.PrintWriter-"><code>CommandLine.setErr(PrintWriter)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.html#setOut-java.io.PrintWriter-"><code>CommandLine.setOut(PrintWriter)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
</div>
</td>
</tr>
</table>
@@ -263,8 +294,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -287,6 +318,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>AbstractHandler</h4>
<pre>public&nbsp;AbstractHandler()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
@@ -303,7 +335,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>out</h4>
<pre>public&nbsp;java.io.PrintStream&nbsp;out()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the stream to print command output to. Defaults to <code>System.out</code>, unless <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-"><code>useOut(PrintStream)</code></a>
was called with a different stream.
<p><code>IParseResultHandler2</code> implementations should use this stream.
@@ -317,7 +350,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>err</h4>
<pre>public&nbsp;java.io.PrintStream&nbsp;err()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the stream to print diagnostic messages to. Defaults to <code>System.err</code>, unless <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-"><code>useErr(PrintStream)</code></a>
was called with a different stream. <p><code>IExceptionHandler2</code> implementations should use this stream to print error
messages (which may include a usage help message) when an unexpected error occurs.</p></div>
@@ -329,19 +363,37 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>ansi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--"><code>colorScheme()</code></a> instead</span></div>
<div class="block">Returns the ANSI style to use. Defaults to <code>Help.Ansi.AUTO</code>, unless <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-"><code>useAnsi(CommandLine.Help.Ansi)</code></a> was called with a different setting.</div>
</li>
</ul>
<a name="colorScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>colorScheme</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the ColorScheme to use. Defaults to <code>Help#defaultColorScheme(Help.Ansi.AUTO)</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="exitCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCode</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;exitCode()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;exitCode()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the exit code to use as the termination status, or <code>null</code> (the default) if the handler should
not call <code>System.exit(int)</code> after processing completes.</div>
not call <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#exit-int-" title="class or interface in java.lang"><code>System.exit(int)</code></a> after processing completes.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-"><code>andExit(int)</code></a></dd>
@@ -355,8 +407,9 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>hasExitCode</h4>
<pre>public&nbsp;boolean&nbsp;hasExitCode()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns <code>true</code> if an exit code was set with <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-"><code>andExit(int)</code></a>, or <code>false</code> (the default) if
the handler should not call <code>System.exit(int)</code> after processing completes.</div>
the handler should not call <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#exit-int-" title="class or interface in java.lang"><code>System.exit(int)</code></a> after processing completes.</div>
</li>
</ul>
<a name="returnResultOrExit-java.lang.Object-">
@@ -368,6 +421,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>returnResultOrExit</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a>&nbsp;returnResultOrExit(<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a>&nbsp;result)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for subclasses that returns the specified result object if no exit code was set,
or otherwise, if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>, calls <code>System.exit</code> with the configured
exit code to terminate the currently running Java virtual machine.</div>
@@ -380,6 +434,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>throwOrExit</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">R</a>&nbsp;throwOrExit(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Convenience method for subclasses that throws the specified ExecutionException if no exit code was set,
or otherwise, if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>, prints the stacktrace of the specified exception
to the diagnostic error stream and calls <code>System.exit</code> with the configured
@@ -393,6 +448,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>exit</h4>
<pre>protected&nbsp;void&nbsp;exit(int&nbsp;exitCode)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Calls <code>System.exit(int)</code> with the specified exit code.</div>
</li>
</ul>
@@ -403,6 +459,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>self</h4>
<pre>protected abstract&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;self()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
</li>
</ul>
@@ -412,12 +469,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>useOut</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useOut(java.io.PrintStream&nbsp;out)</pre>
<div class="block">Sets the stream to print command output to. For use by <code>IParseResultHandler2</code> implementations.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.AbstractHandler.html#out--"><code>out()</code></a></dd>
</dl>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useOut(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.html#setOut-java.io.PrintWriter-"><code>CommandLine.setOut(PrintWriter)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
<div class="block">Sets the stream to print command output to.</div>
</li>
</ul>
<a name="useErr-java.io.PrintStream-">
@@ -426,12 +481,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>useErr</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useErr(java.io.PrintStream&nbsp;err)</pre>
<div class="block">Sets the stream to print diagnostic messages to. For use by <code>IExceptionHandler2</code> implementations.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.AbstractHandler.html#err--"><code>err()</code></a></dd>
</dl>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useErr(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.html#setErr-java.io.PrintWriter-"><code>CommandLine.setErr(PrintWriter)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
<div class="block">Sets the stream to print diagnostic messages to.</div>
</li>
</ul>
<a name="useAnsi-picocli.CommandLine.Help.Ansi-">
@@ -440,8 +493,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>useAnsi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useAnsi(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Sets the ANSI style to use.</div>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;useAnsi(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.html#setColorScheme-picocli.CommandLine.Help.ColorScheme-"><code>CommandLine.setColorScheme(Help.ColorScheme)</code></a> and <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead</span></div>
<div class="block">Sets the ANSI style to use and resets the color scheme to the default.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.AbstractHandler.html#ansi--"><code>ansi()</code></a></dd>
@@ -454,8 +509,10 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>andExit</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;andExit(int&nbsp;exitCode)</pre>
<div class="block">Indicates that the handler should call <code>System.exit(int)</code> after processing completes and sets the exit code to use as the termination status.</div>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.AbstractHandler.html" title="type parameter in CommandLine.AbstractHandler">T</a>&nbsp;andExit(int&nbsp;exitCode)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> instead, and call <code>System.exit()</code> in the application.</span></div>
<div class="block">Indicates that the handler should call <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#exit-int-" title="class or interface in java.lang"><code>System.exit(int)</code></a> after processing completes and sets the exit code to use as the termination status.</div>
</li>
</ul>
</li>

99
docs/apidocs/picocli/CommandLine.AbstractParseResultHandler.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.AbstractParseResultHandler (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.AbstractParseResultHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.AbstractParseResultHandler (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.AbstractParseResultHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":42,"i1":42,"i2":38,"i3":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;R&gt;&gt;</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;</dd>
<dd><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
@@ -124,10 +124,14 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="../picocli/CommandLine.html#getExecutionStrategy--"><code>CommandLine.getExecutionStrategy()</code></a>, <a href="../picocli/CommandLine.html#getParameterExceptionHandler--"><code>CommandLine.getParameterExceptionHandler()</code></a>, <a href="../picocli/CommandLine.html#getExecutionExceptionHandler--"><code>CommandLine.getExecutionExceptionHandler()</code></a></span></div>
</div>
<br>
<pre>public abstract static class <span class="typeNameLabel">CommandLine.AbstractParseResultHandler&lt;R&gt;</span>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public abstract static class <span class="typeNameLabel">CommandLine.AbstractParseResultHandler&lt;R&gt;</span>
extends <a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;R&gt;&gt;
implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;</pre>
implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;R&gt;, <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a></pre>
<div class="block">Command line parse result handler that returns a value. This handler prints help if requested, and otherwise calls
<a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-"><code>handle(CommandLine.ParseResult)</code></a> with the parse result. Facilitates implementation of the <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><code>CommandLine.IParseResultHandler2</code></a> interface.
<p>Note that <code>AbstractParseResultHandler</code> is a generic type. This, along with the abstract <code>self</code> method,
@@ -162,7 +166,9 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#AbstractParseResultHandler--">AbstractParseResultHandler</a></span>()</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#AbstractParseResultHandler--">AbstractParseResultHandler</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
@@ -174,20 +180,35 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected abstract <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="type parameter in CommandLine.AbstractParseResultHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">Processes the specified <code>ParseResult</code> and returns the result as a list of objects.</div>
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#execute-picocli.CommandLine.ParseResult-">execute</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">"Executes" the user input and returns an exit code.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="type parameter in CommandLine.AbstractParseResultHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes the specified <code>ParseResult</code> and returns the result as a list of objects.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="type parameter in CommandLine.AbstractParseResultHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Prints help if requested, and otherwise calls <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-"><code>handle(CommandLine.ParseResult)</code></a>.</div>
</td>
</tr>
@@ -197,14 +218,14 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -227,6 +248,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
<li class="blockList">
<h4>AbstractParseResultHandler</h4>
<pre>public&nbsp;AbstractParseResultHandler()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
@@ -245,6 +267,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
<h4>handleParseResult</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="type parameter in CommandLine.AbstractParseResultHandler">R</a>&nbsp;handleParseResult(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Prints help if requested, and otherwise calls <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-"><code>handle(CommandLine.ParseResult)</code></a>.
Finally, either a list of result objects is returned, or the JVM is terminated if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>.</div>
<dl>
@@ -253,7 +276,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the <code>ParseResult</code> that resulted from successfully parsing the command line arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of <code>processing parse results</code></dd>
<dd>the result of <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-"><code>processing parse results</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a></code> - if the <a href="../picocli/CommandLine.HelpCommand.html" title="class in picocli"><code>HelpCommand</code></a> was invoked for an unknown subcommand. Any <code>ParameterExceptions</code>
thrown from this method are treated as if this exception was thrown during parsing and passed to the <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a></dd>
@@ -262,14 +285,40 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
</dl>
</li>
</ul>
<a name="execute-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;int&nbsp;execute(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../picocli/CommandLine.IExecutionStrategy.html#execute-picocli.CommandLine.ParseResult-">CommandLine.IExecutionStrategy</a></code></span></div>
<div class="block">"Executes" the user input and returns an exit code.
Execution often means invoking a method on the selected CommandSpec's <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a>,
and making the return value of that invocation available via <a href="../picocli/CommandLine.html#setExecutionResult-java.lang.Object-"><code>setExecutionResult</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.IExecutionStrategy.html#execute-picocli.CommandLine.ParseResult-">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the parse result from which to select one or more <code>CommandSpec</code> instances to execute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an exit code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></code> - if any problem occurred while executing the command. Any exceptions (other than ParameterException) should be wrapped in a ExecutionException and not thrown as is.</dd>
</dl>
</li>
</ul>
<a name="handle-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre>protected abstract&nbsp;<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="type parameter in CommandLine.AbstractParseResultHandler">R</a>&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes the specified <code>ParseResult</code> and returns the result as a list of objects.
Implementations are responsible for catching any exceptions thrown in the <code>handle</code> method, and
rethrowing an <code>ExecutionException</code> that details the problem and captures the offending <code>CommandLine</code> object.</div>
@@ -284,6 +333,16 @@ implements <a href="../picocli/CommandLine.IParseResultHandler2.html" title="int
</dl>
</li>
</ul>
<a name="extractExitCodeGenerators-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extractExitCodeGenerators</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;&nbsp;extractExitCodeGenerators(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
</li>

24
docs/apidocs/picocli/CommandLine.ArgGroup.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.ArgGroup (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.ArgGroup (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ArgGroup (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ArgGroup (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,PARAMETER})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
public static @interface <span class="memberNameLabel">CommandLine.ArgGroup</span></pre>
<div class="block">A <code>Command</code> may define one or more <code>ArgGroups</code>: a group of options, positional parameters or a mixture of the two.
Groups can be used to:
@@ -165,19 +165,19 @@ public static @interface <span class="memberNameLabel">CommandLine.ArgGroup</spa
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ArgGroup.html#heading--">heading</a></span></code>
<div class="block">The heading of this group, used when generating the usage documentation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ArgGroup.html#headingKey--">headingKey</a></span></code>
<div class="block">ResourceBundle key for this group's usage help message section heading.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ArgGroup.html#multiplicity--">multiplicity</a></span></code>
<div class="block">Determines how often this group can be specified on the command line; <code>"0..1"</code> (optional) by default.</div>
</td>
@@ -215,7 +215,7 @@ public static @interface <span class="memberNameLabel">CommandLine.ArgGroup</spa
<ul class="blockList">
<li class="blockList">
<h4>heading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;heading</pre>
<pre>public abstract&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>&nbsp;heading</pre>
<div class="block">The heading of this group, used when generating the usage documentation.
When neither a <a href="../picocli/CommandLine.ArgGroup.html#heading--"><code>heading</code></a> nor a <a href="../picocli/CommandLine.ArgGroup.html#headingKey--"><code>headingKey</code></a> are specified,
this group is used for validation only and does not change the usage help message.</div>
@@ -234,7 +234,7 @@ public static @interface <span class="memberNameLabel">CommandLine.ArgGroup</spa
<ul class="blockList">
<li class="blockList">
<h4>headingKey</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;headingKey</pre>
<pre>public abstract&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>&nbsp;headingKey</pre>
<div class="block">ResourceBundle key for this group's usage help message section heading.
When neither a <a href="../picocli/CommandLine.ArgGroup.html#heading--"><code>heading</code></a> nor a <a href="../picocli/CommandLine.ArgGroup.html#headingKey--"><code>headingKey</code></a> are specified,
this group is used for validation only and does not change the usage help message.</div>
@@ -271,7 +271,7 @@ public static @interface <span class="memberNameLabel">CommandLine.ArgGroup</spa
<ul class="blockList">
<li class="blockList">
<h4>multiplicity</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;multiplicity</pre>
<pre>public abstract&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>&nbsp;multiplicity</pre>
<div class="block">Determines how often this group can be specified on the command line; <code>"0..1"</code> (optional) by default.
For a group of mutually exclusive arguments, making the group required <code>multiplicity = "1"</code> means that
one of the arguments in the group must appear on the command line, or a MissingParameterException is thrown.

379
docs/apidocs/picocli/CommandLine.Command.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Command (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Command (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Command (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Command (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,18 +92,23 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Inherited
@Target(value={TYPE,LOCAL_VARIABLE,FIELD,PACKAGE,METHOD})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#LOCAL_VARIABLE" title="class or interface in java.lang.annotation">LOCAL_VARIABLE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PACKAGE" title="class or interface in java.lang.annotation">PACKAGE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
public static @interface <span class="memberNameLabel">CommandLine.Command</span></pre>
<div class="block"><p>Annotate your class with <code>@Command</code> when you want more control over the format of the generated help
message. From 3.6, methods can also be annotated with <code>@Command</code>, where the method parameters define the
command options and positional parameters.
</p><pre>
&#064;Command(name = "Encrypt", mixinStandardHelpOptions = true,
description = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
version = "Encrypt version 1.0",
footer = "Copyright (c) 2017")
&#064;Command(name = "Encrypt", mixinStandardHelpOptions = true,
description = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
version = "Encrypt version 1.0",
footer = "Copyright (c) 2017",
exitCodeListHeading = "Exit Codes:%n",
exitCodeList = { " 0:Successful program execution.",
"64:Invalid input: an unknown option or invalid parameter was specified.",
"70:Execution exception: an exception occurred while executing the business logic."}
)
public class Encrypt {
&#064;Parameters(paramLabel = "FILE", description = "Any number of input files")
private List&lt;File&gt; files = new ArrayList&lt;File&gt;();
@@ -122,6 +127,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<li>[description]</li>
<li>[parameter list]: <code>[FILE...] Any number of input files</code></li>
<li>[option list]: <code>-h, --help prints this help message and exits</code></li>
<li>[exit code list]</li>
<li>[footer]</li>
</ul></div>
</li>
@@ -156,162 +162,205 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#aliases--">aliases</a></span></code>
<div class="block">Alternative command names by which this subcommand is recognized on the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#commandListHeading--">commandListHeading</a></span></code>
<div class="block">Set the heading preceding the subcommands list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#customSynopsis--">customSynopsis</a></span></code>
<div class="block">Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#defaultValueProvider--">defaultValueProvider</a></span></code>
<div class="block">Class that can provide default values dynamically at runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#description--">description</a></span></code>
<div class="block">Optional text to display between the synopsis line(s) and the list of options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#descriptionHeading--">descriptionHeading</a></span></code>
<div class="block">Set the heading preceding the description section.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeList--">exitCodeList</a></span></code>
<div class="block">Set the values to be displayed in the exit codes section as a list of <code>"key:value"</code> pairs:
keys are exit codes, values are descriptions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeListHeading--">exitCodeListHeading</a></span></code>
<div class="block">Set the heading preceding the exit codes section, may contain <code>"%n"</code> line separators.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeOnExecutionException--">exitCodeOnExecutionException</a></span></code>
<div class="block">Exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeOnInvalidInput--">exitCodeOnInvalidInput</a></span></code>
<div class="block">Exit code for command line usage error.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeOnSuccess--">exitCodeOnSuccess</a></span></code>
<div class="block">Exit code for successful termination.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeOnUsageHelp--">exitCodeOnUsageHelp</a></span></code>
<div class="block">Exit code for successful termination after printing usage help on user request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#exitCodeOnVersionHelp--">exitCodeOnVersionHelp</a></span></code>
<div class="block">Exit code for successful termination after printing version help on user request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#footer--">footer</a></span></code>
<div class="block">Optional text to display after the list of options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#footerHeading--">footerHeading</a></span></code>
<div class="block">Set the heading preceding the footer section.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#header--">header</a></span></code>
<div class="block">Optional summary description of the command, shown before the synopsis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#headerHeading--">headerHeading</a></span></code>
<div class="block">Set the heading preceding the header section.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#helpCommand--">helpCommand</a></span></code>
<div class="block">Set this attribute to <code>true</code> if this subcommand is a help command, and required options and positional
parameters of the parent command should not be validated.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#hidden--">hidden</a></span></code>
<div class="block">Set <code>hidden=true</code> if this command should not be included in the list of commands in the usage help of the parent command.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#mixinStandardHelpOptions--">mixinStandardHelpOptions</a></span></code>
<div class="block">Adds the standard <code>-h</code> and <code>--help</code> <a href="../picocli/CommandLine.Option.html#usageHelp--">usageHelp</a> options and <code>-V</code>
and <code>--version</code> <a href="../picocli/CommandLine.Option.html#versionHelp--">versionHelp</a> options to the options of this command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#name--">name</a></span></code>
<div class="block">Program name to show in the synopsis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#optionListHeading--">optionListHeading</a></span></code>
<div class="block">Set the heading preceding the options list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#parameterListHeading--">parameterListHeading</a></span></code>
<div class="block">Set the heading preceding the parameters list.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#requiredOptionMarker--">requiredOptionMarker</a></span></code>
<div class="block">Prefix required options with this character in the options list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#resourceBundle--">resourceBundle</a></span></code>
<div class="block">Set the base name of the ResourceBundle to find option and positional parameters descriptions, as well as
usage help message sections and section headings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#separator--">separator</a></span></code>
<div class="block">String that separates options from option parameters.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#showDefaultValues--">showDefaultValues</a></span></code>
<div class="block">Specify <code>true</code> to show default values in the description column of the options list (except for
boolean options).</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#sortOptions--">sortOptions</a></span></code>
<div class="block">Specify <code>false</code> to show Options in declaration order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#subcommands--">subcommands</a></span></code>
<div class="block">A list of classes to instantiate and register as subcommands.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#synopsisHeading--">synopsisHeading</a></span></code>
<div class="block">Set the heading preceding the synopsis text.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#usageHelpWidth--">usageHelpWidth</a></span></code>
<div class="block">Set the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width-int-"><code>usage help message width</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<tr class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#version--">version</a></span></code>
<div class="block">Version information for this command, to print to the console when the user specifies an
<a href="../picocli/CommandLine.Option.html#versionHelp--">option</a> to request version help.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>&gt;</code></td>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Command.html#versionProvider--">versionProvider</a></span></code>
<div class="block">Class that can provide version information dynamically at runtime.</div>
</td>
@@ -337,7 +386,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<pre>public abstract&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>&nbsp;name</pre>
<div class="block">Program name to show in the synopsis. If omitted, <code>"&lt;main class&gt;"</code> is used.
For <a href="../picocli/CommandLine.Command.html#subcommands--">declaratively added</a> subcommands, this attribute is also used
by the parser to recognize subcommands in the command line arguments.</div>
@@ -363,7 +412,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>aliases</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;aliases</pre>
<pre>public abstract&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>[]&nbsp;aliases</pre>
<div class="block">Alternative command names by which this subcommand is recognized on the command line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -386,7 +435,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>subcommands</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;subcommands</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;subcommands</pre>
<div class="block">A list of classes to instantiate and register as subcommands. When registering subcommands declaratively
like this, you don't need to call the <a href="../picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-"><code>CommandLine.addSubcommand(String, Object)</code></a> method. For example, this:
<pre>
@@ -483,7 +532,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;separator</pre>
<pre>public abstract&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>&nbsp;separator</pre>
<div class="block">String that separates options from option parameters. Default is <code>"="</code>. Spaces are also accepted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -506,10 +555,10 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;version</pre>
<pre>public abstract&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>[]&nbsp;version</pre>
<div class="block">Version information for this command, to print to the console when the user specifies an
<a href="../picocli/CommandLine.Option.html#versionHelp--">option</a> to request version help. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p>
<p>This is not part of the usage help message.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -534,7 +583,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>versionProvider</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>&gt;&nbsp;versionProvider</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>&gt;&nbsp;versionProvider</pre>
<div class="block">Class that can provide version information dynamically at runtime. An implementation may return version
information obtained from the JAR manifest, a properties file or some other source.</div>
<dl>
@@ -615,9 +664,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>headerHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;headerHeading</pre>
<pre>public abstract&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>&nbsp;headerHeading</pre>
<div class="block">Set the heading preceding the header section.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the header section</dd>
@@ -640,9 +689,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;header</pre>
<pre>public abstract&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>[]&nbsp;header</pre>
<div class="block">Optional summary description of the command, shown before the synopsis. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>summary description of the command</dd>
@@ -665,9 +714,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>synopsisHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;synopsisHeading</pre>
<pre>public abstract&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>&nbsp;synopsisHeading</pre>
<div class="block">Set the heading preceding the synopsis text. The default heading is <code>"Usage: "</code> (without a line break between the heading and the synopsis text).
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the synopsis text</dd>
@@ -714,9 +763,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>customSynopsis</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;customSynopsis</pre>
<pre>public abstract&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>[]&nbsp;customSynopsis</pre>
<div class="block">Specify one or more custom synopsis lines to display instead of an auto-generated synopsis. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>custom synopsis text to replace the auto-generated synopsis</dd>
@@ -738,9 +787,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>descriptionHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;descriptionHeading</pre>
<pre>public abstract&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>&nbsp;descriptionHeading</pre>
<div class="block">Set the heading preceding the description section.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the description section</dd>
@@ -762,9 +811,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;description</pre>
<pre>public abstract&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>[]&nbsp;description</pre>
<div class="block">Optional text to display between the synopsis line(s) and the list of options. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>description of this command</dd>
@@ -786,9 +835,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>parameterListHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;parameterListHeading</pre>
<pre>public abstract&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>&nbsp;parameterListHeading</pre>
<div class="block">Set the heading preceding the parameters list.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the parameters list</dd>
@@ -810,9 +859,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>optionListHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;optionListHeading</pre>
<pre>public abstract&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>&nbsp;optionListHeading</pre>
<div class="block">Set the heading preceding the options list.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the options list</dd>
@@ -877,7 +926,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>defaultValueProvider</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a>&gt;&nbsp;defaultValueProvider</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a>&gt;&nbsp;defaultValueProvider</pre>
<div class="block">Class that can provide default values dynamically at runtime. An implementation may return default
value obtained from a configuration file like a properties file or some other source.</div>
<dl>
@@ -925,9 +974,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>commandListHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;commandListHeading</pre>
<pre>public abstract&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>&nbsp;commandListHeading</pre>
<div class="block">Set the heading preceding the subcommands list. The default heading is <code>"Commands:%n"</code> (with a line break at the end).
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the subcommands list</dd>
@@ -949,9 +998,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>footerHeading</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;footerHeading</pre>
<pre>public abstract&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>&nbsp;footerHeading</pre>
<div class="block">Set the heading preceding the footer section.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the footer section</dd>
@@ -973,9 +1022,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>footer</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;footer</pre>
<pre>public abstract&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>[]&nbsp;footer</pre>
<div class="block">Optional text to display after the list of options. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>text to display after the list of options</dd>
@@ -1020,7 +1069,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<ul class="blockList">
<li class="blockList">
<h4>resourceBundle</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;resourceBundle</pre>
<pre>public abstract&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>&nbsp;resourceBundle</pre>
<div class="block">Set the base name of the ResourceBundle to find option and positional parameters descriptions, as well as
usage help message sections and section headings. <p>See <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli"><code>CommandLine.Model.Messages</code></a> for more details and an example.</p></div>
<dl>
@@ -1046,7 +1095,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
<li class="blockList"><a name="usageHelpWidth--">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>usageHelpWidth</h4>
<pre>public abstract&nbsp;int&nbsp;usageHelpWidth</pre>
@@ -1063,6 +1112,174 @@ public static @interface <span class="memberNameLabel">CommandLine.Command</span
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeOnSuccess--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeOnSuccess</h4>
<pre>public abstract&nbsp;int&nbsp;exitCodeOnSuccess</pre>
<div class="block">Exit code for successful termination. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeOnUsageHelp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeOnUsageHelp</h4>
<pre>public abstract&nbsp;int&nbsp;exitCodeOnUsageHelp</pre>
<div class="block">Exit code for successful termination after printing usage help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeOnVersionHelp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeOnVersionHelp</h4>
<pre>public abstract&nbsp;int&nbsp;exitCodeOnVersionHelp</pre>
<div class="block">Exit code for successful termination after printing version help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeOnInvalidInput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeOnInvalidInput</h4>
<pre>public abstract&nbsp;int&nbsp;exitCodeOnInvalidInput</pre>
<div class="block">Exit code for command line usage error. <a href="../picocli/CommandLine.ExitCode.html#USAGE">64</a> by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>64</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeOnExecutionException--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeOnExecutionException</h4>
<pre>public abstract&nbsp;int&nbsp;exitCodeOnExecutionException</pre>
<div class="block">Exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
<a href="../picocli/CommandLine.ExitCode.html#SOFTWARE">70</a> by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>70</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeListHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeListHeading</h4>
<pre>public abstract&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>&nbsp;exitCodeListHeading</pre>
<div class="block">Set the heading preceding the exit codes section, may contain <code>"%n"</code> line separators. <code>""</code> (empty string) by default.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.Help.html#exitCodeListHeading-java.lang.Object...-"><code>CommandLine.Help.exitCodeListHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="exitCodeList--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>exitCodeList</h4>
<pre>public abstract&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>[]&nbsp;exitCodeList</pre>
<div class="block">Set the values to be displayed in the exit codes section as a list of <code>"key:value"</code> pairs:
keys are exit codes, values are descriptions. Descriptions may contain <code>"%n"</code> line separators.
<p>For example:</p>
<pre>
&#064;Command(exitCodeListHeading = "Exit Codes:%n",
exitCodeList = { " 0:Successful program execution.",
"64:Invalid input: an unknown option or invalid parameter was specified.",
"70:Execution exception: an exception occurred while executing the business logic."})
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>

59
docs/apidocs/picocli/CommandLine.DefaultExceptionHandler.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.DefaultExceptionHandler (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.DefaultExceptionHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.DefaultExceptionHandler (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.DefaultExceptionHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":42,"i1":42,"i2":42,"i3":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">CommandLine.DefaultExceptionHandler</a>&lt;R&gt;&gt;</li>
@@ -120,8 +120,12 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="../picocli/CommandLine.html#getParameterExceptionHandler--"><code>CommandLine.getParameterExceptionHandler()</code></a> and <a href="../picocli/CommandLine.html#getExecutionExceptionHandler--"><code>CommandLine.getExecutionExceptionHandler()</code></a></span></div>
</div>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.DefaultExceptionHandler&lt;R&gt;</span>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static class <span class="typeNameLabel">CommandLine.DefaultExceptionHandler&lt;R&gt;</span>
extends <a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">CommandLine.DefaultExceptionHandler</a>&lt;R&gt;&gt;
implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interface in picocli">CommandLine.IExceptionHandler</a>, <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli">CommandLine.IExceptionHandler2</a>&lt;R&gt;</pre>
<div class="block">Default exception handler that handles invalid user input by printing the exception message, followed by the usage
@@ -155,7 +159,9 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#DefaultExceptionHandler--">DefaultExceptionHandler</a></span>()</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#DefaultExceptionHandler--">DefaultExceptionHandler</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
@@ -167,17 +173,18 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#handleException-picocli.CommandLine.ParameterException-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">handleException</a></span>(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.io.PrintStream&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.lang.String...&nbsp;args)</code>
<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>...&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>
</td>
@@ -186,13 +193,15 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<td class="colFirst"><code><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#handleExecutionException-picocli.CommandLine.ExecutionException-picocli.CommandLine.ParseResult-">handleExecutionException</a></span>(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This implementation always simply rethrows the specified exception.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#handleParseException-picocli.CommandLine.ParameterException-java.lang.String:A-">handleParseException</a></span>(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.lang.String[]&nbsp;args)</code>
<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>[]&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Prints the message of the specified exception, followed by the usage message for the command or subcommand
whose input was invalid, to the stream returned by <a href="../picocli/CommandLine.AbstractHandler.html#err--"><code>CommandLine.AbstractHandler.err()</code></a>.</div>
</td>
@@ -200,6 +209,7 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">CommandLine.DefaultExceptionHandler</a>&lt;<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DefaultExceptionHandler.html#self--">self</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
</td>
</tr>
@@ -209,14 +219,14 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -239,6 +249,7 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<li class="blockList">
<h4>DefaultExceptionHandler</h4>
<pre>public&nbsp;DefaultExceptionHandler()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
@@ -255,10 +266,11 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<ul class="blockList">
<li class="blockList">
<h4>handleException</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handleException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.lang.String...&nbsp;args)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
<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>...&nbsp;args)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../picocli/CommandLine.IExceptionHandler.html#handleException-picocli.CommandLine.ParameterException-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">CommandLine.IExceptionHandler</a></code></span></div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>
@@ -283,7 +295,8 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<li class="blockList">
<h4>handleParseException</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a>&nbsp;handleParseException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.lang.String[]&nbsp;args)</pre>
<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>[]&nbsp;args)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Prints the message of the specified exception, followed by the usage message for the command or subcommand
whose input was invalid, to the stream returned by <a href="../picocli/CommandLine.AbstractHandler.html#err--"><code>CommandLine.AbstractHandler.err()</code></a>.</div>
<dl>
@@ -308,6 +321,7 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<h4>handleExecutionException</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a>&nbsp;handleExecutionException(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This implementation always simply rethrows the specified exception.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -331,6 +345,7 @@ implements <a href="../picocli/CommandLine.IExceptionHandler.html" title="interf
<li class="blockList">
<h4>self</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">CommandLine.DefaultExceptionHandler</a>&lt;<a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="type parameter in CommandLine.DefaultExceptionHandler">R</a>&gt;&nbsp;self()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html#self--">CommandLine.AbstractHandler</a></code></span></div>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
<dl>

30
docs/apidocs/picocli/CommandLine.DuplicateNameException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.DuplicateNameException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.DuplicateNameException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.DuplicateNameException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.DuplicateNameException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -127,7 +127,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
@@ -166,7 +166,7 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DuplicateNameException.html#DuplicateNameException-java.lang.String-">DuplicateNameException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DuplicateNameException.html#DuplicateNameException-java.lang.String-">DuplicateNameException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -181,15 +181,15 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -211,7 +211,7 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<ul class="blockListLast">
<li class="blockList">
<h4>DuplicateNameException</h4>
<pre>public&nbsp;DuplicateNameException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;DuplicateNameException(<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

30
docs/apidocs/picocli/CommandLine.DuplicateOptionAnnotationsException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.DuplicateOptionAnnotationsException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.DuplicateOptionAnnotationsException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.DuplicateOptionAnnotationsException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.DuplicateOptionAnnotationsException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -132,7 +132,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -165,7 +165,7 @@ extends <a href="../picocli/CommandLine.DuplicateNameException.html" title="clas
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html#DuplicateOptionAnnotationsException-java.lang.String-">DuplicateOptionAnnotationsException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html#DuplicateOptionAnnotationsException-java.lang.String-">DuplicateOptionAnnotationsException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -180,15 +180,15 @@ extends <a href="../picocli/CommandLine.DuplicateNameException.html" title="clas
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -210,7 +210,7 @@ extends <a href="../picocli/CommandLine.DuplicateNameException.html" title="clas
<ul class="blockListLast">
<li class="blockList">
<h4>DuplicateOptionAnnotationsException</h4>
<pre>public&nbsp;DuplicateOptionAnnotationsException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;DuplicateOptionAnnotationsException(<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

46
docs/apidocs/picocli/CommandLine.ExecutionException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.ExecutionException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.ExecutionException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ExecutionException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ExecutionException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.ExitCode.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.ExecutionException.html" target="_top">Frames</a></li>
@@ -96,16 +96,16 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -128,7 +128,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -138,7 +138,9 @@ var activeTableTab = "activeTableTab";
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.ExecutionException</span>
extends <a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">CommandLine.PicocliException</a></pre>
<div class="block">Exception indicating a problem while invoking a command or subcommand.</div>
<div class="block">Exception indicating a problem while invoking a command or subcommand.
Keeps a reference to the <code>CommandLine</code> object where the cause exception occurred,
so that client code can tailor their handling for the specific command (print the command's usage help message, for example).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
@@ -164,12 +166,12 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ExecutionException.html#ExecutionException-picocli.CommandLine-java.lang.String-">ExecutionException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ExecutionException.html#ExecutionException-picocli.CommandLine-java.lang.String-java.lang.Throwable-">ExecutionException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</code>&nbsp;</td>
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -197,15 +199,15 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -228,7 +230,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ExecutionException</h4>
<pre>public&nbsp;ExecutionException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
<a name="ExecutionException-picocli.CommandLine-java.lang.String-java.lang.Throwable-">
@@ -238,8 +240,8 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ExecutionException</h4>
<pre>public&nbsp;ExecutionException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</pre>
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
</li>
</ul>
</li>
@@ -292,7 +294,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.ExitCode.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.ExecutionException.html" target="_top">Frames</a></li>

301
docs/apidocs/picocli/CommandLine.ExitCode.html Normal file
View File

@@ -0,0 +1,301 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.ExitCode (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.ExitCode (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.ExitCode.html" target="_top">Frames</a></li>
<li><a href="CommandLine.ExitCode.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Class CommandLine.ExitCode" class="title">Class CommandLine.ExitCode</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.ExitCode</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">CommandLine.ExitCode</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Defines some exit codes used by picocli as default return values from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a>
and <a href="../picocli/CommandLine.html#executeHelpRequest-picocli.CommandLine.ParseResult-"><code>executeHelpRequest</code></a> methods.
<p>Commands can override these defaults with annotations (e.g. <code>@Command(exitCodeOnInvalidInput = 12345)</code>
or programmatically (e.g. <a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnInvalidInput-int-"><code>CommandLine.Model.CommandSpec.exitCodeOnInvalidInput(int)</code></a>).</p>
<p>Additionally, there are several mechanisms for commands to return custom exit codes.
See the javadoc of the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method for details.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ExitCode.html#OK">OK</a></span></code>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> and
<a href="../picocli/CommandLine.html#executeHelpRequest-picocli.CommandLine.ParseResult-"><code>executeHelpRequest</code></a> methods signifying successful termination.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ExitCode.html#SOFTWARE">SOFTWARE</a></span></code>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method signifying internal software error: an exception occurred when invoking the Runnable, Callable or Method user object of a command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ExitCode.html#USAGE">USAGE</a></span></code>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method signifying command line usage error: user input for the command was incorrect, e.g., the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="OK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OK</h4>
<pre>public static final&nbsp;int OK</pre>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> and
<a href="../picocli/CommandLine.html#executeHelpRequest-picocli.CommandLine.ParseResult-"><code>executeHelpRequest</code></a> methods signifying successful termination.
<p>The value of this constant is 0, following unix C/C++ system programming <a href="https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3">conventions</a>.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#picocli.CommandLine.ExitCode.OK">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USAGE</h4>
<pre>public static final&nbsp;int USAGE</pre>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method signifying command line usage error: user input for the command was incorrect, e.g., the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever. <p>The value of this constant is 64, following unix C/C++ system programming <a href="https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3">conventions</a>.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#picocli.CommandLine.ExitCode.USAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SOFTWARE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SOFTWARE</h4>
<pre>public static final&nbsp;int SOFTWARE</pre>
<div class="block">Return value from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method signifying internal software error: an exception occurred when invoking the Runnable, Callable or Method user object of a command. <p>The value of this constant is 70, following unix C/C++ system programming <a href="https://www.freebsd.org/cgi/man.cgi?query=sysexits&sektion=3">conventions</a>.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#picocli.CommandLine.ExitCode.SOFTWARE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.ExitCode.html" target="_top">Frames</a></li>
<li><a href="CommandLine.ExitCode.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

20
docs/apidocs/picocli/CommandLine.Help.Ansi.IStyle.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Ansi.IStyle (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help.Ansi.IStyle (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Ansi.IStyle (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Ansi.IStyle (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -129,7 +129,7 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colFirst"><code>static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.IStyle.html#CSI">CSI</a></span></code>
<div class="block">The Control Sequence Introducer (CSI) escape sequence "\u001b[".</div>
</td>
@@ -150,13 +150,13 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.IStyle.html#off--">off</a></span>()</code>
<div class="block">Returns the ANSI escape code for turning this style off.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.IStyle.html#on--">on</a></span>()</code>
<div class="block">Returns the ANSI escape code for turning this style on.</div>
</td>
@@ -182,7 +182,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>CSI</h4>
<pre>static final&nbsp;java.lang.String CSI</pre>
<pre>static 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> CSI</pre>
<div class="block">The Control Sequence Introducer (CSI) escape sequence "\u001b[".</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -204,7 +204,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>on</h4>
<pre>java.lang.String&nbsp;on()</pre>
<pre><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>&nbsp;on()</pre>
<div class="block">Returns the ANSI escape code for turning this style on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -218,7 +218,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>off</h4>
<pre>java.lang.String&nbsp;off()</pre>
<pre><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>&nbsp;off()</pre>
<div class="block">Returns the ANSI escape code for turning this style off.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>

60
docs/apidocs/picocli/CommandLine.Help.Ansi.Style.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Ansi.Style (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help.Ansi.Style (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Ansi.Style (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Ansi.Style (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,10 +96,10 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Ansi.Style</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;, <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;, <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">CommandLine.Help.Ansi.Style</span>
extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&gt;
implements <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></pre>
<div class="block">A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing
text with embedded markup style names, as well as convenience methods for converting
@@ -245,50 +245,50 @@ implements <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interfa
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#bg-java.lang.String-">bg</a></span>(java.lang.String&nbsp;str)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#bg-java.lang.String-">bg</a></span>(<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>&nbsp;str)</code>
<div class="block">Parses the specified style markup and returns the associated style.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#fg-java.lang.String-">fg</a></span>(java.lang.String&nbsp;str)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#fg-java.lang.String-">fg</a></span>(<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>&nbsp;str)</code>
<div class="block">Parses the specified style markup and returns the associated style.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#off--">off</a></span>()</code>
<div class="block">Returns the ANSI escape code for turning this style off.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colFirst"><code>static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#off-picocli.CommandLine.Help.Ansi.IStyle...-">off</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Returns the concatenated ANSI escape codes for turning all specified styles off.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#on--">on</a></span>()</code>
<div class="block">Returns the ANSI escape code for turning this style on.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colFirst"><code>static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#on-picocli.CommandLine.Help.Ansi.IStyle...-">on</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Returns the concatenated ANSI escape codes for turning all specified styles on.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#parse-java.lang.String-">parse</a></span>(java.lang.String&nbsp;commaSeparatedCodes)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#parse-java.lang.String-">parse</a></span>(<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>&nbsp;commaSeparatedCodes)</code>
<div class="block">Parses the specified comma-separated sequence of style descriptors and returns the associated
styles.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Style.html#valueOf-java.lang.String-">valueOf</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
@@ -304,15 +304,15 @@ the order they are declared.</div>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -569,7 +569,7 @@ for (CommandLine.Help.Ansi.Style c : CommandLine.Help.Ansi.Style.values())
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a>&nbsp;valueOf(<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>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
@@ -580,8 +580,8 @@ not permitted.)</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
@@ -591,7 +591,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>on</h4>
<pre>public&nbsp;java.lang.String&nbsp;on()</pre>
<pre>public&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>&nbsp;on()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../picocli/CommandLine.Help.Ansi.IStyle.html#on--">CommandLine.Help.Ansi.IStyle</a></code></span></div>
<div class="block">Returns the ANSI escape code for turning this style on.</div>
<dl>
@@ -608,7 +608,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>off</h4>
<pre>public&nbsp;java.lang.String&nbsp;off()</pre>
<pre>public&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>&nbsp;off()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../picocli/CommandLine.Help.Ansi.IStyle.html#off--">CommandLine.Help.Ansi.IStyle</a></code></span></div>
<div class="block">Returns the ANSI escape code for turning this style off.</div>
<dl>
@@ -625,7 +625,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>on</h4>
<pre>public static&nbsp;java.lang.String&nbsp;on(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<pre>public static&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>&nbsp;on(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Returns the concatenated ANSI escape codes for turning all specified styles on.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -641,7 +641,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>off</h4>
<pre>public static&nbsp;java.lang.String&nbsp;off(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<pre>public static&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>&nbsp;off(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Returns the concatenated ANSI escape codes for turning all specified styles off.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -657,7 +657,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>fg</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&nbsp;fg(java.lang.String&nbsp;str)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&nbsp;fg(<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>&nbsp;str)</pre>
<div class="block">Parses the specified style markup and returns the associated style.
The markup may be one of the Style enum value names, or it may be one of the Style enum value
names when <code>"fg_"</code> is prepended, or it may be one of the indexed colors in the 256 color palette.</div>
@@ -676,7 +676,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>bg</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&nbsp;bg(java.lang.String&nbsp;str)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&nbsp;bg(<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>&nbsp;str)</pre>
<div class="block">Parses the specified style markup and returns the associated style.
The markup may be one of the Style enum value names, or it may be one of the Style enum value
names when <code>"bg_"</code> is prepended, or it may be one of the indexed colors in the 256 color palette.</div>
@@ -695,7 +695,7 @@ not permitted.)</div>
<ul class="blockListLast">
<li class="blockList">
<h4>parse</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>[]&nbsp;parse(java.lang.String&nbsp;commaSeparatedCodes)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>[]&nbsp;parse(<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>&nbsp;commaSeparatedCodes)</pre>
<div class="block">Parses the specified comma-separated sequence of style descriptors and returns the associated
styles. For each markup, strings starting with <code>"bg("</code> are delegated to
<a href="../picocli/CommandLine.Help.Ansi.Style.html#bg-java.lang.String-"><code>bg(String)</code></a>, others are delegated to <a href="../picocli/CommandLine.Help.Ansi.Style.html#bg-java.lang.String-"><code>bg(String)</code></a>.</div>

60
docs/apidocs/picocli/CommandLine.Help.Ansi.Text.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Ansi.Text (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help.Ansi.Text (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Ansi.Text (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Ansi.Text (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Ansi.Text</li>
@@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -117,8 +117,8 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public class <span class="typeNameLabel">CommandLine.Help.Ansi.Text</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
<div class="block">Encapsulates rich text with styles and colors. Text objects may be constructed with Strings containing
markup like <code>@|bg(red),white,underline some text|@</code>, and this class converts the markup to ANSI
escape codes.
@@ -153,7 +153,7 @@ implements java.lang.Cloneable</pre>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#Text-java.lang.String-">Text</a></span>(java.lang.String&nbsp;input)</code>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#Text-java.lang.String-">Text</a></span>(<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>&nbsp;input)</code>
<div class="block">Constructs a Text with the specified String, which may contain markup like
<code>@|bg(red),white,underline some text|@</code>.</div>
</td>
@@ -183,14 +183,14 @@ implements java.lang.Cloneable</pre>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#append-java.lang.String-">append</a></span>(java.lang.String&nbsp;string)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#append-java.lang.String-">append</a></span>(<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>&nbsp;string)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Help.Ansi.Text.html#concat-java.lang.String-"><code>concat(String)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
@@ -201,13 +201,13 @@ implements java.lang.Cloneable</pre>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#concat-java.lang.String-">concat</a></span>(java.lang.String&nbsp;string)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#concat-java.lang.String-">concat</a></span>(<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>&nbsp;string)</code>
<div class="block">Returns a copy of this <code>Text</code> instance with the specified text concatenated to the end.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
@@ -223,7 +223,7 @@ implements java.lang.Cloneable</pre>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#plainString--">plainString</a></span>()</code>
<div class="block">Returns the plain text without any formatting.</div>
</td>
@@ -246,7 +246,7 @@ implements java.lang.Cloneable</pre>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.Text.html#toString--">toString</a></span>()</code>
<div class="block">Returns a String representation of the text with ANSI escape codes embedded, unless ANSI is
<a href="../picocli/CommandLine.Help.Ansi.html#enabled--">CommandLine.Help.Ansi.enabled()</a> not enabled}, in which case the plain text is returned.</div>
@@ -257,8 +257,8 @@ implements java.lang.Cloneable</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -308,7 +308,7 @@ implements java.lang.Cloneable</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>Text</h4>
<pre>public&nbsp;Text(java.lang.String&nbsp;input)</pre>
<pre>public&nbsp;Text(<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>&nbsp;input)</pre>
<div class="block">Constructs a Text with the specified String, which may contain markup like
<code>@|bg(red),white,underline some text|@</code>.</div>
<dl>
@@ -331,10 +331,10 @@ implements java.lang.Cloneable</pre>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;java.lang.Object&nbsp;clone()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -387,8 +387,8 @@ implements java.lang.Cloneable</pre>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>@Deprecated
public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;append(java.lang.String&nbsp;string)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;append(<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>&nbsp;string)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Help.Ansi.Text.html#concat-java.lang.String-"><code>concat(String)</code></a> instead</span></div>
</li>
</ul>
@@ -398,7 +398,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;append(<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;text)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <code>#concat(Text)</code> instead</span></div>
</li>
@@ -409,7 +409,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>concat</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;concat(java.lang.String&nbsp;string)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;concat(<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>&nbsp;string)</pre>
<div class="block">Returns a copy of this <code>Text</code> instance with the specified text concatenated to the end. Does not modify this instance!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -465,7 +465,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>plainString</h4>
<pre>public&nbsp;java.lang.String&nbsp;plainString()</pre>
<pre>public&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>&nbsp;plainString()</pre>
<div class="block">Returns the plain text without any formatting.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -479,10 +479,10 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -495,7 +495,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -505,12 +505,12 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<div class="block">Returns a String representation of the text with ANSI escape codes embedded, unless ANSI is
<a href="../picocli/CommandLine.Help.Ansi.html#enabled--">CommandLine.Help.Ansi.enabled()</a> not enabled}, in which case the plain text is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String representation of the text with ANSI escape codes embedded (if enabled)</dd>
</dl>

50
docs/apidocs/picocli/CommandLine.Help.Ansi.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Ansi (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help.Ansi (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Ansi (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Ansi (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,10 +96,10 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Ansi</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">CommandLine.Help.Ansi</span>
extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&gt;</pre>
<div class="block">Provides methods and inner classes to support using ANSI escape codes in usage help messages.</div>
</li>
</ul>
@@ -209,8 +209,8 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title=
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#apply-java.lang.String-java.util.List-">apply</a></span>(java.lang.String&nbsp;plainText,
java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#apply-java.lang.String-java.util.List-">apply</a></span>(<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>&nbsp;plainText,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</code>
<div class="block">Returns a new Text object where all the specified styles are applied to the full length of the
specified plain text.</div>
</td>
@@ -222,8 +222,8 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title=
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#string-java.lang.String-">string</a></span>(java.lang.String&nbsp;stringWithMarkup)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#string-java.lang.String-">string</a></span>(<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>&nbsp;stringWithMarkup)</code>
<div class="block">Returns a String where any markup like
<code>@|bg(red),white,underline some text|@</code> is converted to ANSI escape codes
if this Ansi is ON, or suppressed if this Ansi is OFF.</div>
@@ -231,7 +231,7 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title=
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#text-java.lang.String-">text</a></span>(java.lang.String&nbsp;stringWithMarkup)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#text-java.lang.String-">text</a></span>(<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>&nbsp;stringWithMarkup)</code>
<div class="block">Returns a new Text object for this Ansi mode, encapsulating the specified string
which may contain markup like <code>@|bg(red),white,underline some text|@</code>.</div>
</td>
@@ -244,7 +244,7 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Ansi.html" title=
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Ansi.html#valueOf-java.lang.String-">valueOf</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
@@ -260,15 +260,15 @@ the order they are declared.</div>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -349,7 +349,7 @@ for (CommandLine.Help.Ansi c : CommandLine.Help.Ansi.values())
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;valueOf(<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>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
@@ -360,8 +360,8 @@ not permitted.)</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
@@ -386,7 +386,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;text(java.lang.String&nbsp;stringWithMarkup)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;text(<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>&nbsp;stringWithMarkup)</pre>
<div class="block">Returns a new Text object for this Ansi mode, encapsulating the specified string
which may contain markup like <code>@|bg(red),white,underline some text|@</code>.
<p>
@@ -406,7 +406,7 @@ not permitted.)</div>
<ul class="blockList">
<li class="blockList">
<h4>string</h4>
<pre>public&nbsp;java.lang.String&nbsp;string(java.lang.String&nbsp;stringWithMarkup)</pre>
<pre>public&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>&nbsp;string(<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>&nbsp;stringWithMarkup)</pre>
<div class="block">Returns a String where any markup like
<code>@|bg(red),white,underline some text|@</code> is converted to ANSI escape codes
if this Ansi is ON, or suppressed if this Ansi is OFF.
@@ -438,8 +438,8 @@ not permitted.)</div>
<ul class="blockListLast">
<li class="blockList">
<h4>apply</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;apply(java.lang.String&nbsp;plainText,
java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;apply(<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>&nbsp;plainText,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</pre>
<div class="block">Returns a new Text object where all the specified styles are applied to the full length of the
specified plain text.</div>
<dl>

524
docs/apidocs/picocli/CommandLine.Help.ColorScheme.Builder.html Normal file
View File

@@ -0,0 +1,524 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.ColorScheme.Builder (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.Help.ColorScheme.Builder (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.ColorScheme.Builder.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Help.ColorScheme.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Class CommandLine.Help.ColorScheme.Builder" class="title">Class CommandLine.Help.ColorScheme.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.ColorScheme.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.ColorScheme.Builder</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builder class to create <code>ColorScheme</code> instances.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#Builder--">Builder</a></span>()</code>
<div class="block">Constructs an empty color scheme builder with Ansi.AUTO.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#Builder-picocli.CommandLine.Help.Ansi-">Builder</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Constructs an empty color scheme builder with the specified Ansi value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#Builder-picocli.CommandLine.Help.ColorScheme-">Builder</a></span>(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;existing)</code>
<div class="block">Constructs a color scheme builder with all attributes copied from the specified color scheme.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#ansi--">ansi</a></span>()</code>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#ansi-picocli.CommandLine.Help.Ansi-">ansi</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme builder.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#applySystemProperties--">applySystemProperties</a></span>()</code>
<div class="block">Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#build--">build</a></span>()</code>
<div class="block">Creates and returns a new <code>ColorScheme</code> with the values configured on this builder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#commands-picocli.CommandLine.Help.Ansi.IStyle...-">commands</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#commandStyles--">commandStyles</a></span>()</code>
<div class="block">Returns the registered styles for commands in this color scheme builder.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#optionParams-picocli.CommandLine.Help.Ansi.IStyle...-">optionParams</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#optionParamStyles--">optionParamStyles</a></span>()</code>
<div class="block">Returns the registered styles for option parameters in this color scheme builder.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#options-picocli.CommandLine.Help.Ansi.IStyle...-">options</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#optionStyles--">optionStyles</a></span>()</code>
<div class="block">Returns the registered styles for options in this color scheme builder.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#parameters-picocli.CommandLine.Help.Ansi.IStyle...-">parameters</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html#parameterStyles--">parameterStyles</a></span>()</code>
<div class="block">Returns the registered styles for positional parameters in this color scheme builder.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Builder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Builder</h4>
<pre>public&nbsp;Builder()</pre>
<div class="block">Constructs an empty color scheme builder with Ansi.AUTO.</div>
</li>
</ul>
<a name="Builder-picocli.CommandLine.Help.Ansi-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Builder</h4>
<pre>public&nbsp;Builder(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Constructs an empty color scheme builder with the specified Ansi value.</div>
</li>
</ul>
<a name="Builder-picocli.CommandLine.Help.ColorScheme-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Builder</h4>
<pre>public&nbsp;Builder(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;existing)</pre>
<div class="block">Constructs a color scheme builder with all attributes copied from the specified color scheme.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="ansi--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ansi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi()</pre>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme builder.</div>
</li>
</ul>
<a name="ansi-picocli.CommandLine.Help.Ansi-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ansi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;ansi(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme builder.</div>
</li>
</ul>
<a name="commandStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;commandStyles()</pre>
<div class="block">Returns the registered styles for commands in this color scheme builder.</div>
</li>
</ul>
<a name="optionStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;optionStyles()</pre>
<div class="block">Returns the registered styles for options in this color scheme builder.</div>
</li>
</ul>
<a name="parameterStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;parameterStyles()</pre>
<div class="block">Returns the registered styles for positional parameters in this color scheme builder.</div>
</li>
</ul>
<a name="optionParamStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionParamStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;optionParamStyles()</pre>
<div class="block">Returns the registered styles for option parameters in this color scheme builder.</div>
</li>
</ul>
<a name="commands-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commands</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;commands(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to the registered styles for commands in this color scheme builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme builder to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="options-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;options(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to registered the styles for options in this color scheme builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme builder to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="parameters-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;parameters(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to registered the styles for parameters in this color scheme builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme builder to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="optionParams-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionParams</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;optionParams(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to the registered styles for option parameters in this color scheme builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme builder to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="applySystemProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applySystemProperties</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a>&nbsp;applySystemProperties()</pre>
<div class="block">Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.
Supported property names:<ul>
<li><code>picocli.color.commands</code></li>
<li><code>picocli.color.options</code></li>
<li><code>picocli.color.parameters</code></li>
<li><code>picocli.color.optionParams</code></li>
</ul><p>Property values can be anything that <a href="../picocli/CommandLine.Help.Ansi.Style.html#parse-java.lang.String-"><code>CommandLine.Help.Ansi.Style.parse(String)</code></a> can handle.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ColorScheme builder</dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;build()</pre>
<div class="block">Creates and returns a new <code>ColorScheme</code> with the values configured on this builder.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.ColorScheme.Builder.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Help.ColorScheme.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

403
docs/apidocs/picocli/CommandLine.Help.ColorScheme.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.ColorScheme (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help.ColorScheme (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.ColorScheme (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.ColorScheme (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.ColorScheme.html" target="_top">Frames</a></li>
@@ -73,15 +73,15 @@ var activeTableTab = "activeTableTab";
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.ColorScheme</li>
@@ -113,15 +113,17 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.ColorScheme</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">All usage help message are generated with a color scheme that assigns certain styles and colors to common
parts of a usage message: the command name, options, positional parameters and option parameters.
Users may customize these styles by creating Help with a custom color scheme.
<p>Note that these options and styles may not be rendered if ANSI escape codes are not
<a href="../picocli/CommandLine.Help.Ansi.html#enabled--">enabled</a>.</p></div>
<a href="../picocli/CommandLine.Help.Ansi.html#enabled--">enabled</a>.</p>
<p>From 4.0, instances of this class are immutable.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.Help.html#defaultColorScheme-picocli.CommandLine.Help.Ansi-"><code>CommandLine.Help.defaultColorScheme(Ansi)</code></a></dd>
<dd><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><code>CommandLine.Help.ColorScheme.Builder</code></a>,
<a href="../picocli/CommandLine.Help.html#defaultColorScheme-picocli.CommandLine.Help.Ansi-"><code>CommandLine.Help.defaultColorScheme(Ansi)</code></a></dd>
</dl>
</li>
</ul>
@@ -129,56 +131,22 @@ extends java.lang.Object</pre>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#commandStyles">commandStyles</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionParamStyles">optionParamStyles</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionStyles">optionStyles</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#parameterStyles">parameterStyles</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#ColorScheme--">ColorScheme</a></span>()</code>
<div class="block">Constructs a new empty ColorScheme with <a href="../picocli/CommandLine.Help.Ansi.html#AUTO"><code>CommandLine.Help.Ansi.AUTO</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#ColorScheme-picocli.CommandLine.Help.Ansi-">ColorScheme</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Constructs a new empty ColorScheme with the specified Ansi enabled mode.</div>
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli">CommandLine.Help.ColorScheme.Builder</a></span></code>
<div class="block">Builder class to create <code>ColorScheme</code> instances.</div>
</td>
</tr>
</table>
@@ -198,59 +166,63 @@ extends java.lang.Object</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#ansi--">ansi</a></span>()</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#ansi--">ansi</a></span>()</code>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#applySystemProperties--">applySystemProperties</a></span>()</code>
<div class="block">Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme.</div>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#commandStyles--">commandStyles</a></span>()</code>
<div class="block">Returns the registered styles for commands in this color scheme.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#commands-picocli.CommandLine.Help.Ansi.IStyle...-">commands</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#commandText-java.lang.String-">commandText</a></span>(java.lang.String&nbsp;command)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#commandText-java.lang.String-">commandText</a></span>(<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>&nbsp;command)</code>
<div class="block">Returns a Text with all command styles applied to the specified command string.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionParams-picocli.CommandLine.Help.Ansi.IStyle...-">optionParams</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.</div>
</td>
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionParamText-java.lang.String-">optionParamText</a></span>(java.lang.String&nbsp;optionParam)</code>
<div class="block">Returns a Text with all optionParam styles applied to the specified optionParam string.</div>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionParamStyles--">optionParamStyles</a></span>()</code>
<div class="block">Returns the registered styles for option parameters in this color scheme.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#options-picocli.CommandLine.Help.Ansi.IStyle...-">options</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.</div>
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionParamText-java.lang.String-">optionParamText</a></span>(<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>&nbsp;optionParam)</code>
<div class="block">Returns a Text with all optionParam styles applied to the specified optionParam string.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionText-java.lang.String-">optionText</a></span>(java.lang.String&nbsp;option)</code>
<div class="block">Returns a Text with all option styles applied to the specified option string.</div>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionStyles--">optionStyles</a></span>()</code>
<div class="block">Returns the registered styles for options in this color scheme.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#parameters-picocli.CommandLine.Help.Ansi.IStyle...-">parameters</a></span>(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</code>
<div class="block">Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.</div>
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#optionText-java.lang.String-">optionText</a></span>(<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>&nbsp;option)</code>
<div class="block">Returns a Text with all option styles applied to the specified option string.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#parameterStyles--">parameterStyles</a></span>()</code>
<div class="block">Returns the registered styles for positional parameters in this color scheme.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#parameterText-java.lang.String-">parameterText</a></span>(java.lang.String&nbsp;parameter)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.ColorScheme.html#parameterText-java.lang.String-">parameterText</a></span>(<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>&nbsp;parameter)</code>
<div class="block">Returns a Text with all parameter styles applied to the specified parameter string.</div>
</td>
</tr>
@@ -259,8 +231,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -270,161 +242,19 @@ extends java.lang.Object</pre>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="commandStyles">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandStyles</h4>
<pre>public final&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt; commandStyles</pre>
</li>
</ul>
<a name="optionStyles">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionStyles</h4>
<pre>public final&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt; optionStyles</pre>
</li>
</ul>
<a name="parameterStyles">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterStyles</h4>
<pre>public final&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt; parameterStyles</pre>
</li>
</ul>
<a name="optionParamStyles">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>optionParamStyles</h4>
<pre>public final&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt; optionParamStyles</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ColorScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ColorScheme</h4>
<pre>public&nbsp;ColorScheme()</pre>
<div class="block">Constructs a new empty ColorScheme with <a href="../picocli/CommandLine.Help.Ansi.html#AUTO"><code>CommandLine.Help.Ansi.AUTO</code></a>.</div>
</li>
</ul>
<a name="ColorScheme-picocli.CommandLine.Help.Ansi-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ColorScheme</h4>
<pre>public&nbsp;ColorScheme(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Constructs a new empty ColorScheme with the specified Ansi enabled mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ansi</code> - whether to emit ANSI escape codes or not</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.Help.html#defaultColorScheme-picocli.CommandLine.Help.Ansi-"><code>CommandLine.Help.defaultColorScheme(Ansi)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="commands-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commands</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;commands(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to the registered styles for commands in this color scheme</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="options-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;options(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to registered the styles for options in this color scheme</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="parameters-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;parameters(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to registered the styles for parameters in this color scheme</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="optionParams-picocli.CommandLine.Help.Ansi.IStyle...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionParams</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;optionParams(<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>...&nbsp;styles)</pre>
<div class="block">Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>styles</code> - the styles to add to the registered styles for option parameters in this color scheme</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this color scheme to enable method chaining for a more fluent API</dd>
</dl>
</li>
</ul>
<a name="commandText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandText</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;commandText(java.lang.String&nbsp;command)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;commandText(<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>&nbsp;command)</pre>
<div class="block">Returns a Text with all command styles applied to the specified command string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -440,7 +270,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>optionText</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionText(java.lang.String&nbsp;option)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionText(<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>&nbsp;option)</pre>
<div class="block">Returns a Text with all option styles applied to the specified option string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -456,7 +286,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>parameterText</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;parameterText(java.lang.String&nbsp;parameter)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;parameterText(<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>&nbsp;parameter)</pre>
<div class="block">Returns a Text with all parameter styles applied to the specified parameter string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -472,7 +302,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>optionParamText</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionParamText(java.lang.String&nbsp;optionParam)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionParamText(<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>&nbsp;optionParam)</pre>
<div class="block">Returns a Text with all optionParam styles applied to the specified optionParam string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -482,33 +312,96 @@ extends java.lang.Object</pre>
</dl>
</li>
</ul>
<a name="applySystemProperties--">
<a name="ansi--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applySystemProperties</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;applySystemProperties()</pre>
<div class="block">Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme.
Supported property names:<ul>
<li><code>picocli.color.commands</code></li>
<li><code>picocli.color.options</code></li>
<li><code>picocli.color.parameters</code></li>
<li><code>picocli.color.optionParams</code></li>
</ul><p>Property values can be anything that <a href="../picocli/CommandLine.Help.Ansi.Style.html#parse-java.lang.String-"><code>CommandLine.Help.Ansi.Style.parse(String)</code></a> can handle.</p></div>
<h4>ansi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi()</pre>
<div class="block">Returns the <code>Ansi</code> setting of this color scheme.</div>
</li>
</ul>
<a name="commandStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;commandStyles()</pre>
<div class="block">Returns the registered styles for commands in this color scheme.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ColorScheme</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="ansi--">
<a name="optionStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;optionStyles()</pre>
<div class="block">Returns the registered styles for options in this color scheme.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="parameterStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;parameterStyles()</pre>
<div class="block">Returns the registered styles for positional parameters in this color scheme.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="optionParamStyles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionParamStyles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;optionParamStyles()</pre>
<div class="block">Returns the registered styles for option parameters in this color scheme.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ansi</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi()</pre>
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
@@ -539,7 +432,7 @@ extends java.lang.Object</pre>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.ColorScheme.html" target="_top">Frames</a></li>
@@ -563,15 +456,15 @@ extends java.lang.Object</pre>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>

32
docs/apidocs/picocli/CommandLine.Help.Column.Overflow.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Column.Overflow (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.Column.Overflow (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Column.Overflow (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Column.Overflow (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,10 +96,10 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Column.Overflow</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">CommandLine.Help.Column.Overflow</span>
extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&gt;</pre>
<div class="block">Policy for handling text that is longer than the column width:
span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.</div>
</li>
@@ -168,7 +168,7 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Column.Overflow.h
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Column.Overflow.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Column.Overflow.html#valueOf-java.lang.String-">valueOf</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
@@ -184,15 +184,15 @@ the order they are declared.</div>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -269,7 +269,7 @@ for (CommandLine.Help.Column.Overflow c : CommandLine.Help.Column.Overflow.value
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a>&nbsp;valueOf(<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>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
@@ -280,8 +280,8 @@ not permitted.)</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>

20
docs/apidocs/picocli/CommandLine.Help.Column.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Column (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.Column (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Column (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Column (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -42,7 +42,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
@@ -90,7 +90,7 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Column</li>
@@ -107,7 +107,7 @@
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.Column</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Columns define the width, indent (leading number of spaces in a column before the value) and
<a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">Overflow</a> policy of a column in a <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">TextTable</a>.</div>
</li>
@@ -200,8 +200,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -293,7 +293,7 @@ extends java.lang.Object</pre>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.ColorScheme.Builder.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">

8
docs/apidocs/picocli/CommandLine.Help.IOptionRenderer.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.IOptionRenderer (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.IOptionRenderer (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.IOptionRenderer (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.IOptionRenderer (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {

16
docs/apidocs/picocli/CommandLine.Help.IParamLabelRenderer.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.IParamLabelRenderer (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.IParamLabelRenderer (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.IParamLabelRenderer (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.IParamLabelRenderer (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -129,13 +129,13 @@ var activeTableTab = "activeTableTab";
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html#renderParameterLabel-picocli.CommandLine.Model.ArgSpec-picocli.CommandLine.Help.Ansi-java.util.List-">renderParameterLabel</a></span>(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</code>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</code>
<div class="block">Returns a text rendering of the option parameter or positional parameter; returns an empty string
<code>""</code> if the option is a boolean and does not take a parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html#separator--">separator</a></span>()</code>
<div class="block">Returns the separator between option name and param label.</div>
</td>
@@ -163,7 +163,7 @@ var activeTableTab = "activeTableTab";
<h4>renderParameterLabel</h4>
<pre><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;renderParameterLabel(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</pre>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a>&gt;&nbsp;styles)</pre>
<div class="block">Returns a text rendering of the option parameter or positional parameter; returns an empty string
<code>""</code> if the option is a boolean and does not take a parameter.</div>
<dl>
@@ -184,7 +184,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>separator</h4>
<pre>java.lang.String&nbsp;separator()</pre>
<pre><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>&nbsp;separator()</pre>
<div class="block">Returns the separator between option name and param label.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>

8
docs/apidocs/picocli/CommandLine.Help.IParameterRenderer.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.IParameterRenderer (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.IParameterRenderer (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.IParameterRenderer (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.IParameterRenderer (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {

30
docs/apidocs/picocli/CommandLine.Help.Layout.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Layout (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.Layout (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Layout (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Layout (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Layout</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.Layout</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Use a Layout to format usage help text for options and parameters in tabular format.
<p>Delegates to the renderers to create <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><code>CommandLine.Help.Ansi.Text</code></a> values for the annotated fields, and uses a
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a> to display these values in tabular format. Layout is responsible for deciding which values
@@ -224,7 +224,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Layout.html#addOptions-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addOptions</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options,
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Layout.html#addOptions-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addOptions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</code>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addOption-picocli.CommandLine.Model.OptionSpec-picocli.CommandLine.Help.IParamLabelRenderer-"><code>addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Options in the list.</div>
</td>
@@ -240,7 +240,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameters-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addPositionalParameters</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;params,
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameters-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addPositionalParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;params,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</code>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameter-picocli.CommandLine.Model.PositionalParamSpec-picocli.CommandLine.Help.IParamLabelRenderer-"><code>addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Parameters in the list.</div>
</td>
@@ -253,7 +253,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Layout.html#toString--">toString</a></span>()</code>
<div class="block">Returns the section of the usage help message accumulated in the TextTable owned by this layout.</div>
</td>
@@ -263,8 +263,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -414,7 +414,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>addOptions</h4>
<pre>public&nbsp;void&nbsp;addOptions(java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options,
<pre>public&nbsp;void&nbsp;addOptions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</pre>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addOption-picocli.CommandLine.Model.OptionSpec-picocli.CommandLine.Help.IParamLabelRenderer-"><code>addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Options in the list.</div>
<dl>
@@ -452,7 +452,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>addPositionalParameters</h4>
<pre>public&nbsp;void&nbsp;addPositionalParameters(java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;params,
<pre>public&nbsp;void&nbsp;addPositionalParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;params,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</pre>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameter-picocli.CommandLine.Model.PositionalParamSpec-picocli.CommandLine.Help.IParamLabelRenderer-"><code>addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Parameters in the list.</div>
<dl>
@@ -490,11 +490,11 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<div class="block">Returns the section of the usage help message accumulated in the TextTable owned by this layout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

16
docs/apidocs/picocli/CommandLine.Help.TextTable.Cell.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.TextTable.Cell (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.TextTable.Cell (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.TextTable.Cell (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.TextTable.Cell (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,7 +90,7 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.TextTable.Cell</li>
@@ -107,7 +107,7 @@
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.TextTable.Cell</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Helper class to index positions in a <code>Help.TextTable</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -176,8 +176,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>

42
docs/apidocs/picocli/CommandLine.Help.TextTable.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.TextTable (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.TextTable (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.TextTable (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.TextTable (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.TextTable</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help.TextTable</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>Responsible for spacing out <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><code>CommandLine.Help.Ansi.Text</code></a> values according to the <a href="../picocli/CommandLine.Help.Column.html" title="class in picocli"><code>CommandLine.Help.Column</code></a> definitions the table was
created with. Columns have a width, indentation, and an overflow policy that decides what to do if a value is
longer than the column's width.</p></div>
@@ -157,7 +157,7 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#columnValues">columnValues</a></span></code>
<div class="block">The <code>char[]</code> slots of the <code>TextTable</code> to copy text values into.</div>
</td>
@@ -218,7 +218,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#addRowValues-java.lang.String...-">addRowValues</a></span>(java.lang.String...&nbsp;values)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#addRowValues-java.lang.String...-">addRowValues</a></span>(<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>...&nbsp;values)</code>
<div class="block">Delegates to <a href="../picocli/CommandLine.Help.TextTable.html#addRowValues-picocli.CommandLine.Help.Ansi.Text...-"><code>addRowValues(CommandLine.Help.Ansi.Text...)</code></a>.</div>
</td>
</tr>
@@ -312,12 +312,12 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.StringBuilder</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#toString-java.lang.StringBuilder-">toString</a></span>(java.lang.StringBuilder&nbsp;text)</code>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.TextTable.html#toString-java.lang.StringBuilder-">toString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;text)</code>
<div class="block">Copies the text representation that we built up from the options into the specified StringBuilder.</div>
</td>
</tr>
@@ -326,8 +326,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -349,7 +349,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>columnValues</h4>
<pre>protected final&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&gt; columnValues</pre>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&gt; columnValues</pre>
<div class="block">The <code>char[]</code> slots of the <code>TextTable</code> to copy text values into.</div>
</li>
</ul>
@@ -536,7 +536,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>cellAt</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;cellAt(int&nbsp;row,
int&nbsp;col)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Help.TextTable.html#textAt-int-int-"><code>textAt(int, int)</code></a> instead</span></div>
@@ -580,7 +580,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>addRowValues</h4>
<pre>public&nbsp;void&nbsp;addRowValues(java.lang.String...&nbsp;values)</pre>
<pre>public&nbsp;void&nbsp;addRowValues(<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>...&nbsp;values)</pre>
<div class="block">Delegates to <a href="../picocli/CommandLine.Help.TextTable.html#addRowValues-picocli.CommandLine.Help.Ansi.Text...-"><code>addRowValues(CommandLine.Help.Ansi.Text...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -601,7 +601,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the values to write into a new row in this TextTable</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the number of values exceeds the number of Columns in this table</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the number of values exceeds the number of Columns in this table</dd>
</dl>
</li>
</ul>
@@ -625,7 +625,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Cell indicating the position in the table that was last written to (since 2.0)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified row exceeds the table's <a href="../picocli/CommandLine.Help.TextTable.html#rowCount--">row count</a></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the specified row exceeds the table's <a href="../picocli/CommandLine.Help.TextTable.html#rowCount--">row count</a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0 (previous versions returned a <code>java.awt.Point</code> object)</dd>
</dl>
@@ -637,7 +637,7 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.StringBuilder&nbsp;toString(java.lang.StringBuilder&nbsp;text)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;toString(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;text)</pre>
<div class="block">Copies the text representation that we built up from the options into the specified StringBuilder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -653,10 +653,10 @@ public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

32
docs/apidocs/picocli/CommandLine.Help.Visibility.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help.Visibility (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Help.Visibility (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Visibility (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help.Visibility (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,10 +96,10 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Visibility</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static enum <span class="typeNameLabel">CommandLine.Help.Visibility</span>
extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&gt;</pre>
<div class="block">Controls the visibility of certain aspects of the usage help message.</div>
</li>
</ul>
@@ -167,7 +167,7 @@ extends java.lang.Enum&lt;<a href="../picocli/CommandLine.Help.Visibility.html"
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Visibility.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.Visibility.html#valueOf-java.lang.String-">valueOf</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
@@ -183,15 +183,15 @@ the order they are declared.</div>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -268,7 +268,7 @@ for (CommandLine.Help.Visibility c : CommandLine.Help.Visibility.values())
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Help.Visibility.html" title="enum in picocli">CommandLine.Help.Visibility</a>&nbsp;valueOf(<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>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
@@ -279,8 +279,8 @@ not permitted.)</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>

360
docs/apidocs/picocli/CommandLine.Help.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:11 JST 2019 -->
<title>CommandLine.Help (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:47 JST 2019 -->
<title>CommandLine.Help (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Help (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":10,"i24":9,"i25":10,"i26":10,"i27":42,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":9,"i35":41,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":9,"i44":10,"i45":42,"i46":10,"i47":10,"i48":10};
var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":10,"i24":9,"i25":10,"i26":10,"i27":42,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":9,"i37":41,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":9,"i46":10,"i47":42,"i48":10,"i49":10,"i50":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.ExitCode.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Help</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A collection of methods and inner classes that provide fine-grained control over the contents and layout of
the usage help message to display to end users when help is requested or invalid input values were specified.
<h2>Class Diagram of the CommandLine.Help API</h2>
@@ -246,13 +246,13 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colFirst"><code>protected static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#DEFAULT_COMMAND_NAME">DEFAULT_COMMAND_NAME</a></span></code>
<div class="block">Constant String holding the default program name, value defined in <a href="../picocli/CommandLine.Model.CommandSpec.html#DEFAULT_COMMAND_NAME"><code>CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colFirst"><code>protected static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#DEFAULT_SEPARATOR">DEFAULT_SEPARATOR</a></span></code>
<div class="block">Constant String holding the default string that separates options from option parameters, value defined in <a href="../picocli/CommandLine.Model.ParserSpec.html#DEFAULT_SEPARATOR"><code>CommandLine.Model.ParserSpec.DEFAULT_SEPARATOR</code></a>.</div>
</td>
@@ -279,20 +279,20 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-">Help</a></span>(java.lang.Object&nbsp;command)</code>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-">Help</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command)</code>
<div class="block">Constructs a new <code>Help</code> instance with a default color scheme, initialized from annotatations
on the specified class and superclasses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-picocli.CommandLine.Help.Ansi-">Help</a></span>(java.lang.Object&nbsp;command,
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-picocli.CommandLine.Help.Ansi-">Help</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Constructs a new <code>Help</code> instance with a default color scheme, initialized from annotatations
on the specified class and superclasses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-picocli.CommandLine.Help.ColorScheme-">Help</a></span>(java.lang.Object&nbsp;command,
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#Help-java.lang.Object-picocli.CommandLine.Help.ColorScheme-">Help</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <code>picocli.CommandLine.Help#Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)</code></span></div>
@@ -315,7 +315,7 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#abbreviatedSynopsis--">abbreviatedSynopsis</a></span>()</code>
<div class="block">Generates a generic synopsis like <code>&lt;command name&gt; [OPTIONS] [PARAM1 [PARAM2]...]</code>, omitting parts
that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).</div>
@@ -323,19 +323,19 @@ extends java.lang.Object</pre>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#addAllSubcommands-java.util.Map-">addAllSubcommands</a></span>(java.util.Map&lt;java.lang.String,<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;commands)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#addAllSubcommands-java.util.Map-">addAllSubcommands</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;commands)</code>
<div class="block">Registers all specified subcommands with this Help.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#addSubcommand-java.lang.String-java.lang.Object-">addSubcommand</a></span>(java.lang.String&nbsp;commandName,
java.lang.Object&nbsp;command)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#addSubcommand-java.lang.String-java.lang.Object-">addSubcommand</a></span>(<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>&nbsp;commandName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;&nbsp;</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#aliases--">aliases</a></span>()</code>
<div class="block">Returns the list of aliases for the command in this Help.</div>
</td>
@@ -353,21 +353,21 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#commandList--">commandList</a></span>()</code>
<div class="block">Returns a 2-column list with command names and the first line of their header or (if absent) description.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#commandListHeading-java.lang.Object...-">commandListHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#commandListHeading-java.lang.Object...-">commandListHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the command list; an empty string if there are no commands,
otherwise the result of <code>String.format(commandListHeading, params)</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#commandNamesText-java.lang.String-">commandNamesText</a></span>(java.lang.String&nbsp;separator)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#commandNamesText-java.lang.String-">commandNamesText</a></span>(<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>&nbsp;separator)</code>
<div class="block">Returns a <code>Text</code> object containing the command name and all aliases, separated with the specified separator.</div>
</td>
</tr>
@@ -414,22 +414,22 @@ extends java.lang.Object</pre>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisGroupsText-java.util.Set-">createDetailedSynopsisGroupsText</a></span>(java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;outparam_groupArgs)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisGroupsText-java.util.Set-">createDetailedSynopsisGroupsText</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;outparam_groupArgs)</code>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in
the specified <a href="../picocli/CommandLine.ArgGroup.html#validate--">validating</a> <a href="../picocli/CommandLine.ArgGroup.html" title="annotation in picocli">groups</a>, starting with a <code>" "</code> space.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisOptionsText-java.util.Collection-java.util.Comparator-boolean-">createDetailedSynopsisOptionsText</a></span>(java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisOptionsText-java.util.Collection-java.util.Comparator-boolean-">createDetailedSynopsisOptionsText</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</code>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the options, starting with a <code>" "</code> space.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisPositionalsText-java.util.Collection-">createDetailedSynopsisPositionalsText</a></span>(java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createDetailedSynopsisPositionalsText-java.util.Collection-">createDetailedSynopsisPositionalsText</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done)</code>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a <code>" "</code> space.</div>
</td>
</tr>
@@ -454,21 +454,21 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createShortOptionArityAndNameComparator--">createShortOptionArityAndNameComparator</a></span>()</code>
<div class="block">Sorts <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>OptionSpecs</code></a> by their option <a href="../picocli/CommandLine.Range.html#max">max arity</a> first, by
<a href="../picocli/CommandLine.Range.html#min">min arity</a> next, and by <a href="../picocli/CommandLine.Help.html#createShortOptionNameComparator--">option name</a> last.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#createShortOptionNameComparator--">createShortOptionNameComparator</a></span>()</code>
<div class="block">Sorts <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>OptionSpecs</code></a> by their option name in case-insensitive alphabetic order.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#customSynopsis-java.lang.Object...-">customSynopsis</a></span>(java.lang.Object...&nbsp;params)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#customSynopsis-java.lang.Object...-">customSynopsis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns command custom synopsis as a string.</div>
</td>
</tr>
@@ -480,21 +480,21 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#description-java.lang.Object...-">description</a></span>(java.lang.Object...&nbsp;params)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#description-java.lang.Object...-">description</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns command description text as a string.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#descriptionHeading-java.lang.Object...-">descriptionHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#descriptionHeading-java.lang.Object...-">descriptionHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the description text; an empty string if there is no description,
otherwise the result of <code>String.format(descriptionHeading, params)</code>.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-">detailedSynopsis</a></span>(java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-">detailedSynopsis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div>
@@ -502,149 +502,161 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-">detailedSynopsis</a></span>(int&nbsp;synopsisHeadingLength,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</code>
<div class="block">Generates a detailed synopsis message showing all options and parameters.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#footer-java.lang.Object...-">footer</a></span>(java.lang.Object...&nbsp;params)</code>
<div class="block">Returns command footer text as a string.</div>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#exitCodeList--">exitCodeList</a></span>()</code>
<div class="block">Returns a 2-column list with exit codes and their description.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#footerHeading-java.lang.Object...-">footerHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<div class="block">Returns the text displayed before the footer text; the result of <code>String.format(footerHeading, params)</code>.</div>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#exitCodeListHeading-java.lang.Object...-">exitCodeListHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the exit code list text; the result of <code>String.format(exitCodeHeading, params)</code>.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#header-java.lang.Object...-">header</a></span>(java.lang.Object...&nbsp;params)</code>
<div class="block">Returns the command header text as a string.</div>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#footer-java.lang.Object...-">footer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns command footer text as a string.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#headerHeading-java.lang.Object...-">headerHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<div class="block">Returns the text displayed before the header text; the result of <code>String.format(headerHeading, params)</code>.</div>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#footerHeading-java.lang.Object...-">footerHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the footer text; the result of <code>String.format(footerHeading, params)</code>.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#header-java.lang.Object...-">header</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the command header text as a string.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#headerHeading-java.lang.Object...-">headerHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the header text; the result of <code>String.format(headerHeading, params)</code>.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>protected <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#insertSynopsisCommandName-int-picocli.CommandLine.Help.Ansi.Text-">insertSynopsisCommandName</a></span>(int&nbsp;synopsisHeadingLength,
<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionsAndPositionalsAndCommandsDetails)</code>
<div class="block">Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>static java.lang.StringBuilder</code></td>
<tr id="i36" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#join-picocli.CommandLine.Help.Ansi-int-boolean-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">join</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
boolean&nbsp;adjustCJK,
java.lang.String[]&nbsp;values,
java.lang.StringBuilder&nbsp;sb,
java.lang.Object...&nbsp;params)</code>
<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>[]&nbsp;values,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Formats each of the specified values and appends it to the specified StringBuilder.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>static java.lang.StringBuilder</code></td>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#join-picocli.CommandLine.Help.Ansi-int-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">join</a></span>(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
java.lang.String[]&nbsp;values,
java.lang.StringBuilder&nbsp;sb,
java.lang.Object...&nbsp;params)</code>
<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>[]&nbsp;values,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../picocli/CommandLine.Help.html#join-java.lang.String:A-int-int-java.lang.String-"><code>join(String[], int, int, String)</code></a> instead</span></div>
<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>join(Ansi, int, boolean, String[], StringBuilder, Object...)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i38" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#optionList--">optionList</a></span>()</code>
<div class="block">Returns a description of the <a href="../picocli/CommandLine.Option.html" title="annotation in picocli">options</a> supported by the application.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#optionList-picocli.CommandLine.Help.Layout-java.util.Comparator-picocli.CommandLine.Help.IParamLabelRenderer-">optionList</a></span>(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;valueLabelRenderer)</code>
<div class="block">Sorts all <code>Options</code> with the specified <code>comparator</code> (if the comparator is non-<code>null</code>),
then <a href="../picocli/CommandLine.Help.Layout.html#addOption-picocli.CommandLine.Model.OptionSpec-picocli.CommandLine.Help.IParamLabelRenderer-">adds</a> all non-hidden options to the
specified TextTable and returns the result of TextTable.toString().</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#optionListHeading-java.lang.Object...-">optionListHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<tr id="i40" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#optionListHeading-java.lang.Object...-">optionListHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the option list; an empty string if there are no options,
otherwise the result of <code>String.format(optionListHeading, params)</code>.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#parameterLabelRenderer--">parameterLabelRenderer</a></span>()</code>
<div class="block">Option and positional parameter value label renderer used for the synopsis line(s) and the option list.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i42" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#parameterList--">parameterList</a></span>()</code>
<div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#parameterList-picocli.CommandLine.Help.Layout-picocli.CommandLine.Help.IParamLabelRenderer-">parameterList</a></span>(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</code>
<div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#parameterListHeading-java.lang.Object...-">parameterListHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<tr id="i44" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#parameterListHeading-java.lang.Object...-">parameterListHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the positional parameter list; an empty string if there are no positional
parameters, otherwise the result of <code>String.format(parameterListHeading, params)</code>.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>static java.util.Comparator&lt;java.lang.String&gt;</code></td>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#shortestFirst--">shortestFirst</a></span>()</code>
<div class="block">Sorts short strings before longer strings.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&gt;</code></td>
<tr id="i46" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#subcommands--">subcommands</a></span>()</code>
<div class="block">Returns the map of subcommand <code>Help</code> instances for this command Help.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#synopsis--">synopsis</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Help.html#synopsis-int-"><code>synopsis(int)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i48" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#synopsis-int-">synopsis</a></span>(int&nbsp;synopsisHeadingLength)</code>
<div class="block">Returns a synopsis for the command, reserving the specified space for the synopsis heading.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#synopsisHeading-java.lang.Object...-">synopsisHeading</a></span>(java.lang.Object...&nbsp;params)</code>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#synopsisHeading-java.lang.Object...-">synopsisHeading</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</code>
<div class="block">Returns the text displayed before the synopsis text; the result of <code>String.format(synopsisHeading, params)</code>.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<tr id="i50" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Help.html#synopsisHeadingLength--">synopsisHeadingLength</a></span>()</code>
<div class="block">Returns the number of characters the synopsis heading will take on the same line as the synopsis.</div>
@@ -655,8 +667,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -678,7 +690,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_COMMAND_NAME</h4>
<pre>protected static final&nbsp;java.lang.String DEFAULT_COMMAND_NAME</pre>
<pre>protected static 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> DEFAULT_COMMAND_NAME</pre>
<div class="block">Constant String holding the default program name, value defined in <a href="../picocli/CommandLine.Model.CommandSpec.html#DEFAULT_COMMAND_NAME"><code>CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -692,7 +704,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_SEPARATOR</h4>
<pre>protected static final&nbsp;java.lang.String DEFAULT_SEPARATOR</pre>
<pre>protected static 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> DEFAULT_SEPARATOR</pre>
<div class="block">Constant String holding the default string that separates options from option parameters, value defined in <a href="../picocli/CommandLine.Model.ParserSpec.html#DEFAULT_SEPARATOR"><code>CommandLine.Model.ParserSpec.DEFAULT_SEPARATOR</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -714,7 +726,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>Help</h4>
<pre>public&nbsp;Help(java.lang.Object&nbsp;command)</pre>
<pre>public&nbsp;Help(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command)</pre>
<div class="block">Constructs a new <code>Help</code> instance with a default color scheme, initialized from annotatations
on the specified class and superclasses.</div>
<dl>
@@ -729,7 +741,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>Help</h4>
<pre>public&nbsp;Help(java.lang.Object&nbsp;command,
<pre>public&nbsp;Help(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Constructs a new <code>Help</code> instance with a default color scheme, initialized from annotatations
on the specified class and superclasses.</div>
@@ -746,8 +758,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>Help</h4>
<pre>@Deprecated
public&nbsp;Help(java.lang.Object&nbsp;command,
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;Help(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <code>picocli.CommandLine.Help#Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)</code></span></div>
<div class="block">Constructs a new <code>Help</code> instance with the specified color scheme, initialized from annotatations
@@ -818,7 +830,7 @@ public&nbsp;Help(java.lang.Object&nbsp;command,
<ul class="blockList">
<li class="blockList">
<h4>subcommands</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&gt;&nbsp;subcommands()</pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&gt;&nbsp;subcommands()</pre>
<div class="block">Returns the map of subcommand <code>Help</code> instances for this command Help.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -832,7 +844,7 @@ public&nbsp;Help(java.lang.Object&nbsp;command,
<ul class="blockList">
<li class="blockList">
<h4>aliases</h4>
<pre>protected&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;aliases()</pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;aliases()</pre>
<div class="block">Returns the list of aliases for the command in this Help.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -859,7 +871,7 @@ public&nbsp;Help(java.lang.Object&nbsp;command,
<ul class="blockList">
<li class="blockList">
<h4>addAllSubcommands</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;addAllSubcommands(java.util.Map&lt;java.lang.String,<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;commands)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;addAllSubcommands(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;commands)</pre>
<div class="block">Registers all specified subcommands with this Help.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -877,9 +889,9 @@ public&nbsp;Help(java.lang.Object&nbsp;command,
<ul class="blockList">
<li class="blockList">
<h4>addSubcommand</h4>
<pre>@Deprecated
public&nbsp;<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;addSubcommand(java.lang.String&nbsp;commandName,
java.lang.Object&nbsp;command)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;addSubcommand(<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>&nbsp;commandName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;command)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Registers the specified subcommand with this Help.</div>
<dl>
@@ -897,8 +909,8 @@ public&nbsp;<a href="../picocli/CommandLine.Help.html" title="class in picocli">
<ul class="blockList">
<li class="blockList">
<h4>synopsis</h4>
<pre>@Deprecated
public&nbsp;java.lang.String&nbsp;synopsis()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&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>&nbsp;synopsis()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Help.html#synopsis-int-"><code>synopsis(int)</code></a> instead</span></div>
<div class="block">Returns a synopsis for the command without reserving space for the synopsis heading.</div>
<dl>
@@ -916,7 +928,7 @@ public&nbsp;java.lang.String&nbsp;synopsis()</pre>
<ul class="blockList">
<li class="blockList">
<h4>synopsis</h4>
<pre>public&nbsp;java.lang.String&nbsp;synopsis(int&nbsp;synopsisHeadingLength)</pre>
<pre>public&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>&nbsp;synopsis(int&nbsp;synopsisHeadingLength)</pre>
<div class="block">Returns a synopsis for the command, reserving the specified space for the synopsis heading.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -936,7 +948,7 @@ public&nbsp;java.lang.String&nbsp;synopsis()</pre>
<ul class="blockList">
<li class="blockList">
<h4>abbreviatedSynopsis</h4>
<pre>public&nbsp;java.lang.String&nbsp;abbreviatedSynopsis()</pre>
<pre>public&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>&nbsp;abbreviatedSynopsis()</pre>
<div class="block">Generates a generic synopsis like <code>&lt;command name&gt; [OPTIONS] [PARAM1 [PARAM2]...]</code>, omitting parts
that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).</div>
<dl>
@@ -951,9 +963,9 @@ public&nbsp;java.lang.String&nbsp;synopsis()</pre>
<ul class="blockList">
<li class="blockList">
<h4>detailedSynopsis</h4>
<pre>@Deprecated
public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&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>&nbsp;detailedSynopsis(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div>
<div class="block">Generates a detailed synopsis message showing all options and parameters. Follows the unix convention of
showing optional options and parameters in square brackets (<code>[ ]</code>).</div>
@@ -972,9 +984,9 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>detailedSynopsis</h4>
<pre>public&nbsp;java.lang.String&nbsp;detailedSynopsis(int&nbsp;synopsisHeadingLength,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</pre>
<pre>public&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>&nbsp;detailedSynopsis(int&nbsp;synopsisHeadingLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</pre>
<div class="block">Generates a detailed synopsis message showing all options and parameters. Follows the unix convention of
showing optional options and parameters in square brackets (<code>[ ]</code>).</div>
<dl>
@@ -995,7 +1007,7 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>createDetailedSynopsisGroupsText</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisGroupsText(java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;outparam_groupArgs)</pre>
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisGroupsText(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;outparam_groupArgs)</pre>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in
the specified <a href="../picocli/CommandLine.ArgGroup.html#validate--">validating</a> <a href="../picocli/CommandLine.ArgGroup.html" title="annotation in picocli">groups</a>, starting with a <code>" "</code> space.</div>
<dl>
@@ -1015,8 +1027,8 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>createDetailedSynopsisOptionsText</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisOptionsText(java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisOptionsText(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
boolean&nbsp;clusterBooleanOptions)</pre>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the options, starting with a <code>" "</code> space.
Follows the unix convention of showing optional options and parameters in square brackets (<code>[ ]</code>).</div>
@@ -1038,7 +1050,7 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>createDetailedSynopsisPositionalsText</h4>
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisPositionalsText(java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done)</pre>
<pre>protected&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;createDetailedSynopsisPositionalsText(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;done)</pre>
<div class="block">Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a <code>" "</code> space.
Follows the unix convention of showing optional options and parameters in square brackets (<code>[ ]</code>).</div>
<dl>
@@ -1074,8 +1086,8 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>insertSynopsisCommandName</h4>
<pre>protected&nbsp;java.lang.String&nbsp;insertSynopsisCommandName(int&nbsp;synopsisHeadingLength,
<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionsAndPositionalsAndCommandsDetails)</pre>
<pre>protected&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>&nbsp;insertSynopsisCommandName(int&nbsp;synopsisHeadingLength,
<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;optionsAndPositionalsAndCommandsDetails)</pre>
<div class="block">Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1110,7 +1122,7 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>optionList</h4>
<pre>public&nbsp;java.lang.String&nbsp;optionList()</pre>
<pre>public&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>&nbsp;optionList()</pre>
<div class="block"><p>Returns a description of the <a href="../picocli/CommandLine.Option.html" title="annotation in picocli">options</a> supported by the application.
This implementation <a href="../picocli/CommandLine.Help.html#createShortOptionNameComparator--">sorts options alphabetically</a>, and shows
only the <a href="../picocli/CommandLine.Option.html#hidden--">non-hidden</a> options in a <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">tabular format</a>
@@ -1129,9 +1141,9 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>optionList</h4>
<pre>public&nbsp;java.lang.String&nbsp;optionList(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;valueLabelRenderer)</pre>
<pre>public&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>&nbsp;optionList(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;optionSort,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;valueLabelRenderer)</pre>
<div class="block">Sorts all <code>Options</code> with the specified <code>comparator</code> (if the comparator is non-<code>null</code>),
then <a href="../picocli/CommandLine.Help.Layout.html#addOption-picocli.CommandLine.Model.OptionSpec-picocli.CommandLine.Help.IParamLabelRenderer-">adds</a> all non-hidden options to the
specified TextTable and returns the result of TextTable.toString().</div>
@@ -1152,7 +1164,7 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>parameterList</h4>
<pre>public&nbsp;java.lang.String&nbsp;parameterList()</pre>
<pre>public&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>&nbsp;parameterList()</pre>
<div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1166,8 +1178,8 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>parameterList</h4>
<pre>public&nbsp;java.lang.String&nbsp;parameterList(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</pre>
<pre>public&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>&nbsp;parameterList(<a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a>&nbsp;layout,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a>&nbsp;paramLabelRenderer)</pre>
<div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1184,13 +1196,13 @@ public&nbsp;java.lang.String&nbsp;detailedSynopsis(java.util.Comparator&lt;<a hr
<ul class="blockList">
<li class="blockList">
<h4>join</h4>
<pre>@Deprecated
public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
java.lang.String[]&nbsp;values,
java.lang.StringBuilder&nbsp;sb,
java.lang.Object...&nbsp;params)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../picocli/CommandLine.Help.html#join-java.lang.String:A-int-int-java.lang.String-"><code>join(String[], int, int, String)</code></a> instead</span></div>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;join(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
<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>[]&nbsp;values,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>join(Ansi, int, boolean, String[], StringBuilder, Object...)</code></a> instead</span></div>
</li>
</ul>
<a name="join-picocli.CommandLine.Help.Ansi-int-boolean-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">
@@ -1199,12 +1211,12 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>join</h4>
<pre>public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
boolean&nbsp;adjustCJK,
java.lang.String[]&nbsp;values,
java.lang.StringBuilder&nbsp;sb,
java.lang.Object...&nbsp;params)</pre>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;join(<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
int&nbsp;usageHelpWidth,
boolean&nbsp;adjustCJK,
<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>[]&nbsp;values,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Formats each of the specified values and appends it to the specified StringBuilder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1227,7 +1239,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>customSynopsis</h4>
<pre>public&nbsp;java.lang.String&nbsp;customSynopsis(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;customSynopsis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns command custom synopsis as a string. A custom synopsis can be zero or more lines, and can be
specified declaratively with the <a href="../picocli/CommandLine.Command.html#customSynopsis--"><code>CommandLine.Command.customSynopsis()</code></a> annotation attribute or programmatically
by setting the Help instance's <a href="../picocli/CommandLine.Help.html#customSynopsis-java.lang.Object...-"><code>customSynopsis(java.lang.Object...)</code></a> field.</div>
@@ -1245,7 +1257,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String&nbsp;description(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;description(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns command description text as a string. Description text can be zero or more lines, and can be specified
declaratively with the <a href="../picocli/CommandLine.Command.html#description--"><code>CommandLine.Command.description()</code></a> annotation attribute or programmatically by
setting the Help instance's <a href="../picocli/CommandLine.Help.html#description-java.lang.Object...-"><code>description(java.lang.Object...)</code></a> field.</div>
@@ -1263,7 +1275,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public&nbsp;java.lang.String&nbsp;header(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;header(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the command header text as a string. Header text can be zero or more lines, and can be specified
declaratively with the <a href="../picocli/CommandLine.Command.html#header--"><code>CommandLine.Command.header()</code></a> annotation attribute or programmatically by
setting the Help instance's <a href="../picocli/CommandLine.Help.html#header-java.lang.Object...-"><code>header(java.lang.Object...)</code></a> field.</div>
@@ -1281,7 +1293,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>footer</h4>
<pre>public&nbsp;java.lang.String&nbsp;footer(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;footer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns command footer text as a string. Footer text can be zero or more lines, and can be specified
declaratively with the <a href="../picocli/CommandLine.Command.html#footer--"><code>CommandLine.Command.footer()</code></a> annotation attribute or programmatically by
setting the Help instance's <a href="../picocli/CommandLine.Help.html#footer-java.lang.Object...-"><code>footer(java.lang.Object...)</code></a> field.</div>
@@ -1299,7 +1311,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>headerHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;headerHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;headerHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the header text; the result of <code>String.format(headerHeading, params)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1315,7 +1327,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>synopsisHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;synopsisHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;synopsisHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the synopsis text; the result of <code>String.format(synopsisHeading, params)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1331,7 +1343,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>descriptionHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;descriptionHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;descriptionHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the description text; an empty string if there is no description,
otherwise the result of <code>String.format(descriptionHeading, params)</code>.</div>
<dl>
@@ -1348,7 +1360,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>parameterListHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;parameterListHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;parameterListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the positional parameter list; an empty string if there are no positional
parameters, otherwise the result of <code>String.format(parameterListHeading, params)</code>.</div>
<dl>
@@ -1365,7 +1377,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>optionListHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;optionListHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;optionListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the option list; an empty string if there are no options,
otherwise the result of <code>String.format(optionListHeading, params)</code>.</div>
<dl>
@@ -1382,7 +1394,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>commandListHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;commandListHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;commandListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the command list; an empty string if there are no commands,
otherwise the result of <code>String.format(commandListHeading, params)</code>.</div>
<dl>
@@ -1399,7 +1411,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>footerHeading</h4>
<pre>public&nbsp;java.lang.String&nbsp;footerHeading(java.lang.Object...&nbsp;params)</pre>
<pre>public&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>&nbsp;footerHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the footer text; the result of <code>String.format(footerHeading, params)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1409,13 +1421,47 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
</dl>
</li>
</ul>
<a name="exitCodeListHeading-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeListHeading</h4>
<pre>public&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>&nbsp;exitCodeListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;params)</pre>
<div class="block">Returns the text displayed before the exit code list text; the result of <code>String.format(exitCodeHeading, params)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>params</code> - the parameters to use to format the exit code heading</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the formatted heading of the exit code section of the usage help message</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="exitCodeList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exitCodeList</h4>
<pre>public&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>&nbsp;exitCodeList()</pre>
<div class="block">Returns a 2-column list with exit codes and their description. Descriptions containing <code>"%n"</code> line separators are broken up into multiple lines.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a usage help section describing the exit codes</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="commandList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandList</h4>
<pre>public&nbsp;java.lang.String&nbsp;commandList()</pre>
<pre>public&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>&nbsp;commandList()</pre>
<div class="block">Returns a 2-column list with command names and the first line of their header or (if absent) description.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1429,7 +1475,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>commandNamesText</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;commandNamesText(java.lang.String&nbsp;separator)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>&nbsp;commandNamesText(<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>&nbsp;separator)</pre>
<div class="block">Returns a <code>Text</code> object containing the command name and all aliases, separated with the specified separator.
Command names will use the <a href="../picocli/CommandLine.Help.ColorScheme.html#commandText-java.lang.String-"><code>command style</code></a> for the color scheme of this Help.</div>
<dl>
@@ -1566,7 +1612,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>createShortOptionNameComparator</h4>
<pre>public static&nbsp;java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;createShortOptionNameComparator()</pre>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;createShortOptionNameComparator()</pre>
<div class="block">Sorts <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>OptionSpecs</code></a> by their option name in case-insensitive alphabetic order. If an
option has multiple names, the shortest name is used for the sorting. Help options follow non-help options.</div>
<dl>
@@ -1581,7 +1627,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>createShortOptionArityAndNameComparator</h4>
<pre>public static&nbsp;java.util.Comparator&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;createShortOptionArityAndNameComparator()</pre>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;createShortOptionArityAndNameComparator()</pre>
<div class="block">Sorts <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>OptionSpecs</code></a> by their option <a href="../picocli/CommandLine.Range.html#max">max arity</a> first, by
<a href="../picocli/CommandLine.Range.html#min">min arity</a> next, and by <a href="../picocli/CommandLine.Help.html#createShortOptionNameComparator--">option name</a> last.</div>
<dl>
@@ -1596,7 +1642,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
<ul class="blockList">
<li class="blockList">
<h4>shortestFirst</h4>
<pre>public static&nbsp;java.util.Comparator&lt;java.lang.String&gt;&nbsp;shortestFirst()</pre>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<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>&gt;&nbsp;shortestFirst()</pre>
<div class="block">Sorts short strings before longer strings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1662,7 +1708,7 @@ public static&nbsp;java.lang.StringBuilder&nbsp;join(<a href="../picocli/Command
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.ExitCode.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">

82
docs/apidocs/picocli/CommandLine.HelpCommand.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.HelpCommand (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.HelpCommand (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.HelpCommand (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.HelpCommand (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var methods = {"i0":42,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.HelpCommand</li>
@@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Runnable, <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a></dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -117,8 +117,8 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">CommandLine.HelpCommand</span>
extends java.lang.Object
implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, java.lang.Runnable</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre>
<div class="block">Help command that can be installed as a subcommand on all application commands. When invoked with a subcommand
argument, it prints usage help for the specified subcommand. For example:<pre>
@@ -167,7 +167,7 @@ implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -176,15 +176,24 @@ implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.io.PrintStream&nbsp;out,
java.io.PrintStream&nbsp;err)</code>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;err)</code>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#run--">run</a></span>()</code>
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>usage</code></a> for the specified command, or for the parent command.</div>
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-"><code>usage</code></a> for the specified command, or for the parent command.</div>
</td>
</tr>
</table>
@@ -192,8 +201,8 @@ implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -233,23 +242,25 @@ implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>usage</code></a> for the specified command, or for the parent command.</div>
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-"><code>usage</code></a> for the specified command, or for the parent command.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd>
</dl>
</li>
</ul>
<a name="init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.io.PrintStream&nbsp;out,
java.io.PrintStream&nbsp;err)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -263,6 +274,29 @@ implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title
</dl>
</li>
</ul>
<a name="init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;err)</pre>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.IHelpCommandInitializable2.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>helpCommandLine</code> - the <code>CommandLine</code> object associated with this help command. Implementors can use
this to walk the command hierarchy and get access to the help command's parent and sibling commands.</dd>
<dd><code>colorScheme</code> - the color scheme to use when printing help, including whether to use Ansi colors or not</dd>
<dd><code>out</code> - the output writer to print the usage help message to</dd>
<dd><code>err</code> - the error writer to print any diagnostic messages to, in addition to the output from the exception handler</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>

16
docs/apidocs/picocli/CommandLine.IDefaultValueProvider.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IDefaultValueProvider (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IDefaultValueProvider (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IDefaultValueProvider (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IDefaultValueProvider (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -130,7 +130,7 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IDefaultValueProvider.html#defaultValue-picocli.CommandLine.Model.ArgSpec-">defaultValue</a></span>(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)</code>
<div class="block">Returns the default value for an option or positional parameter or <code>null</code>.</div>
</td>
@@ -156,8 +156,8 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>defaultValue</h4>
<pre>java.lang.String&nbsp;defaultValue(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)
throws java.lang.Exception</pre>
<pre><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>&nbsp;defaultValue(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the default value for an option or positional parameter or <code>null</code>.
The returned value is converted to the type of the option/positional parameter
via the same type converter used when populating this option/positional
@@ -169,7 +169,7 @@ var activeTableTab = "activeTableTab";
<dd>the default value for the option or positional parameter, or <code>null</code> if
this provider has no default value for the specified option or positional parameter</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - when there was a problem obtaining the default value</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when there was a problem obtaining the default value</dd>
</dl>
</li>
</ul>

28
docs/apidocs/picocli/CommandLine.IExceptionHandler.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IExceptionHandler (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExceptionHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IExceptionHandler (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IExceptionHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -108,10 +108,10 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a> instead.</span></div>
<div class="block"><span class="deprecationComment">see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><code>CommandLine.IParameterExceptionHandler</code></a> and <a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><code>CommandLine.IExecutionExceptionHandler</code></a></span></div>
</div>
<br>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static interface <span class="typeNameLabel">CommandLine.IExceptionHandler</span></pre>
<div class="block">Represents a function that can handle a <code>ParameterException</code> that occurred while
<a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments. This is a
@@ -124,8 +124,6 @@ public static interface <span class="typeNameLabel">CommandLine.IExceptionHandle
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli"><code>CommandLine.DefaultExceptionHandler</code></a></dd>
</dl>
</li>
</ul>
@@ -146,11 +144,11 @@ public static interface <span class="typeNameLabel">CommandLine.IExceptionHandle
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExceptionHandler.html#handleException-picocli.CommandLine.ParameterException-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">handleException</a></span>(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.io.PrintStream&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.lang.String...&nbsp;args)</code>
<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>...&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>
@@ -177,10 +175,10 @@ public static interface <span class="typeNameLabel">CommandLine.IExceptionHandle
<ul class="blockListLast">
<li class="blockList">
<h4>handleException</h4>
<pre>java.util.List&lt;java.lang.Object&gt;&nbsp;handleException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.lang.String...&nbsp;args)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
<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>...&nbsp;args)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>

32
docs/apidocs/picocli/CommandLine.IExceptionHandler2.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IExceptionHandler2 (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExceptionHandler2 (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IExceptionHandler2 (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IExceptionHandler2 (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var methods = {"i0":38,"i1":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExceptionHandler2.html" target="_top">Frames</a></li>
@@ -111,8 +111,12 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>, <a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><code>CommandLine.IParameterExceptionHandler</code></a> and <a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><code>CommandLine.IExecutionExceptionHandler</code></a></span></div>
</div>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IExceptionHandler2&lt;R&gt;</span></pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static interface <span class="typeNameLabel">CommandLine.IExceptionHandler2&lt;R&gt;</span></pre>
<div class="block">Classes implementing this interface know how to handle <code>ParameterExceptions</code> (usually from invalid user input)
and <code>ExecutionExceptions</code> that occurred while executing the <code>Runnable</code> or <code>Callable</code> command.
<p>
@@ -140,7 +144,7 @@ var activeTableTab = "activeTableTab";
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -149,6 +153,7 @@ var activeTableTab = "activeTableTab";
<td class="colFirst"><code><a href="../picocli/CommandLine.IExceptionHandler2.html" title="type parameter in CommandLine.IExceptionHandler2">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExceptionHandler2.html#handleExecutionException-picocli.CommandLine.ExecutionException-picocli.CommandLine.ParseResult-">handleExecutionException</a></span>(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ExecutionException</code> that occurred while executing the <code>Runnable</code> or
<code>Callable</code> command and optionally returns a list of results.</div>
</td>
@@ -156,7 +161,8 @@ var activeTableTab = "activeTableTab";
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.IExceptionHandler2.html" title="type parameter in CommandLine.IExceptionHandler2">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExceptionHandler2.html#handleParseException-picocli.CommandLine.ParameterException-java.lang.String:A-">handleParseException</a></span>(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.lang.String[]&nbsp;args)</code>
<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>[]&nbsp;args)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>
</td>
@@ -183,7 +189,8 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<h4>handleParseException</h4>
<pre><a href="../picocli/CommandLine.IExceptionHandler2.html" title="type parameter in CommandLine.IExceptionHandler2">R</a>&nbsp;handleParseException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
java.lang.String[]&nbsp;args)</pre>
<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>[]&nbsp;args)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command
line arguments and optionally returns a list of results.</div>
<dl>
@@ -204,6 +211,7 @@ var activeTableTab = "activeTableTab";
<h4>handleExecutionException</h4>
<pre><a href="../picocli/CommandLine.IExceptionHandler2.html" title="type parameter in CommandLine.IExceptionHandler2">R</a>&nbsp;handleExecutionException(<a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>&nbsp;ex,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Handles a <code>ExecutionException</code> that occurred while executing the <code>Runnable</code> or
<code>Callable</code> command and optionally returns a list of results.</div>
<dl>
@@ -244,7 +252,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExceptionHandler2.html" target="_top">Frames</a></li>

271
docs/apidocs/picocli/CommandLine.IExecutionExceptionHandler.html Normal file
View File

@@ -0,0 +1,271 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExecutionExceptionHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IExecutionExceptionHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExecutionExceptionHandler.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExecutionExceptionHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IExecutionExceptionHandler" class="title">Interface CommandLine.IExecutionExceptionHandler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IExecutionExceptionHandler</span></pre>
<div class="block">Classes implementing this interface know how to handle Exceptions that occurred while executing the <code>Runnable</code>, <code>Callable</code> or <code>Method</code> user object of the command.
<p><b>Implementation Requirements:</b></p>
<p>Implementors that need to print messages to the console should use the <a href="../picocli/CommandLine.html#getOut--">output</a> and <a href="../picocli/CommandLine.html#getErr--">error</a> PrintWriters,
and the <a href="../picocli/CommandLine.html#getColorScheme--">color scheme</a> from the CommandLine object obtained from the exception.</p>
<p><b>API Note:</b></p>
<p>This interface supersedes <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a>.</p>
<p>Example usage:</p>
<pre>
IExecutionExceptionHandler errorHandler = new IExecutionExceptionHandler() {
public int handleExecutionException(Exception ex,
CommandLine commandLine,
ParseResult parseResult) {
//ex.printStackTrace(); // no stack trace
commandLine.getErr().println(ex.getMessage());
commandLine.usage(commandLine.getErr());
return commandLine.getCommandSpec().exitCodeOnExecutionException();
}
};
int exitCode = new CommandLine(new App())
.setExecutionExceptionHandler(errorHandler)
.execute(args);
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#setExecutionExceptionHandler-picocli.CommandLine.IExecutionExceptionHandler-"><code>CommandLine.setExecutionExceptionHandler(IExecutionExceptionHandler)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExecutionExceptionHandler.html#handleExecutionException-java.lang.Exception-picocli.CommandLine-picocli.CommandLine.ParseResult-">handleExecutionException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;ex,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">Handles an <code>Exception</code> that occurred while executing the <code>Runnable</code> or
<code>Callable</code> command and returns an exit code suitable for returning from <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="handleExecutionException-java.lang.Exception-picocli.CommandLine-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleExecutionException</h4>
<pre>int&nbsp;handleExecutionException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;ex,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Handles an <code>Exception</code> that occurred while executing the <code>Runnable</code> or
<code>Callable</code> command and returns an exit code suitable for returning from <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - the Exception thrown by the <code>Runnable</code>, <code>Callable</code> or <code>Method</code> user object of the command</dd>
<dd><code>commandLine</code> - the CommandLine representing the command or subcommand where the exception occurred</dd>
<dd><code>parseResult</code> - the result of parsing the command line arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an exit code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExecutionExceptionHandler.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExecutionExceptionHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

261
docs/apidocs/picocli/CommandLine.IExecutionStrategy.html Normal file
View File

@@ -0,0 +1,261 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExecutionStrategy (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IExecutionStrategy (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExecutionStrategy.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExecutionStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IExecutionStrategy" class="title">Interface CommandLine.IExecutionStrategy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>, <a href="../picocli/CommandLine.RunAll.html" title="class in picocli">CommandLine.RunAll</a>, <a href="../picocli/CommandLine.RunFirst.html" title="class in picocli">CommandLine.RunFirst</a>, <a href="../picocli/CommandLine.RunLast.html" title="class in picocli">CommandLine.RunLast</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IExecutionStrategy</span></pre>
<div class="block">Implementations are responsible for "executing" the user input and returning an exit code.
The <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a> method delegates to a <a href="../picocli/CommandLine.html#setExecutionStrategy-picocli.CommandLine.IExecutionStrategy-">configured</a> execution strategy.
<p><b>Implementation Requirements:</b></p>
<p>Implementers responsibilities are:</p>
<ul>
<li>From the <code>ParseResult</code>, select which <code>CommandSpec</code> should be executed. This is especially important for commands that have subcommands.</li>
<li>"Execute" the selected <code>CommandSpec</code>. Often this means invoking a method on the spec's <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a>.</li>
<li>Call <a href="../picocli/CommandLine.html#setExecutionResult-java.lang.Object-"><code>setExecutionResult</code></a> to make the return value of that method invocation available to the application</li>
<li>Return an exit code. Common sources of exit values are the invoked method's return value, or the user object if it implements <a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><code>CommandLine.IExitCodeGenerator</code></a>.</li>
</ul>
<p>Implementors that need to print messages to the console should use the <a href="../picocli/CommandLine.html#getOut--">output</a> and <a href="../picocli/CommandLine.html#getErr--">error</a> PrintWriters,
and the <a href="../picocli/CommandLine.html#getColorScheme--">color scheme</a> from the CommandLine object obtained from ParseResult's CommandSpec.</p>
<p><b>API Note:</b></p>
<p>This interface supersedes <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><code>CommandLine.IParseResultHandler2</code></a>.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExecutionStrategy.html#execute-picocli.CommandLine.ParseResult-">execute</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">"Executes" the user input and returns an exit code.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>int&nbsp;execute(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a>,
<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a></pre>
<div class="block">"Executes" the user input and returns an exit code.
Execution often means invoking a method on the selected CommandSpec's <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a>,
and making the return value of that invocation available via <a href="../picocli/CommandLine.html#setExecutionResult-java.lang.Object-"><code>setExecutionResult</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the parse result from which to select one or more <code>CommandSpec</code> instances to execute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an exit code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a></code> - if the invoked method on the CommandSpec's user object threw a ParameterException to signify invalid user input.</dd>
<dd><code><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></code> - if any problem occurred while executing the command. Any exceptions (other than ParameterException) should be wrapped in a ExecutionException and not thrown as is.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExecutionExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExecutionStrategy.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExecutionStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

263
docs/apidocs/picocli/CommandLine.IExitCodeExceptionMapper.html Normal file
View File

@@ -0,0 +1,263 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExitCodeExceptionMapper (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IExitCodeExceptionMapper (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExitCodeExceptionMapper.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExitCodeExceptionMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IExitCodeExceptionMapper" class="title">Interface CommandLine.IExitCodeExceptionMapper</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IExitCodeExceptionMapper</span></pre>
<div class="block">Interface that provides the appropriate exit code that will be returned from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a>
method for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.
<p>Example usage:</p>
<pre>
&#064Command
class FailingCommand implements Callable&lt;Void&gt; {
public Void call() throws IOException {
throw new IOException("error");
}
}
IExitCodeExceptionMapper mapper = new IExitCodeExceptionMapper() {
public int getExitCode(Throwable t) {
if (t instanceof IOException && "error".equals(t.getMessage())) {
return 123;
}
return 987;
}
}
CommandLine cmd = new CommandLine(new FailingCommand());
cmd.setExitCodeExceptionMapper(mapper);
int exitCode = cmd.execute(args);
assert exitCode == 123;
System.exit(exitCode);
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#setExitCodeExceptionMapper-picocli.CommandLine.IExitCodeExceptionMapper-"><code>CommandLine.setExitCodeExceptionMapper(IExitCodeExceptionMapper)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExitCodeExceptionMapper.html#getExitCode-java.lang.Throwable-">getExitCode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;exception)</code>
<div class="block">Returns the exit code that should be returned from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getExitCode-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getExitCode</h4>
<pre>int&nbsp;getExitCode(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;exception)</pre>
<div class="block">Returns the exit code that should be returned from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exception</code> - the exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExitCodeExceptionMapper.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExitCodeExceptionMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

249
docs/apidocs/picocli/CommandLine.IExitCodeGenerator.html Normal file
View File

@@ -0,0 +1,249 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IExitCodeGenerator (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IExitCodeGenerator (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExitCodeGenerator.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExitCodeGenerator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IExitCodeGenerator" class="title">Interface CommandLine.IExitCodeGenerator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IExitCodeGenerator</span></pre>
<div class="block"><code>@Command</code>-annotated classes can implement this interface to specify an exit code that will be returned
from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method when the command is successfully invoked.
<p>Example usage:</p>
<pre>
&#064Command
class MyCommand implements Runnable, IExitCodeGenerator {
public void run() { System.out.println("Hello"); }
public int getExitCode() { return 123; }
}
CommandLine cmd = new CommandLine(new MyCommand());
int exitCode = cmd.execute(args);
assert exitCode == 123;
System.exit(exitCode);
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IExitCodeGenerator.html#getExitCode--">getExitCode</a></span>()</code>
<div class="block">Returns the exit code that should be returned from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getExitCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getExitCode</h4>
<pre>int&nbsp;getExitCode()</pre>
<div class="block">Returns the exit code that should be returned from the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExitCodeExceptionMapper.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IExitCodeGenerator.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IExitCodeGenerator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

20
docs/apidocs/picocli/CommandLine.IFactory.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IFactory (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IFactory (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IFactory (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IFactory (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
@@ -140,7 +140,7 @@ var activeTableTab = "activeTableTab";
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;K&gt;&nbsp;K</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IFactory.html#create-java.lang.Class-">create</a></span>(java.lang.Class&lt;K&gt;&nbsp;cls)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IFactory.html#create-java.lang.Class-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;K&gt;&nbsp;cls)</code>
<div class="block">Returns an instance of the specified class.</div>
</td>
</tr>
@@ -165,8 +165,8 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>&lt;K&gt;&nbsp;K&nbsp;create(java.lang.Class&lt;K&gt;&nbsp;cls)
throws java.lang.Exception</pre>
<pre>&lt;K&gt;&nbsp;K&nbsp;create(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;K&gt;&nbsp;cls)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns an instance of the specified class.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
@@ -176,7 +176,7 @@ var activeTableTab = "activeTableTab";
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - an exception detailing what went wrong when creating or obtaining the instance</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - an exception detailing what went wrong when creating or obtaining the instance</dd>
</dl>
</li>
</ul>
@@ -207,7 +207,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">

40
docs/apidocs/picocli/CommandLine.IHelpCommandInitializable.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IHelpCommandInitializable (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IHelpCommandInitializable (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IHelpCommandInitializable (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IHelpCommandInitializable (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var methods = {"i0":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IHelpCommandInitializable.html" target="_top">Frames</a></li>
@@ -107,8 +107,12 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><code>CommandLine.IHelpCommandInitializable2</code></a> instead</span></div>
</div>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IHelpCommandInitializable</span></pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static interface <span class="typeNameLabel">CommandLine.IHelpCommandInitializable</span></pre>
<div class="block">Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
<p>The <a href="../picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>CommandLine::printHelpIfRequested</code></a> method calls the
<a href="../picocli/CommandLine.IHelpCommandInitializable.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-"><code>init</code></a> method on commands marked as <a href="../picocli/CommandLine.Command.html#helpCommand--"><code>helpCommand</code></a>
@@ -135,7 +139,7 @@ var activeTableTab = "activeTableTab";
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -144,9 +148,9 @@ var activeTableTab = "activeTableTab";
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IHelpCommandInitializable.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.io.PrintStream&nbsp;out,
java.io.PrintStream&nbsp;err)</code>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
@@ -170,10 +174,12 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
java.io.PrintStream&nbsp;out,
java.io.PrintStream&nbsp;err)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;err)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -213,7 +219,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IHelpCommandInitializable.html" target="_top">Frames</a></li>

257
docs/apidocs/picocli/CommandLine.IHelpCommandInitializable2.html Normal file
View File

@@ -0,0 +1,257 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IHelpCommandInitializable2 (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IHelpCommandInitializable2 (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IHelpCommandInitializable2.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IHelpCommandInitializable2.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IHelpCommandInitializable2" class="title">Interface CommandLine.IHelpCommandInitializable2</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../picocli/CommandLine.HelpCommand.html" title="class in picocli">CommandLine.HelpCommand</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IHelpCommandInitializable2</span></pre>
<div class="block">Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
<p>The <a href="../picocli/CommandLine.html#executeHelpRequest-java.util.List-"><code>CommandLine::printHelpIfRequested</code></a> method calls the
<a href="../picocli/CommandLine.IHelpCommandInitializable2.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-"><code>init</code></a> method on commands marked as <a href="../picocli/CommandLine.Command.html#helpCommand--"><code>helpCommand</code></a>
before the help command's <code>run</code> or <code>call</code> method is called.</p>
<p><b>Implementation note:</b></p><p>
If an error occurs in the <code>run</code> or <code>call</code> method while processing the help request, it is recommended custom Help
commands throw a <a href="../picocli/CommandLine.ParameterException.html" title="class in picocli"><code>ParameterException</code></a> with a reference to the parent command.
The <a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli"><code>default ParameterException handler</code></a> will print the error message and the usage for the parent command.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IHelpCommandInitializable2.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;outWriter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;errWriter)</code>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;helpCommandLine,
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;outWriter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;errWriter)</pre>
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>helpCommandLine</code> - the <code>CommandLine</code> object associated with this help command. Implementors can use
this to walk the command hierarchy and get access to the help command's parent and sibling commands.</dd>
<dd><code>colorScheme</code> - the color scheme to use when printing help, including whether to use Ansi colors or not</dd>
<dd><code>outWriter</code> - the output writer to print the usage help message to</dd>
<dd><code>errWriter</code> - the error writer to print any diagnostic messages to, in addition to the output from the exception handler</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IHelpCommandInitializable2.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IHelpCommandInitializable2.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

12
docs/apidocs/picocli/CommandLine.IHelpFactory.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IHelpFactory (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IHelpFactory (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IHelpFactory (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IHelpFactory (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
@@ -195,7 +195,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">

12
docs/apidocs/picocli/CommandLine.IHelpSectionRenderer.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IHelpSectionRenderer (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IHelpSectionRenderer (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IHelpSectionRenderer (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IHelpSectionRenderer (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -138,7 +138,7 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IHelpSectionRenderer.html#render-picocli.CommandLine.Help-">render</a></span>(<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;help)</code>
<div class="block">Renders a section of the usage help, like header heading, header, synopsis heading,
synopsis, description heading, description, etc.</div>
@@ -165,7 +165,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>render</h4>
<pre>java.lang.String&nbsp;render(<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;help)</pre>
<pre><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>&nbsp;render(<a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a>&nbsp;help)</pre>
<div class="block">Renders a section of the usage help, like header heading, header, synopsis heading,
synopsis, description heading, description, etc.</div>
<dl>

255
docs/apidocs/picocli/CommandLine.IParameterExceptionHandler.html Normal file
View File

@@ -0,0 +1,255 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IParameterExceptionHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-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.IParameterExceptionHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IParameterExceptionHandler.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IParameterExceptionHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Interface CommandLine.IParameterExceptionHandler" class="title">Interface CommandLine.IParameterExceptionHandler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IParameterExceptionHandler</span></pre>
<div class="block">Classes implementing this interface know how to handle <code>ParameterExceptions</code> (usually from invalid user input).
<p><b>Implementation Requirements:</b></p>
<p>Implementors that need to print messages to the console should use the <a href="../picocli/CommandLine.html#getOut--">output</a> and <a href="../picocli/CommandLine.html#getErr--">error</a> PrintWriters,
and the <a href="../picocli/CommandLine.html#getColorScheme--">color scheme</a> from the CommandLine object obtained from the exception.</p>
<p><b>Implementation Note:</b></p>
<p>See <a href="../picocli/CommandLine.html#getParameterExceptionHandler--"><code>CommandLine.getParameterExceptionHandler()</code></a> for a description of the default handler.</p>
<p><b>API Note:</b></p>
<p>This interface supersedes <a href="../picocli/CommandLine.IExceptionHandler2.html" title="interface in picocli"><code>CommandLine.IExceptionHandler2</code></a>.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../picocli/CommandLine.html#setParameterExceptionHandler-picocli.CommandLine.IParameterExceptionHandler-"><code>CommandLine.setParameterExceptionHandler(IParameterExceptionHandler)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IParameterExceptionHandler.html#handleParseException-picocli.CommandLine.ParameterException-java.lang.String:A-">handleParseException</a></span>(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
<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>[]&nbsp;args)</code>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command
line arguments and returns an exit code suitable for returning from <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="handleParseException-picocli.CommandLine.ParameterException-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleParseException</h4>
<pre>int&nbsp;handleParseException(<a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a>&nbsp;ex,
<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>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Handles a <code>ParameterException</code> that occurred while <a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command
line arguments and returns an exit code suitable for returning from <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - the ParameterException describing the problem that occurred while parsing the command line arguments,
and the CommandLine representing the command or subcommand whose input was invalid</dd>
<dd><code>args</code> - the command line arguments that could not be parsed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an exit code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.IParameterExceptionHandler.html" target="_top">Frames</a></li>
<li><a href="CommandLine.IParameterExceptionHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

30
docs/apidocs/picocli/CommandLine.IParseResultHandler.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IParseResultHandler (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IParseResultHandler (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IParseResultHandler (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IParseResultHandler (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
@@ -108,10 +108,10 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><code>CommandLine.IParseResultHandler2</code></a> instead.</span></div>
<div class="block"><span class="deprecationComment">Use <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><code>CommandLine.IExecutionStrategy</code></a> instead.</span></div>
</div>
<br>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static interface <span class="typeNameLabel">CommandLine.IParseResultHandler</span></pre>
<div class="block">Represents a function that can process a List of <code>CommandLine</code> objects resulting from successfully
<a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments. This is a
@@ -148,9 +148,9 @@ public static interface <span class="typeNameLabel">CommandLine.IParseResultHand
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IParseResultHandler.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IParseResultHandler.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes a List of <code>CommandLine</code> objects resulting from successfully
@@ -178,10 +178,10 @@ public static interface <span class="typeNameLabel">CommandLine.IParseResultHand
<ul class="blockListLast">
<li class="blockList">
<h4>handleParseResult</h4>
<pre>java.util.List&lt;java.lang.Object&gt;&nbsp;handleParseResult(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleParseResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes a List of <code>CommandLine</code> objects resulting from successfully
<a href="../picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments and optionally returns a list of results.</div>
@@ -227,7 +227,7 @@ public static interface <span class="typeNameLabel">CommandLine.IParseResultHand
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">

22
docs/apidocs/picocli/CommandLine.IParseResultHandler2.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IParseResultHandler2 (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IParseResultHandler2 (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,14 +12,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IParseResultHandler2 (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IParseResultHandler2 (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var methods = {"i0":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -111,8 +111,12 @@ var activeTableTab = "activeTableTab";
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli"><code>CommandLine.IExecutionStrategy</code></a> instead, see <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></span></div>
</div>
<br>
<pre>public static interface <span class="typeNameLabel">CommandLine.IParseResultHandler2&lt;R&gt;</span></pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static interface <span class="typeNameLabel">CommandLine.IParseResultHandler2&lt;R&gt;</span></pre>
<div class="block">Represents a function that can process the <code>ParseResult</code> object resulting from successfully
<a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command line arguments. This is a
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html">functional interface</a>
@@ -146,7 +150,7 @@ var activeTableTab = "activeTableTab";
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -154,6 +158,7 @@ var activeTableTab = "activeTableTab";
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.IParseResultHandler2.html" title="type parameter in CommandLine.IParseResultHandler2">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IParseResultHandler2.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes the <code>ParseResult</code> object resulting from successfully
<a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command line arguments and returns a return value.</div>
</td>
@@ -181,6 +186,7 @@ var activeTableTab = "activeTableTab";
<h4>handleParseResult</h4>
<pre><a href="../picocli/CommandLine.IParseResultHandler2.html" title="type parameter in CommandLine.IParseResultHandler2">R</a>&nbsp;handleParseResult(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Processes the <code>ParseResult</code> object resulting from successfully
<a href="../picocli/CommandLine.html#parseArgs-java.lang.String...-">parsing</a> the command line arguments and returns a return value.</div>
<dl>

16
docs/apidocs/picocli/CommandLine.ITypeConverter.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ITypeConverter (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.ITypeConverter (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ITypeConverter (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ITypeConverter (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -164,7 +164,7 @@ var activeTableTab = "activeTableTab";
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.ITypeConverter.html" title="type parameter in CommandLine.ITypeConverter">K</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ITypeConverter.html#convert-java.lang.String-">convert</a></span>(java.lang.String&nbsp;value)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ITypeConverter.html#convert-java.lang.String-">convert</a></span>(<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>&nbsp;value)</code>
<div class="block">Converts the specified command line argument value to some domain object.</div>
</td>
</tr>
@@ -189,8 +189,8 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>convert</h4>
<pre><a href="../picocli/CommandLine.ITypeConverter.html" title="type parameter in CommandLine.ITypeConverter">K</a>&nbsp;convert(java.lang.String&nbsp;value)
throws java.lang.Exception</pre>
<pre><a href="../picocli/CommandLine.ITypeConverter.html" title="type parameter in CommandLine.ITypeConverter">K</a>&nbsp;convert(<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>&nbsp;value)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Converts the specified command line argument value to some domain object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -198,7 +198,7 @@ var activeTableTab = "activeTableTab";
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resulting domain object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - an exception detailing what went wrong during the conversion</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - an exception detailing what went wrong during the conversion</dd>
</dl>
</li>
</ul>

16
docs/apidocs/picocli/CommandLine.IVersionProvider.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.IVersionProvider (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.IVersionProvider (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.IVersionProvider (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.IVersionProvider (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -130,7 +130,7 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.IVersionProvider.html#getVersion--">getVersion</a></span>()</code>
<div class="block">Returns version information for a command.</div>
</td>
@@ -156,14 +156,14 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>getVersion</h4>
<pre>java.lang.String[]&nbsp;getVersion()
throws java.lang.Exception</pre>
<pre><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>[]&nbsp;getVersion()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns version information for a command.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>version information (each string in the array is displayed on a separate line)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - an exception detailing what went wrong when obtaining version information</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - an exception detailing what went wrong when obtaining version information</dd>
</dl>
</li>
</ul>

42
docs/apidocs/picocli/CommandLine.InitializationException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.InitializationException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.InitializationException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.InitializationException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.InitializationException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -43,7 +43,7 @@
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.InitializationException.html" target="_top">Frames</a></li>
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -122,7 +122,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
@@ -161,11 +161,11 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.InitializationException.html#InitializationException-java.lang.String-">InitializationException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.InitializationException.html#InitializationException-java.lang.String-">InitializationException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.InitializationException.html#InitializationException-java.lang.String-java.lang.Exception-">InitializationException</a></span>(java.lang.String&nbsp;msg,
java.lang.Exception&nbsp;ex)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.InitializationException.html#InitializationException-java.lang.String-java.lang.Exception-">InitializationException</a></span>(<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;ex)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -180,15 +180,15 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -210,7 +210,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<ul class="blockList">
<li class="blockList">
<h4>InitializationException</h4>
<pre>public&nbsp;InitializationException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;InitializationException(<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>&nbsp;msg)</pre>
</li>
</ul>
<a name="InitializationException-java.lang.String-java.lang.Exception-">
@@ -219,8 +219,8 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<ul class="blockListLast">
<li class="blockList">
<h4>InitializationException</h4>
<pre>public&nbsp;InitializationException(java.lang.String&nbsp;msg,
java.lang.Exception&nbsp;ex)</pre>
<pre>public&nbsp;InitializationException(<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;ex)</pre>
</li>
</ul>
</li>
@@ -251,7 +251,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../picocli/CommandLine.IParameterExceptionHandler.html" title="interface in picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.InitializationException.html" target="_top">Frames</a></li>

30
docs/apidocs/picocli/CommandLine.MaxValuesExceededException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.MaxValuesExceededException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.MaxValuesExceededException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.MaxValuesExceededException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.MaxValuesExceededException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -127,7 +127,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -161,7 +161,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MaxValuesExceededException.html#MaxValuesExceededException-picocli.CommandLine-java.lang.String-">MaxValuesExceededException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -183,15 +183,15 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -214,7 +214,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList">
<h4>MaxValuesExceededException</h4>
<pre>public&nbsp;MaxValuesExceededException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

42
docs/apidocs/picocli/CommandLine.MissingParameterException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.MissingParameterException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.MissingParameterException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.MissingParameterException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.MissingParameterException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,16 +96,16 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -133,7 +133,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -167,13 +167,13 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MissingParameterException.html#MissingParameterException-picocli.CommandLine-java.util.Collection-java.lang.String-">MissingParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;missing,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;missing,
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MissingParameterException.html#MissingParameterException-picocli.CommandLine-picocli.CommandLine.Model.ArgSpec-java.lang.String-">MissingParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;missing,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -191,7 +191,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MissingParameterException.html#getMissing--">getMissing</a></span>()</code>&nbsp;</td>
</tr>
</table>
@@ -206,15 +206,15 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -238,7 +238,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<h4>MissingParameterException</h4>
<pre>public&nbsp;MissingParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;missing,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
<a name="MissingParameterException-picocli.CommandLine-java.util.Collection-java.lang.String-">
@@ -248,8 +248,8 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList">
<h4>MissingParameterException</h4>
<pre>public&nbsp;MissingParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.util.Collection&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;missing,
java.lang.String&nbsp;msg)</pre>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;missing,
<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>&nbsp;msg)</pre>
</li>
</ul>
</li>
@@ -266,7 +266,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<ul class="blockListLast">
<li class="blockList">
<h4>getMissing</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;getMissing()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;getMissing()</pre>
</li>
</ul>
</li>

30
docs/apidocs/picocli/CommandLine.MissingTypeConverterException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.MissingTypeConverterException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.MissingTypeConverterException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.MissingTypeConverterException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.MissingTypeConverterException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -127,7 +127,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -162,7 +162,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MissingTypeConverterException.html#MissingTypeConverterException-picocli.CommandLine-java.lang.String-">MissingTypeConverterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -184,15 +184,15 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -215,7 +215,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList">
<h4>MissingTypeConverterException</h4>
<pre>public&nbsp;MissingTypeConverterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

16
docs/apidocs/picocli/CommandLine.Mixin.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Mixin (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Mixin (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Mixin (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Mixin (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,PARAMETER})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
public static @interface <span class="memberNameLabel">CommandLine.Mixin</span></pre>
<div class="block"><p>
Fields annotated with <code>@Mixin</code> are "expanded" into the current command: <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>@Option</code></a> and
@@ -148,7 +148,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Mixin</span><
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Mixin.html#name--">name</a></span></code>
<div class="block">Optionally specify a name that the mixin object can be retrieved with from the <code>CommandSpec</code>.</div>
</td>
@@ -174,7 +174,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Mixin</span><
<ul class="blockListLast">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<pre>public abstract&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>&nbsp;name</pre>
<div class="block">Optionally specify a name that the mixin object can be retrieved with from the <code>CommandSpec</code>.
If not specified the name of the annotated field is used.</div>
<dl>

44
docs/apidocs/picocli/CommandLine.Model.ArgGroupSpec.Builder.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ArgGroupSpec.Builder (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.ArgGroupSpec.Builder (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ArgGroupSpec.Builder (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ArgGroupSpec.Builder (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.ArgGroupSpec.Builder</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.ArgGroupSpec.Builder</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builder responsible for creating valid <code>ArgGroupSpec</code> objects.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -150,7 +150,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#args--">args</a></span>()</code>
<div class="block">Returns the list of options and positional parameters that depend on this group.</div>
</td>
@@ -186,26 +186,26 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#heading--">heading</a></span>()</code>
<div class="block">Returns the heading of this group, used when generating the usage documentation.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#heading-java.lang.String-">heading</a></span>(java.lang.String&nbsp;newValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#heading-java.lang.String-">heading</a></span>(<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>&nbsp;newValue)</code>
<div class="block">Sets the heading of this group (may be <code>null</code>), used when generating the usage documentation.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#headingKey--">headingKey</a></span>()</code>
<div class="block">Returns the heading key of this group, used to get the heading from a resource bundle.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#headingKey-java.lang.String-">headingKey</a></span>(java.lang.String&nbsp;newValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#headingKey-java.lang.String-">headingKey</a></span>(<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>&nbsp;newValue)</code>
<div class="block">Sets the heading key of this group, used to get the heading from a resource bundle.</div>
</td>
</tr>
@@ -223,7 +223,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#multiplicity-java.lang.String-">multiplicity</a></span>(java.lang.String&nbsp;newValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#multiplicity-java.lang.String-">multiplicity</a></span>(<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>&nbsp;newValue)</code>
<div class="block">Sets the multiplicity of this group: how many occurrences it may have on the command line; <code>"0..1"</code> (optional) by default.</div>
</td>
</tr>
@@ -264,7 +264,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html#subgroups--">subgroups</a></span>()</code>
<div class="block">Returns the list of subgroups that this group is composed of.</div>
</td>
@@ -308,8 +308,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -405,7 +405,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>multiplicity</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;multiplicity(java.lang.String&nbsp;newValue)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;multiplicity(<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>&nbsp;newValue)</pre>
<div class="block">Sets the multiplicity of this group: how many occurrences it may have on the command line; <code>"0..1"</code> (optional) by default.
A group can be made required by specifying a multiplicity of <code>"1"</code>. For a group of mutually exclusive arguments,
being required means that one of the arguments in the group must appear on the command line, or a MissingParameterException is thrown.
@@ -497,7 +497,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>heading</h4>
<pre>public&nbsp;java.lang.String&nbsp;heading()</pre>
<pre>public&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>&nbsp;heading()</pre>
<div class="block">Returns the heading of this group, used when generating the usage documentation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -511,7 +511,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>heading</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;heading(java.lang.String&nbsp;newValue)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;heading(<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>&nbsp;newValue)</pre>
<div class="block">Sets the heading of this group (may be <code>null</code>), used when generating the usage documentation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -525,7 +525,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>headingKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;headingKey()</pre>
<pre>public&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>&nbsp;headingKey()</pre>
<div class="block">Returns the heading key of this group, used to get the heading from a resource bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -539,7 +539,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>headingKey</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;headingKey(java.lang.String&nbsp;newValue)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ArgGroupSpec.Builder.html" title="class in picocli">CommandLine.Model.ArgGroupSpec.Builder</a>&nbsp;headingKey(<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>&nbsp;newValue)</pre>
<div class="block">Sets the heading key of this group, used to get the heading from a resource bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -651,7 +651,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>args</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;args()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;args()</pre>
<div class="block">Returns the list of options and positional parameters that depend on this group.</div>
</li>
</ul>
@@ -671,7 +671,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>subgroups</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;&nbsp;subgroups()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;&nbsp;subgroups()</pre>
<div class="block">Returns the list of subgroups that this group is composed of.</div>
</li>
</ul>

62
docs/apidocs/picocli/CommandLine.Model.ArgGroupSpec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ArgGroupSpec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.ArgGroupSpec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ArgGroupSpec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ArgGroupSpec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.ArgGroupSpec</li>
@@ -117,7 +117,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.ArgGroupSpec</span>
extends java.lang.Object
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface in picocli">CommandLine.Model.IOrdered</a></pre>
<div class="block">The <code>ArgGroupSpec</code> class models a <a href="../picocli/CommandLine.ArgGroup.html" title="annotation in picocli"><code>group</code></a> of arguments (options, positional parameters or a mixture of the two).</div>
<dl>
@@ -166,7 +166,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#args--">args</a></span>()</code>
<div class="block">Returns the options and positional parameters in this group; may be empty but not <code>null</code>.</div>
</td>
@@ -189,7 +189,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
@@ -208,13 +208,13 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#heading--">heading</a></span>()</code>
<div class="block">Returns the heading of this group (may be <code>null</code>), used when generating the usage documentation.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#headingKey--">headingKey</a></span>()</code>
<div class="block">Returns the heading key of this group (may be <code>null</code>), used to get the heading from a resource bundle.</div>
</td>
@@ -245,7 +245,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#options--">options</a></span>()</code>
<div class="block">Returns the list of options configured for this group.</div>
</td>
@@ -263,13 +263,13 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#positionalParameters--">positionalParameters</a></span>()</code>
<div class="block">Returns the list of positional parameters configured for this group.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#requiredArgs--">requiredArgs</a></span>()</code>
<div class="block">Returns the required options and positional parameters in this group; may be empty but not <code>null</code>.</div>
</td>
@@ -287,13 +287,13 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#subgroups--">subgroups</a></span>()</code>
<div class="block">Return the subgroups that this group is composed of; may be empty but not <code>null</code>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#synopsis--">synopsis</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
@@ -301,7 +301,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#synopsisText-picocli.CommandLine.Help.ColorScheme-">synopsisText</a></span>(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a>&nbsp;colorScheme)</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgGroupSpec.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
@@ -323,8 +323,8 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -442,7 +442,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>heading</h4>
<pre>public&nbsp;java.lang.String&nbsp;heading()</pre>
<pre>public&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>&nbsp;heading()</pre>
<div class="block">Returns the heading of this group (may be <code>null</code>), used when generating the usage documentation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -456,7 +456,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>headingKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;headingKey()</pre>
<pre>public&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>&nbsp;headingKey()</pre>
<div class="block">Returns the heading key of this group (may be <code>null</code>), used to get the heading from a resource bundle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -480,7 +480,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>subgroups</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;&nbsp;subgroups()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&gt;&nbsp;subgroups()</pre>
<div class="block">Return the subgroups that this group is composed of; may be empty but not <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -555,7 +555,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>args</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;args()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;args()</pre>
<div class="block">Returns the options and positional parameters in this group; may be empty but not <code>null</code>.</div>
</li>
</ul>
@@ -565,7 +565,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>requiredArgs</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;requiredArgs()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&gt;&nbsp;requiredArgs()</pre>
<div class="block">Returns the required options and positional parameters in this group; may be empty but not <code>null</code>.</div>
</li>
</ul>
@@ -575,7 +575,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>positionalParameters</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;positionalParameters()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;positionalParameters()</pre>
<div class="block">Returns the list of positional parameters configured for this group.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -589,7 +589,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;options()</pre>
<div class="block">Returns the list of options configured for this group.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -603,7 +603,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>synopsis</h4>
<pre>public&nbsp;java.lang.String&nbsp;synopsis()</pre>
<pre>public&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>&nbsp;synopsis()</pre>
</li>
</ul>
<a name="synopsisText-picocli.CommandLine.Help.ColorScheme-">
@@ -657,10 +657,10 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -673,7 +673,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -683,10 +683,10 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

98
docs/apidocs/picocli/CommandLine.Model.ArgSpec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ArgSpec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.ArgSpec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ArgSpec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ArgSpec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.ArgSpec</li>
@@ -117,7 +117,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public abstract static class <span class="typeNameLabel">CommandLine.Model.ArgSpec</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Models the shared attributes of <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>CommandLine.Model.OptionSpec</code></a> and <a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli"><code>CommandLine.Model.PositionalParamSpec</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -142,7 +142,7 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colFirst"><code>protected <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#toString">toString</a></span></code>&nbsp;</td>
</tr>
</table>
@@ -167,13 +167,13 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#auxiliaryTypes--">auxiliaryTypes</a></span>()</code>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.ArgSpec.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#completionCandidates--">completionCandidates</a></span>()</code>
<div class="block">Returns the explicitly set completion candidates for this option or positional parameter, valid enum
constant names, or <code>null</code> if this option or positional parameter does not have any completion
@@ -188,26 +188,26 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#defaultValue--">defaultValue</a></span>()</code>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#defaultValueString--">defaultValueString</a></span>()</code>
<div class="block">Returns the default value String displayed in the description.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#description--">description</a></span>()</code>
<div class="block">Returns the description of this option or positional parameter, after all variables have been rendered,
including the <code>${DEFAULT-VALUE}</code> and <code>${COMPLETION-CANDIDATES}</code> variables.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#descriptionKey--">descriptionKey</a></span>()</code>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
</td>
@@ -217,7 +217,7 @@ extends java.lang.Object</pre>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#equalsImpl-picocli.CommandLine.Model.ArgSpec-">equalsImpl</a></span>(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;other)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected abstract java.util.Collection&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#getAdditionalDescriptionKeys--">getAdditionalDescriptionKeys</a></span>()</code>
<div class="block">Subclasses should override to return a collection of additional description keys that may be used to find
description text for this option or positional parameter in the resource bundle.</div>
@@ -265,7 +265,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#initialValue--">initialValue</a></span>()</code>
<div class="block">Returns the initial value this option or positional parameter.</div>
</td>
@@ -313,19 +313,19 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#originalStringValues--">originalStringValues</a></span>()</code>
<div class="block">Returns the original command line arguments matched by this option or positional parameter spec.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#paramLabel--">paramLabel</a></span>()</code>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#renderedDescription--">renderedDescription</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../picocli/CommandLine.Model.ArgSpec.html#description--"><code>description()</code></a> instead</span></div>
@@ -335,7 +335,7 @@ extends java.lang.Object</pre>
<tr id="i28" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#required--">required</a></span>()</code>
<div class="block">Returns whether this is a required option or positional parameter.</div>
<div class="block">Returns whether this is a required option or positional parameter without a default value.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
@@ -384,31 +384,31 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#splitRegex--">splitRegex</a></span>()</code>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#stringValues--">stringValues</a></span>()</code>
<div class="block">Returns the untyped command line arguments matched by this option or positional parameter spec.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string respresentation of this option or positional parameter.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#type--">type</a></span>()</code>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#typedValues--">typedValues</a></span>()</code>
<div class="block">Returns the typed command line arguments matched by this option or positional parameter spec.</div>
</td>
@@ -420,7 +420,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ArgSpec.html#userObject--">userObject</a></span>()</code>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
</td>
@@ -430,8 +430,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -453,7 +453,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>protected&nbsp;java.lang.String toString</pre>
<pre>protected&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> toString</pre>
</li>
</ul>
</li>
@@ -471,7 +471,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>required</h4>
<pre>public&nbsp;boolean&nbsp;required()</pre>
<div class="block">Returns whether this is a required option or positional parameter.
<div class="block">Returns whether this is a required option or positional parameter without a default value.
If this argument is part of a <a href="../picocli/CommandLine.ArgGroup.html" title="annotation in picocli">group</a>, this method returns whether this argument is required <em>within the group</em> (so it is not necessarily a required argument for the command).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -499,7 +499,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;description()</pre>
<pre>public&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>[]&nbsp;description()</pre>
<div class="block">Returns the description of this option or positional parameter, after all variables have been rendered,
including the <code>${DEFAULT-VALUE}</code> and <code>${COMPLETION-CANDIDATES}</code> variables.
Use <a href="../picocli/CommandLine.Model.CommandSpec.html#interpolateVariables-java.lang.Boolean-"><code>CommandLine.Model.CommandSpec.interpolateVariables(Boolean)</code></a> to switch off variable expansion if needed.
@@ -524,7 +524,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalDescriptionKeys</h4>
<pre>protected abstract&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<pre>protected abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<div class="block">Subclasses should override to return a collection of additional description keys that may be used to find
description text for this option or positional parameter in the resource bundle.</div>
<dl>
@@ -542,7 +542,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;descriptionKey()</pre>
<pre>public&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>&nbsp;descriptionKey()</pre>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -559,8 +559,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>renderedDescription</h4>
<pre>@Deprecated
public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&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>[]&nbsp;renderedDescription()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../picocli/CommandLine.Model.ArgSpec.html#description--"><code>description()</code></a> instead</span></div>
</li>
</ul>
@@ -584,7 +584,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public&nbsp;java.lang.String&nbsp;paramLabel()</pre>
<pre>public&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>&nbsp;paramLabel()</pre>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -614,7 +614,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>auxiliaryTypes</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.ArgSpec.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -644,7 +644,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>splitRegex</h4>
<pre>public&nbsp;java.lang.String&nbsp;splitRegex()</pre>
<pre>public&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>&nbsp;splitRegex()</pre>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -672,7 +672,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;&nbsp;type()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type()</pre>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</li>
</ul>
@@ -696,7 +696,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>public&nbsp;java.lang.Object&nbsp;userObject()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject()</pre>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -712,7 +712,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;defaultValue()</pre>
<pre>public&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>&nbsp;defaultValue()</pre>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.
This method returns the programmatically set value; this may differ from the default value that is actually used:
if this ArgSpec is part of a CommandSpec with a <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><code>CommandLine.IDefaultValueProvider</code></a>, picocli will first try to obtain
@@ -733,7 +733,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;initialValue()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue()</pre>
<div class="block">Returns the initial value this option or positional parameter. If <a href="../picocli/CommandLine.Model.ArgSpec.html#hasInitialValue--"><code>hasInitialValue()</code></a> is true,
the option will be reset to the initial value before parsing (regardless of whether a default value exists),
to clear values that would otherwise remain from parsing previous input.</div>
@@ -766,7 +766,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValueString</h4>
<pre>public&nbsp;java.lang.String&nbsp;defaultValueString()</pre>
<pre>public&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>&nbsp;defaultValueString()</pre>
<div class="block">Returns the default value String displayed in the description. If this ArgSpec is part of a
CommandSpec with a <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><code>CommandLine.IDefaultValueProvider</code></a>, this method will first try to obtain
the default value from the default value provider; if the provider is <code>null</code> or if it
@@ -785,7 +785,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public&nbsp;java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates()</pre>
<div class="block">Returns the explicitly set completion candidates for this option or positional parameter, valid enum
constant names, or <code>null</code> if this option or positional parameter does not have any completion
candidates and its type is not an enum.</div>
@@ -868,7 +868,7 @@ public&nbsp;java.lang.String[]&nbsp;renderedDescription()</pre>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;&lt;T&gt;&nbsp;T&nbsp;setValue(T&nbsp;newValue,
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine)
throws <a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">CommandLine.PicocliException</a></pre>
@@ -932,7 +932,7 @@ public&nbsp;&lt;T&gt;&nbsp;T&nbsp;setValue(T&nbsp;newValue,
<ul class="blockList">
<li class="blockList">
<h4>stringValues</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;stringValues()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;stringValues()</pre>
<div class="block">Returns the untyped command line arguments matched by this option or positional parameter spec.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -947,7 +947,7 @@ public&nbsp;&lt;T&gt;&nbsp;T&nbsp;setValue(T&nbsp;newValue,
<ul class="blockList">
<li class="blockList">
<h4>typedValues</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;typedValues()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;typedValues()</pre>
<div class="block">Returns the typed command line arguments matched by this option or positional parameter spec.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -972,7 +972,7 @@ public&nbsp;&lt;T&gt;&nbsp;T&nbsp;setValue(T&nbsp;newValue,
<ul class="blockList">
<li class="blockList">
<h4>originalStringValues</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;originalStringValues()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;originalStringValues()</pre>
<div class="block">Returns the original command line arguments matched by this option or positional parameter spec.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1045,11 +1045,11 @@ public&nbsp;&lt;T&gt;&nbsp;T&nbsp;setValue(T&nbsp;newValue,
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<div class="block">Returns a string respresentation of this option or positional parameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

508
docs/apidocs/picocli/CommandLine.Model.CommandSpec.html
View File

File diff suppressed because it is too large Load Diff

34
docs/apidocs/picocli/CommandLine.Model.IAnnotatedElement.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.IAnnotatedElement (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.IAnnotatedElement (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.IAnnotatedElement (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.IAnnotatedElement (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -129,19 +129,19 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;T extends java.lang.annotation.Annotation&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(java.lang.Class&lt;T&gt;&nbsp;annotationClass)</code>&nbsp;</td>
<td class="colFirst"><code>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;annotationClass)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getMethodParamPosition--">getMethodParamPosition</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getMixinName--">getMixinName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
@@ -149,7 +149,7 @@ var activeTableTab = "activeTableTab";
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getter--">getter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#getToString--">getToString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
@@ -162,7 +162,7 @@ var activeTableTab = "activeTableTab";
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#isAnnotationPresent-java.lang.Class-">isAnnotationPresent</a></span>(java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;&nbsp;annotationClass)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#isAnnotationPresent-java.lang.Class-">isAnnotationPresent</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;annotationClass)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
@@ -213,7 +213,7 @@ var activeTableTab = "activeTableTab";
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#setter--">setter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.IAnnotatedElement.html#userObject--">userObject</a></span>()</code>&nbsp;</td>
</tr>
</table>
@@ -237,7 +237,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>java.lang.Object&nbsp;userObject()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject()</pre>
</li>
</ul>
<a name="isAnnotationPresent-java.lang.Class-">
@@ -246,7 +246,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>isAnnotationPresent</h4>
<pre>boolean&nbsp;isAnnotationPresent(java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;&nbsp;annotationClass)</pre>
<pre>boolean&nbsp;isAnnotationPresent(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;annotationClass)</pre>
</li>
</ul>
<a name="getAnnotation-java.lang.Class-">
@@ -255,7 +255,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getAnnotation</h4>
<pre>&lt;T extends java.lang.annotation.Annotation&gt;&nbsp;T&nbsp;getAnnotation(java.lang.Class&lt;T&gt;&nbsp;annotationClass)</pre>
<pre>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;T&nbsp;getAnnotation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;annotationClass)</pre>
</li>
</ul>
<a name="getName--">
@@ -264,7 +264,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<pre><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>&nbsp;getName()</pre>
</li>
</ul>
<a name="getMixinName--">
@@ -273,7 +273,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getMixinName</h4>
<pre>java.lang.String&nbsp;getMixinName()</pre>
<pre><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>&nbsp;getMixinName()</pre>
</li>
</ul>
<a name="isArgSpec--">
@@ -426,7 +426,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>getToString</h4>
<pre>java.lang.String&nbsp;getToString()</pre>
<pre><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>&nbsp;getToString()</pre>
</li>
</ul>
</li>

12
docs/apidocs/picocli/CommandLine.Model.IGetter.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.IGetter (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.IGetter (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.IGetter (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.IGetter (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -163,13 +163,13 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<h4>get</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;get()
throws java.lang.Exception</pre>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the current value of the binding. For multi-value options and positional parameters,
this method returns an array, collection or map to add values to.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">CommandLine.PicocliException</a></code> - if a problem occurred while obtaining the current value</dd>
<dd><code>java.lang.Exception</code> - internally, picocli call sites will catch any exceptions thrown from here and rethrow them wrapped in a PicocliException</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - internally, picocli call sites will catch any exceptions thrown from here and rethrow them wrapped in a PicocliException</dd>
</dl>
</li>
</ul>

8
docs/apidocs/picocli/CommandLine.Model.IOrdered.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.IOrdered (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.IOrdered (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.IOrdered (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.IOrdered (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {

8
docs/apidocs/picocli/CommandLine.Model.IScope.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.IScope (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model.IScope (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.IScope (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.IScope (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {

12
docs/apidocs/picocli/CommandLine.Model.ISetter.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ISetter (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:49 JST 2019 -->
<title>CommandLine.Model.ISetter (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ISetter (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ISetter (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -165,7 +165,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<h4>set</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;set(T&nbsp;value)
throws java.lang.Exception</pre>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Sets the new value of the option or positional parameter.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
@@ -176,7 +176,7 @@ var activeTableTab = "activeTableTab";
<dd>the previous value of the binding (if supported by this binding)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">CommandLine.PicocliException</a></code> - if a problem occurred while setting the new value</dd>
<dd><code>java.lang.Exception</code> - internally, picocli call sites will catch any exceptions thrown from here and rethrow them wrapped in a PicocliException</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - internally, picocli call sites will catch any exceptions thrown from here and rethrow them wrapped in a PicocliException</dd>
</dl>
</li>
</ul>

36
docs/apidocs/picocli/CommandLine.Model.ITypeInfo.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ITypeInfo (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:49 JST 2019 -->
<title>CommandLine.Model.ITypeInfo (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ITypeInfo (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ITypeInfo (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -131,38 +131,38 @@ var activeTableTab = "activeTableTab";
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getActualGenericTypeArguments--">getActualGenericTypeArguments</a></span>()</code>
<div class="block">Returns the names of the type arguments if this is a generic type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.ITypeInfo.html" title="interface in picocli">CommandLine.Model.ITypeInfo</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ITypeInfo.html" title="interface in picocli">CommandLine.Model.ITypeInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getAuxiliaryTypeInfos--">getAuxiliaryTypeInfos</a></span>()</code>
<div class="block">Returns type information of components or elements of a <a href="../picocli/CommandLine.Model.ITypeInfo.html#isMultiValue--"><code>multivalue</code></a> type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getAuxiliaryTypes--">getAuxiliaryTypes</a></span>()</code>
<div class="block">Returns the component class of an array, or the parameter type of a generic Collection, or the parameter
types of the key and the value of a generic Map.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getClassName--">getClassName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getClassSimpleName--">getClassSimpleName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getEnumConstantNames--">getEnumConstantNames</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ITypeInfo.html#getType--">getType</a></span>()</code>
<div class="block">Returns the class that the option or parameter value should be converted to when matched on the command
line.</div>
@@ -276,7 +276,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getEnumConstantNames</h4>
<pre>java.util.List&lt;java.lang.String&gt;&nbsp;getEnumConstantNames()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;getEnumConstantNames()</pre>
</li>
</ul>
<a name="getClassName--">
@@ -285,7 +285,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getClassName</h4>
<pre>java.lang.String&nbsp;getClassName()</pre>
<pre><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>&nbsp;getClassName()</pre>
</li>
</ul>
<a name="getClassSimpleName--">
@@ -294,7 +294,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getClassSimpleName</h4>
<pre>java.lang.String&nbsp;getClassSimpleName()</pre>
<pre><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>&nbsp;getClassSimpleName()</pre>
</li>
</ul>
<a name="getAuxiliaryTypeInfos--">
@@ -303,7 +303,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getAuxiliaryTypeInfos</h4>
<pre>java.util.List&lt;<a href="../picocli/CommandLine.Model.ITypeInfo.html" title="interface in picocli">CommandLine.Model.ITypeInfo</a>&gt;&nbsp;getAuxiliaryTypeInfos()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.ITypeInfo.html" title="interface in picocli">CommandLine.Model.ITypeInfo</a>&gt;&nbsp;getAuxiliaryTypeInfos()</pre>
<div class="block">Returns type information of components or elements of a <a href="../picocli/CommandLine.Model.ITypeInfo.html#isMultiValue--"><code>multivalue</code></a> type.</div>
</li>
</ul>
@@ -313,7 +313,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getActualGenericTypeArguments</h4>
<pre>java.util.List&lt;java.lang.String&gt;&nbsp;getActualGenericTypeArguments()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;getActualGenericTypeArguments()</pre>
<div class="block">Returns the names of the type arguments if this is a generic type. For example, returns <code>["java.lang.String"]</code> if this type is <code>List&lt;String&gt;</code>.</div>
</li>
</ul>
@@ -323,7 +323,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>java.lang.Class&lt;?&gt;&nbsp;getType()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getType()</pre>
<div class="block">Returns the class that the option or parameter value should be converted to when matched on the command
line. This method is <em>not</em> safe for annotation processors to use.</div>
<dl>
@@ -338,7 +338,7 @@ var activeTableTab = "activeTableTab";
<ul class="blockListLast">
<li class="blockList">
<h4>getAuxiliaryTypes</h4>
<pre>java.lang.Class&lt;?&gt;[]&nbsp;getAuxiliaryTypes()</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;getAuxiliaryTypes()</pre>
<div class="block">Returns the component class of an array, or the parameter type of a generic Collection, or the parameter
types of the key and the value of a generic Map.
This method is <em>not</em> safe for annotation processors to use.</div>

68
docs/apidocs/picocli/CommandLine.Model.Messages.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.Messages (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:49 JST 2019 -->
<title>CommandLine.Model.Messages (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.Messages (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.Messages (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.Messages</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.Messages</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utility class for getting resource bundle strings.
Enhances the standard <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html">ResourceBundle</a>
with support for String arrays and qualified keys: keys that may or may not be prefixed with the fully qualified command name.
@@ -193,16 +193,16 @@ extends java.lang.Object</pre>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#Messages-picocli.CommandLine.Model.CommandSpec-java.util.ResourceBundle-">Messages</a></span>(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.util.ResourceBundle&nbsp;rb)</code>&nbsp;</td>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;rb)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#Messages-picocli.CommandLine.Model.CommandSpec-java.lang.String-">Messages</a></span>(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String&nbsp;baseName)</code>&nbsp;</td>
<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>&nbsp;baseName)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#Messages-picocli.CommandLine.Model.CommandSpec-java.lang.String-java.util.ResourceBundle-">Messages</a></span>(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String&nbsp;baseName,
java.util.ResourceBundle&nbsp;rb)</code>&nbsp;</td>
<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>&nbsp;baseName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;rb)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -239,39 +239,39 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#getString-java.lang.String-java.lang.String-">getString</a></span>(java.lang.String&nbsp;key,
java.lang.String&nbsp;defaultValue)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#getString-java.lang.String-java.lang.String-">getString</a></span>(<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>&nbsp;key,
<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>&nbsp;defaultValue)</code>
<div class="block">Returns the String value found in the resource bundle for the specified key, or the specified default value if not found.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#getStringArray-java.lang.String-java.lang.String:A-">getStringArray</a></span>(java.lang.String&nbsp;key,
java.lang.String[]&nbsp;defaultValues)</code>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#getStringArray-java.lang.String-java.lang.String:A-">getStringArray</a></span>(<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>&nbsp;key,
<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>[]&nbsp;defaultValues)</code>
<div class="block">Returns the String array value found in the resource bundle for the specified key, or the specified default value if not found.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.ResourceBundle</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#resourceBundle--">resourceBundle</a></span>()</code>
<div class="block">Returns the ResourceBundle of this object or <code>null</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.util.ResourceBundle</code></td>
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#resourceBundle-picocli.CommandLine.Model.Messages-">resourceBundle</a></span>(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</code>
<div class="block">Returns the ResourceBundle of the specified Messages object or <code>null</code> if the specified Messages object is <code>null</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#resourceBundleBaseName--">resourceBundleBaseName</a></span>()</code>
<div class="block">Returns the base name of the ResourceBundle of this object or <code>null</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colFirst"><code>static <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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.Messages.html#resourceBundleBaseName-picocli.CommandLine.Model.Messages-">resourceBundleBaseName</a></span>(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</code>
<div class="block">Returns the ResourceBundle of the specified Messages object or <code>null</code> if the specified Messages object is <code>null</code>.</div>
</td>
@@ -281,8 +281,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -305,7 +305,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>Messages</h4>
<pre>public&nbsp;Messages(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String&nbsp;baseName)</pre>
<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>&nbsp;baseName)</pre>
</li>
</ul>
<a name="Messages-picocli.CommandLine.Model.CommandSpec-java.util.ResourceBundle-">
@@ -315,7 +315,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>Messages</h4>
<pre>public&nbsp;Messages(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.util.ResourceBundle&nbsp;rb)</pre>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;rb)</pre>
</li>
</ul>
<a name="Messages-picocli.CommandLine.Model.CommandSpec-java.lang.String-java.util.ResourceBundle-">
@@ -325,8 +325,8 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>Messages</h4>
<pre>public&nbsp;Messages(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>&nbsp;spec,
java.lang.String&nbsp;baseName,
java.util.ResourceBundle&nbsp;rb)</pre>
<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>&nbsp;baseName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;rb)</pre>
</li>
</ul>
</li>
@@ -371,8 +371,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getString(java.lang.String&nbsp;key,
java.lang.String&nbsp;defaultValue)</pre>
<pre>public&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>&nbsp;getString(<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>&nbsp;key,
<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>&nbsp;defaultValue)</pre>
<div class="block">Returns the String value found in the resource bundle for the specified key, or the specified default value if not found.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -390,8 +390,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getStringArray</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getStringArray(java.lang.String&nbsp;key,
java.lang.String[]&nbsp;defaultValues)</pre>
<pre>public&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>[]&nbsp;getStringArray(<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>&nbsp;key,
<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>[]&nbsp;defaultValues)</pre>
<div class="block">Returns the String array value found in the resource bundle for the specified key, or the specified default value if not found.
Multi-line strings can be specified in the resource bundle with <code>key.0</code>, <code>key.1</code>, <code>key.2</code>, etc.</div>
<dl>
@@ -410,7 +410,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>resourceBundleBaseName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;resourceBundleBaseName(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</pre>
<pre>public static&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>&nbsp;resourceBundleBaseName(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</pre>
<div class="block">Returns the ResourceBundle of the specified Messages object or <code>null</code> if the specified Messages object is <code>null</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -424,7 +424,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>resourceBundle</h4>
<pre>public static&nbsp;java.util.ResourceBundle&nbsp;resourceBundle(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</pre>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;resourceBundle(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a>&nbsp;messages)</pre>
<div class="block">Returns the ResourceBundle of the specified Messages object or <code>null</code> if the specified Messages object is <code>null</code>.</div>
</li>
</ul>
@@ -434,7 +434,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>resourceBundleBaseName</h4>
<pre>public&nbsp;java.lang.String&nbsp;resourceBundleBaseName()</pre>
<pre>public&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>&nbsp;resourceBundleBaseName()</pre>
<div class="block">Returns the base name of the ResourceBundle of this object or <code>null</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -448,7 +448,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>resourceBundle</h4>
<pre>public&nbsp;java.util.ResourceBundle&nbsp;resourceBundle()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a>&nbsp;resourceBundle()</pre>
<div class="block">Returns the ResourceBundle of this object or <code>null</code>.</div>
</li>
</ul>

80
docs/apidocs/picocli/CommandLine.Model.MethodParam.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.MethodParam (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.MethodParam (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.MethodParam (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.MethodParam (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,10 +96,10 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.reflect.AccessibleObject</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">java.lang.reflect.AccessibleObject</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.MethodParam</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.reflect.AnnotatedElement</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.MethodParam</span>
extends java.lang.reflect.AccessibleObject</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></pre>
<div class="block">Command method parameter, similar to java.lang.reflect.Parameter (not available before Java 8).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -146,7 +146,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#MethodParam-java.lang.reflect.Method-int-">MethodParam</a></span>(java.lang.reflect.Method&nbsp;method,
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#MethodParam-java.lang.reflect.Method-int-">MethodParam</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>&nbsp;method,
int&nbsp;paramIndex)</code>&nbsp;</td>
</tr>
</table>
@@ -165,27 +165,27 @@ extends java.lang.reflect.AccessibleObject</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;T extends java.lang.annotation.Annotation&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(java.lang.Class&lt;T&gt;&nbsp;annotationClass)</code>&nbsp;</td>
<td class="colFirst"><code>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;annotationClass)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.annotation.Annotation[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getDeclaredAnnotations--">getDeclaredAnnotations</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.reflect.Method</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getDeclaringExecutable--">getDeclaringExecutable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.reflect.Type</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getParameterizedType--">getParameterizedType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#getType--">getType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
@@ -197,7 +197,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#setAccessible-boolean-">setAccessible</a></span>(boolean&nbsp;flag)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.MethodParam.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
@@ -205,15 +205,15 @@ extends java.lang.reflect.AccessibleObject</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.reflect.AccessibleObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.reflect.AccessibleObject</h3>
<code>getAnnotations, getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent, setAccessible</code></li>
<h3>Methods inherited from class&nbsp;java.lang.reflect.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getAnnotations--" title="class or interface in java.lang.reflect">getAnnotations</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getAnnotationsByType-java.lang.Class-" title="class or interface in java.lang.reflect">getAnnotationsByType</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getDeclaredAnnotation-java.lang.Class-" title="class or interface in java.lang.reflect">getDeclaredAnnotation</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getDeclaredAnnotationsByType-java.lang.Class-" title="class or interface in java.lang.reflect">getDeclaredAnnotationsByType</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#isAnnotationPresent-java.lang.Class-" title="class or interface in java.lang.reflect">isAnnotationPresent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-java.lang.reflect.AccessibleObject:A-boolean-" title="class or interface in java.lang.reflect">setAccessible</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -235,7 +235,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>MethodParam</h4>
<pre>public&nbsp;MethodParam(java.lang.reflect.Method&nbsp;method,
<pre>public&nbsp;MethodParam(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>&nbsp;method,
int&nbsp;paramIndex)</pre>
</li>
</ul>
@@ -253,7 +253,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getParameterizedType</h4>
<pre>public&nbsp;java.lang.reflect.Type&nbsp;getParameterizedType()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a>&nbsp;getParameterizedType()</pre>
</li>
</ul>
<a name="getName--">
@@ -262,7 +262,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
<pre>public&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>&nbsp;getName()</pre>
</li>
</ul>
<a name="getType--">
@@ -271,7 +271,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;&nbsp;getType()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;getType()</pre>
</li>
</ul>
<a name="getDeclaringExecutable--">
@@ -280,7 +280,7 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaringExecutable</h4>
<pre>public&nbsp;java.lang.reflect.Method&nbsp;getDeclaringExecutable()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>&nbsp;getDeclaringExecutable()</pre>
</li>
</ul>
<a name="getAnnotation-java.lang.Class-">
@@ -289,12 +289,12 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getAnnotation</h4>
<pre>public&nbsp;&lt;T extends java.lang.annotation.Annotation&gt;&nbsp;T&nbsp;getAnnotation(java.lang.Class&lt;T&gt;&nbsp;annotationClass)</pre>
<pre>public&nbsp;&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;T&nbsp;getAnnotation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;annotationClass)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAnnotation</code>&nbsp;in interface&nbsp;<code>java.lang.reflect.AnnotatedElement</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true#getAnnotation-java.lang.Class-" title="class or interface in java.lang.reflect">getAnnotation</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getAnnotation</code>&nbsp;in class&nbsp;<code>java.lang.reflect.AccessibleObject</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getAnnotation-java.lang.Class-" title="class or interface in java.lang.reflect">getAnnotation</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></code></dd>
</dl>
</li>
</ul>
@@ -304,12 +304,12 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredAnnotations</h4>
<pre>public&nbsp;java.lang.annotation.Annotation[]&nbsp;getDeclaredAnnotations()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>[]&nbsp;getDeclaredAnnotations()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDeclaredAnnotations</code>&nbsp;in interface&nbsp;<code>java.lang.reflect.AnnotatedElement</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true#getDeclaredAnnotations--" title="class or interface in java.lang.reflect">getDeclaredAnnotations</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedElement.html?is-external=true" title="class or interface in java.lang.reflect">AnnotatedElement</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getDeclaredAnnotations</code>&nbsp;in class&nbsp;<code>java.lang.reflect.AccessibleObject</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#getDeclaredAnnotations--" title="class or interface in java.lang.reflect">getDeclaredAnnotations</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></code></dd>
</dl>
</li>
</ul>
@@ -320,12 +320,12 @@ extends java.lang.reflect.AccessibleObject</pre>
<li class="blockList">
<h4>setAccessible</h4>
<pre>public&nbsp;void&nbsp;setAccessible(boolean&nbsp;flag)
throws java.lang.SecurityException</pre>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setAccessible</code>&nbsp;in class&nbsp;<code>java.lang.reflect.AccessibleObject</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-" title="class or interface in java.lang.reflect">setAccessible</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
</dl>
</li>
</ul>
@@ -336,12 +336,12 @@ extends java.lang.reflect.AccessibleObject</pre>
<li class="blockList">
<h4>isAccessible</h4>
<pre>public&nbsp;boolean&nbsp;isAccessible()
throws java.lang.SecurityException</pre>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>isAccessible</code>&nbsp;in class&nbsp;<code>java.lang.reflect.AccessibleObject</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#isAccessible--" title="class or interface in java.lang.reflect">isAccessible</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
</dl>
</li>
</ul>
@@ -351,10 +351,10 @@ extends java.lang.reflect.AccessibleObject</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

120
docs/apidocs/picocli/CommandLine.Model.OptionSpec.Builder.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.OptionSpec.Builder (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.OptionSpec.Builder (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.OptionSpec.Builder (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.OptionSpec.Builder (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.OptionSpec.Builder</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.OptionSpec.Builder</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builder responsible for creating valid <code>OptionSpec</code> objects.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -151,19 +151,19 @@ extends java.lang.Object</pre>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#arity-java.lang.String-">arity</a></span>(java.lang.String&nbsp;range)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#arity-java.lang.String-">arity</a></span>(<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>&nbsp;range)</code>
<div class="block">Sets how many arguments this option or positional parameter requires, and returns this builder.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#auxiliaryTypes--">auxiliaryTypes</a></span>()</code>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#auxiliaryTypes-java.lang.Class...-">auxiliaryTypes</a></span>(java.lang.Class&lt;?&gt;...&nbsp;types)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#auxiliaryTypes-java.lang.Class...-">auxiliaryTypes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;types)</code>
<div class="block">Sets auxiliary type information, and returns this builder.</div>
</td>
</tr>
@@ -174,14 +174,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#completionCandidates--">completionCandidates</a></span>()</code>
<div class="block">Returns the completion candidates for this option or positional parameter, or <code>null</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#completionCandidates-java.lang.Iterable-">completionCandidates</a></span>(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#completionCandidates-java.lang.Iterable-">completionCandidates</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates)</code>
<div class="block">Sets the completion candidates for this option or positional parameter, and returns this builder.</div>
</td>
</tr>
@@ -199,38 +199,38 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#defaultValue--">defaultValue</a></span>()</code>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#defaultValue-java.lang.String-">defaultValue</a></span>(java.lang.String&nbsp;defaultValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#defaultValue-java.lang.String-">defaultValue</a></span>(<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>&nbsp;defaultValue)</code>
<div class="block">Sets the default value of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#description--">description</a></span>()</code>
<div class="block">Returns the description of this option, used when generating the usage documentation.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#description-java.lang.String...-">description</a></span>(java.lang.String...&nbsp;description)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#description-java.lang.String...-">description</a></span>(<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>...&nbsp;description)</code>
<div class="block">Sets the description of this option, used when generating the usage documentation, and returns this builder.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#descriptionKey--">descriptionKey</a></span>()</code>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#descriptionKey-java.lang.String-">descriptionKey</a></span>(java.lang.String&nbsp;descriptionKey)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#descriptionKey-java.lang.String-">descriptionKey</a></span>(<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>&nbsp;descriptionKey)</code>
<div class="block">Sets the description key that is used to look up the description in a resource bundle, and returns this builder.</div>
</td>
</tr>
@@ -299,14 +299,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#initialValue--">initialValue</a></span>()</code>
<div class="block">Returns the initial value this option or positional parameter.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#initialValue-java.lang.Object-">initialValue</a></span>(java.lang.Object&nbsp;initialValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#initialValue-java.lang.Object-">initialValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue)</code>
<div class="block">Sets the initial value of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
@@ -323,14 +323,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#names--">names</a></span>()</code>
<div class="block">Returns one or more option names.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#names-java.lang.String...-">names</a></span>(java.lang.String...&nbsp;names)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#names-java.lang.String...-">names</a></span>(<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>...&nbsp;names)</code>
<div class="block">Replaces the option names with the specified values.</div>
</td>
</tr>
@@ -347,14 +347,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#paramLabel--">paramLabel</a></span>()</code>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#paramLabel-java.lang.String-">paramLabel</a></span>(java.lang.String&nbsp;paramLabel)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#paramLabel-java.lang.String-">paramLabel</a></span>(<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>&nbsp;paramLabel)</code>
<div class="block">Sets the name of the option or positional parameter used in the usage help message, and returns this builder.</div>
</td>
</tr>
@@ -413,30 +413,30 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#splitRegex--">splitRegex</a></span>()</code>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#splitRegex-java.lang.String-">splitRegex</a></span>(java.lang.String&nbsp;splitRegex)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#splitRegex-java.lang.String-">splitRegex</a></span>(<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>&nbsp;splitRegex)</code>
<div class="block">Sets a regular expression to split option parameter values or <code>""</code> if the value should not be split, and returns this builder.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#type--">type</a></span>()</code>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#type-java.lang.Class-">type</a></span>(java.lang.Class&lt;?&gt;&nbsp;propertyType)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#type-java.lang.Class-">type</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;propertyType)</code>
<div class="block">Sets the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value, and returns this builder.</div>
</td>
</tr>
@@ -465,14 +465,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#userObject--">userObject</a></span>()</code>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#userObject-java.lang.Object-">userObject</a></span>(java.lang.Object&nbsp;userObject)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#userObject-java.lang.Object-">userObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject)</code>
<div class="block">Sets the user object associated with this option or positional parameters, and returns this builder.</div>
</td>
</tr>
@@ -490,7 +490,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#withToString-java.lang.String-">withToString</a></span>(java.lang.String&nbsp;toString)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#withToString-java.lang.String-">withToString</a></span>(<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>&nbsp;toString)</code>
<div class="block">Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
@@ -499,8 +499,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -542,7 +542,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>names</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;names()</pre>
<pre>public&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>[]&nbsp;names()</pre>
<div class="block">Returns one or more option names. At least one option name is required.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -556,7 +556,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;help()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#usageHelp--"><code>usageHelp()</code></a> and <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#versionHelp--"><code>versionHelp()</code></a> instead.</span></div>
<div class="block">Returns whether this option disables validation of the other arguments.</div>
@@ -618,7 +618,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>names</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;names(java.lang.String...&nbsp;names)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;names(<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>...&nbsp;names)</pre>
<div class="block">Replaces the option names with the specified values. At least one option name is required, and returns this builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -704,7 +704,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;description()</pre>
<pre>public&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>[]&nbsp;description()</pre>
<div class="block">Returns the description of this option, used when generating the usage documentation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -718,7 +718,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;descriptionKey()</pre>
<pre>public&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>&nbsp;descriptionKey()</pre>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -749,7 +749,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public&nbsp;java.lang.String&nbsp;paramLabel()</pre>
<pre>public&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>&nbsp;paramLabel()</pre>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -779,7 +779,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>auxiliaryTypes</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -809,7 +809,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>splitRegex</h4>
<pre>public&nbsp;java.lang.String&nbsp;splitRegex()</pre>
<pre>public&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>&nbsp;splitRegex()</pre>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -837,7 +837,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;&nbsp;type()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type()</pre>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</li>
</ul>
@@ -863,7 +863,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>public&nbsp;java.lang.Object&nbsp;userObject()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject()</pre>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -879,7 +879,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;defaultValue()</pre>
<pre>public&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>&nbsp;defaultValue()</pre>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.
A value of <code>null</code> means this option or positional parameter does not have a default.</div>
</li>
@@ -890,7 +890,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;initialValue()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue()</pre>
<div class="block">Returns the initial value this option or positional parameter. If <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#hasInitialValue--"><code>hasInitialValue()</code></a> is true,
the option will be reset to the initial value before parsing (regardless of whether a default value exists),
to clear values that would otherwise remain from parsing previous input.</div>
@@ -923,7 +923,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public&nbsp;java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates()</pre>
<div class="block">Returns the completion candidates for this option or positional parameter, or <code>null</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -967,10 +967,10 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -1000,7 +1000,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;T&nbsp;description(java.lang.String...&nbsp;description)</pre>
<pre>public&nbsp;T&nbsp;description(<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>...&nbsp;description)</pre>
<div class="block">Sets the description of this option, used when generating the usage documentation, and returns this builder.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -1014,7 +1014,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public&nbsp;T&nbsp;descriptionKey(java.lang.String&nbsp;descriptionKey)</pre>
<pre>public&nbsp;T&nbsp;descriptionKey(<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>&nbsp;descriptionKey)</pre>
<div class="block">Sets the description key that is used to look up the description in a resource bundle, and returns this builder.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -1031,7 +1031,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public&nbsp;T&nbsp;arity(java.lang.String&nbsp;range)</pre>
<pre>public&nbsp;T&nbsp;arity(<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>&nbsp;range)</pre>
<div class="block">Sets how many arguments this option or positional parameter requires, and returns this builder.</div>
</li>
</ul>
@@ -1051,7 +1051,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public&nbsp;T&nbsp;paramLabel(java.lang.String&nbsp;paramLabel)</pre>
<pre>public&nbsp;T&nbsp;paramLabel(<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>&nbsp;paramLabel)</pre>
<div class="block">Sets the name of the option or positional parameter used in the usage help message, and returns this builder.</div>
</li>
</ul>
@@ -1077,7 +1077,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>auxiliaryTypes</h4>
<pre>public&nbsp;T&nbsp;auxiliaryTypes(java.lang.Class&lt;?&gt;...&nbsp;types)</pre>
<pre>public&nbsp;T&nbsp;auxiliaryTypes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;types)</pre>
<div class="block">Sets auxiliary type information, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1102,7 +1102,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>splitRegex</h4>
<pre>public&nbsp;T&nbsp;splitRegex(java.lang.String&nbsp;splitRegex)</pre>
<pre>public&nbsp;T&nbsp;splitRegex(<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>&nbsp;splitRegex)</pre>
<div class="block">Sets a regular expression to split option parameter values or <code>""</code> if the value should not be split, and returns this builder.</div>
</li>
</ul>
@@ -1122,7 +1122,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public&nbsp;T&nbsp;completionCandidates(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates)</pre>
<pre>public&nbsp;T&nbsp;completionCandidates(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates)</pre>
<div class="block">Sets the completion candidates for this option or positional parameter, and returns this builder.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -1146,7 +1146,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;T&nbsp;type(java.lang.Class&lt;?&gt;&nbsp;propertyType)</pre>
<pre>public&nbsp;T&nbsp;type(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;propertyType)</pre>
<div class="block">Sets the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1176,7 +1176,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>public&nbsp;T&nbsp;userObject(java.lang.Object&nbsp;userObject)</pre>
<pre>public&nbsp;T&nbsp;userObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject)</pre>
<div class="block">Sets the user object associated with this option or positional parameters, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1192,7 +1192,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;T&nbsp;defaultValue(java.lang.String&nbsp;defaultValue)</pre>
<pre>public&nbsp;T&nbsp;defaultValue(<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>&nbsp;defaultValue)</pre>
<div class="block">Sets the default value of this option or positional parameter to the specified value, and returns this builder.
Before parsing the command line, the result of <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#splitRegex--">splitting</a> and <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#converters--">type converting</a>
this default value is applied to the option or positional parameter. A value of <code>null</code> or <code>"__no_default_value__"</code> means no default.</div>
@@ -1204,7 +1204,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>public&nbsp;T&nbsp;initialValue(java.lang.Object&nbsp;initialValue)</pre>
<pre>public&nbsp;T&nbsp;initialValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue)</pre>
<div class="block">Sets the initial value of this option or positional parameter to the specified value, and returns this builder.
If <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html#hasInitialValue--"><code>hasInitialValue()</code></a> is true, the option will be reset to the initial value before parsing (regardless
of whether a default value exists), to clear values that would otherwise remain from parsing previous input.</div>
@@ -1257,7 +1257,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>withToString</h4>
<pre>public&nbsp;T&nbsp;withToString(java.lang.String&nbsp;toString)</pre>
<pre>public&nbsp;T&nbsp;withToString(<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>&nbsp;toString)</pre>
<div class="block">Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.</div>
</li>
</ul>

52
docs/apidocs/picocli/CommandLine.Model.OptionSpec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.OptionSpec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.OptionSpec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.OptionSpec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.OptionSpec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">picocli.CommandLine.Model.ArgSpec</a></li>
@@ -229,19 +229,19 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#builder-java.lang.String:A-">builder</a></span>(java.lang.String[]&nbsp;names)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#builder-java.lang.String:A-">builder</a></span>(<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>[]&nbsp;names)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#builder-java.lang.String-java.lang.String...-">builder</a></span>(java.lang.String&nbsp;name,
java.lang.String...&nbsp;names)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#builder-java.lang.String-java.lang.String...-">builder</a></span>(<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>&nbsp;name,
<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>...&nbsp;names)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected java.util.Collection&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#getAdditionalDescriptionKeys--">getAdditionalDescriptionKeys</a></span>()</code>
<div class="block">Returns the additional lookup keys for finding description lines in the resource bundle for this option.</div>
</td>
@@ -277,13 +277,13 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#longestName--">longestName</a></span>()</code>
<div class="block">Returns the longest <a href="../picocli/CommandLine.Model.OptionSpec.html#names--">option name</a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#names--">names</a></span>()</code>
<div class="block">Returns one or more option names.</div>
</td>
@@ -295,7 +295,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.OptionSpec.html#shortestName--">shortestName</a></span>()</code>
<div class="block">Returns the shortest <a href="../picocli/CommandLine.Model.OptionSpec.html#names--">option name</a>.</div>
</td>
@@ -330,8 +330,8 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -353,8 +353,8 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;builder(java.lang.String&nbsp;name,
java.lang.String...&nbsp;names)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;builder(<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>&nbsp;name,
<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>...&nbsp;names)</pre>
</li>
</ul>
<a name="builder-java.lang.String:A-">
@@ -363,7 +363,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;builder(java.lang.String[]&nbsp;names)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.Builder.html" title="class in picocli">CommandLine.Model.OptionSpec.Builder</a>&nbsp;builder(<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>[]&nbsp;names)</pre>
</li>
</ul>
<a name="builder-picocli.CommandLine.Model.IAnnotatedElement-picocli.CommandLine.IFactory-">
@@ -443,7 +443,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalDescriptionKeys</h4>
<pre>protected&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<div class="block">Returns the additional lookup keys for finding description lines in the resource bundle for this option.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -464,7 +464,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>names</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;names()</pre>
<pre>public&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>[]&nbsp;names()</pre>
<div class="block">Returns one or more option names. The returned array will contain at least one option name.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -478,7 +478,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>longestName</h4>
<pre>public&nbsp;java.lang.String&nbsp;longestName()</pre>
<pre>public&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>&nbsp;longestName()</pre>
<div class="block">Returns the longest <a href="../picocli/CommandLine.Model.OptionSpec.html#names--">option name</a>.</div>
</li>
</ul>
@@ -488,7 +488,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>shortestName</h4>
<pre>public&nbsp;java.lang.String&nbsp;shortestName()</pre>
<pre>public&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>&nbsp;shortestName()</pre>
<div class="block">Returns the shortest <a href="../picocli/CommandLine.Model.OptionSpec.html#names--">option name</a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -522,7 +522,7 @@ implements <a href="../picocli/CommandLine.Model.IOrdered.html" title="interface
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;help()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../picocli/CommandLine.Model.OptionSpec.html#usageHelp--"><code>usageHelp()</code></a> and <a href="../picocli/CommandLine.Model.OptionSpec.html#versionHelp--"><code>versionHelp()</code></a> instead.</span></div>
<div class="block">Returns whether this option disables validation of the other arguments.</div>
@@ -566,10 +566,10 @@ public&nbsp;boolean&nbsp;help()</pre>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -582,7 +582,7 @@ public&nbsp;boolean&nbsp;help()</pre>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

46
docs/apidocs/picocli/CommandLine.Model.ParserSpec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.ParserSpec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.ParserSpec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.ParserSpec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.ParserSpec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.ParserSpec</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.ParserSpec</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Models parser configuration specification.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -167,12 +167,12 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Character</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#atFileCommentChar--">atFileCommentChar</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#atFileCommentChar-java.lang.Character-">atFileCommentChar</a></span>(java.lang.Character&nbsp;atFileCommentChar)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#atFileCommentChar-java.lang.Character-">atFileCommentChar</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a>&nbsp;atFileCommentChar)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
@@ -195,12 +195,12 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#endOfOptionsDelimiter--">endOfOptionsDelimiter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#endOfOptionsDelimiter-java.lang.String-">endOfOptionsDelimiter</a></span>(java.lang.String&nbsp;delimiter)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#endOfOptionsDelimiter-java.lang.String-">endOfOptionsDelimiter</a></span>(<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>&nbsp;delimiter)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
@@ -240,14 +240,14 @@ extends java.lang.Object</pre>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#posixClusteredShortOptionsAllowed-boolean-">posixClusteredShortOptionsAllowed</a></span>(boolean&nbsp;posixClusteredShortOptionsAllowed)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#separator--">separator</a></span>()</code>
<div class="block">Returns the String to use as the separator between options and option parameters.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#separator-java.lang.String-">separator</a></span>(java.lang.String&nbsp;separator)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#separator-java.lang.String-">separator</a></span>(<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>&nbsp;separator)</code>
<div class="block">Sets the String to use as the separator between options and option parameters.</div>
</td>
</tr>
@@ -284,7 +284,7 @@ extends java.lang.Object</pre>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#toggleBooleanFlags-boolean-">toggleBooleanFlags</a></span>(boolean&nbsp;toggleBooleanFlags)</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.ParserSpec.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
@@ -324,8 +324,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -364,7 +364,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public&nbsp;java.lang.String&nbsp;separator()</pre>
<pre>public&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>&nbsp;separator()</pre>
<div class="block">Returns the String to use as the separator between options and option parameters. <code>"="</code> by default,
initialized from <a href="../picocli/CommandLine.Command.html#separator--"><code>CommandLine.Command.separator()</code></a> if defined.</div>
</li>
@@ -401,7 +401,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>endOfOptionsDelimiter</h4>
<pre>public&nbsp;java.lang.String&nbsp;endOfOptionsDelimiter()</pre>
<pre>public&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>&nbsp;endOfOptionsDelimiter()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
@@ -468,7 +468,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>atFileCommentChar</h4>
<pre>public&nbsp;java.lang.Character&nbsp;atFileCommentChar()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a>&nbsp;atFileCommentChar()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
@@ -605,7 +605,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;separator(java.lang.String&nbsp;separator)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;separator(<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>&nbsp;separator)</pre>
<div class="block">Sets the String to use as the separator between options and option parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -645,7 +645,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>endOfOptionsDelimiter</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;endOfOptionsDelimiter(java.lang.String&nbsp;delimiter)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;endOfOptionsDelimiter(<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>&nbsp;delimiter)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
@@ -712,7 +712,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>atFileCommentChar</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;atFileCommentChar(java.lang.Character&nbsp;atFileCommentChar)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a>&nbsp;atFileCommentChar(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a>&nbsp;atFileCommentChar)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
@@ -849,10 +849,10 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

114
docs/apidocs/picocli/CommandLine.Model.PositionalParamSpec.Builder.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.PositionalParamSpec.Builder (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.PositionalParamSpec.Builder (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.PositionalParamSpec.Builder (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.PositionalParamSpec.Builder (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.PositionalParamSpec.Builder</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.PositionalParamSpec.Builder</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builder responsible for creating valid <code>PositionalParamSpec</code> objects.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -151,19 +151,19 @@ extends java.lang.Object</pre>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#arity-java.lang.String-">arity</a></span>(java.lang.String&nbsp;range)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#arity-java.lang.String-">arity</a></span>(<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>&nbsp;range)</code>
<div class="block">Sets how many arguments this option or positional parameter requires, and returns this builder.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#auxiliaryTypes--">auxiliaryTypes</a></span>()</code>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#auxiliaryTypes-java.lang.Class...-">auxiliaryTypes</a></span>(java.lang.Class&lt;?&gt;...&nbsp;types)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#auxiliaryTypes-java.lang.Class...-">auxiliaryTypes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;types)</code>
<div class="block">Sets auxiliary type information, and returns this builder.</div>
</td>
</tr>
@@ -174,14 +174,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#completionCandidates--">completionCandidates</a></span>()</code>
<div class="block">Returns the completion candidates for this option or positional parameter, or <code>null</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#completionCandidates-java.lang.Iterable-">completionCandidates</a></span>(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#completionCandidates-java.lang.Iterable-">completionCandidates</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates)</code>
<div class="block">Sets the completion candidates for this option or positional parameter, and returns this builder.</div>
</td>
</tr>
@@ -199,38 +199,38 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#defaultValue--">defaultValue</a></span>()</code>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#defaultValue-java.lang.String-">defaultValue</a></span>(java.lang.String&nbsp;defaultValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#defaultValue-java.lang.String-">defaultValue</a></span>(<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>&nbsp;defaultValue)</code>
<div class="block">Sets the default value of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#description--">description</a></span>()</code>
<div class="block">Returns the description of this option, used when generating the usage documentation.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#description-java.lang.String...-">description</a></span>(java.lang.String...&nbsp;description)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#description-java.lang.String...-">description</a></span>(<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>...&nbsp;description)</code>
<div class="block">Sets the description of this option, used when generating the usage documentation, and returns this builder.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#descriptionKey--">descriptionKey</a></span>()</code>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#descriptionKey-java.lang.String-">descriptionKey</a></span>(java.lang.String&nbsp;descriptionKey)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#descriptionKey-java.lang.String-">descriptionKey</a></span>(<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>&nbsp;descriptionKey)</code>
<div class="block">Sets the description key that is used to look up the description in a resource bundle, and returns this builder.</div>
</td>
</tr>
@@ -298,19 +298,19 @@ extends java.lang.Object</pre>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html" title="class in picocli">CommandLine.Model.PositionalParamSpec.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#index-java.lang.String-">index</a></span>(java.lang.String&nbsp;range)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#index-java.lang.String-">index</a></span>(<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>&nbsp;range)</code>
<div class="block">Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#initialValue--">initialValue</a></span>()</code>
<div class="block">Returns the initial value this option or positional parameter.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#initialValue-java.lang.Object-">initialValue</a></span>(java.lang.Object&nbsp;initialValue)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#initialValue-java.lang.Object-">initialValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue)</code>
<div class="block">Sets the initial value of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
@@ -327,14 +327,14 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#paramLabel--">paramLabel</a></span>()</code>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#paramLabel-java.lang.String-">paramLabel</a></span>(java.lang.String&nbsp;paramLabel)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#paramLabel-java.lang.String-">paramLabel</a></span>(<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>&nbsp;paramLabel)</code>
<div class="block">Sets the name of the option or positional parameter used in the usage help message, and returns this builder.</div>
</td>
</tr>
@@ -393,30 +393,30 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#splitRegex--">splitRegex</a></span>()</code>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#splitRegex-java.lang.String-">splitRegex</a></span>(java.lang.String&nbsp;splitRegex)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#splitRegex-java.lang.String-">splitRegex</a></span>(<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>&nbsp;splitRegex)</code>
<div class="block">Sets a regular expression to split option parameter values or <code>""</code> if the value should not be split, and returns this builder.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#type--">type</a></span>()</code>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#type-java.lang.Class-">type</a></span>(java.lang.Class&lt;?&gt;&nbsp;propertyType)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#type-java.lang.Class-">type</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;propertyType)</code>
<div class="block">Sets the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value, and returns this builder.</div>
</td>
</tr>
@@ -433,20 +433,20 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#userObject--">userObject</a></span>()</code>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#userObject-java.lang.Object-">userObject</a></span>(java.lang.Object&nbsp;userObject)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#userObject-java.lang.Object-">userObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject)</code>
<div class="block">Sets the user object associated with this option or positional parameters, and returns this builder.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#withToString-java.lang.String-">withToString</a></span>(java.lang.String&nbsp;toString)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#withToString-java.lang.String-">withToString</a></span>(<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>&nbsp;toString)</code>
<div class="block">Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.</div>
</td>
</tr>
@@ -455,8 +455,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -512,7 +512,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>index</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html" title="class in picocli">CommandLine.Model.PositionalParamSpec.Builder</a>&nbsp;index(java.lang.String&nbsp;range)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html" title="class in picocli">CommandLine.Model.PositionalParamSpec.Builder</a>&nbsp;index(<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>&nbsp;range)</pre>
<div class="block">Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.</div>
</li>
</ul>
@@ -560,7 +560,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;description()</pre>
<pre>public&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>[]&nbsp;description()</pre>
<div class="block">Returns the description of this option, used when generating the usage documentation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -574,7 +574,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;descriptionKey()</pre>
<pre>public&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>&nbsp;descriptionKey()</pre>
<div class="block">Returns the description key of this arg spec, used to get the description from a resource bundle.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -605,7 +605,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public&nbsp;java.lang.String&nbsp;paramLabel()</pre>
<pre>public&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>&nbsp;paramLabel()</pre>
<div class="block">Returns the name of the option or positional parameter used in the usage help message.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -635,7 +635,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>auxiliaryTypes</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;auxiliaryTypes()</pre>
<div class="block">Returns auxiliary type information used when the <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#type--"><code>type()</code></a> is a generic <code>Collection</code>, <code>Map</code> or an abstract class.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -665,7 +665,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>splitRegex</h4>
<pre>public&nbsp;java.lang.String&nbsp;splitRegex()</pre>
<pre>public&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>&nbsp;splitRegex()</pre>
<div class="block">Returns a regular expression to split option parameter values or <code>""</code> if the value should not be split.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -693,7 +693,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;java.lang.Class&lt;?&gt;&nbsp;type()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type()</pre>
<div class="block">Returns the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value.</div>
</li>
</ul>
@@ -719,7 +719,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>public&nbsp;java.lang.Object&nbsp;userObject()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject()</pre>
<div class="block">Returns the user object associated with this option or positional parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -735,7 +735,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;defaultValue()</pre>
<pre>public&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>&nbsp;defaultValue()</pre>
<div class="block">Returns the default value of this option or positional parameter, before splitting and type conversion.
A value of <code>null</code> means this option or positional parameter does not have a default.</div>
</li>
@@ -746,7 +746,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;initialValue()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue()</pre>
<div class="block">Returns the initial value this option or positional parameter. If <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#hasInitialValue--"><code>hasInitialValue()</code></a> is true,
the option will be reset to the initial value before parsing (regardless of whether a default value exists),
to clear values that would otherwise remain from parsing previous input.</div>
@@ -779,7 +779,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public&nbsp;java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates()</pre>
<div class="block">Returns the completion candidates for this option or positional parameter, or <code>null</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -823,10 +823,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -856,7 +856,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;T&nbsp;description(java.lang.String...&nbsp;description)</pre>
<pre>public&nbsp;T&nbsp;description(<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>...&nbsp;description)</pre>
<div class="block">Sets the description of this option, used when generating the usage documentation, and returns this builder.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -870,7 +870,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public&nbsp;T&nbsp;descriptionKey(java.lang.String&nbsp;descriptionKey)</pre>
<pre>public&nbsp;T&nbsp;descriptionKey(<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>&nbsp;descriptionKey)</pre>
<div class="block">Sets the description key that is used to look up the description in a resource bundle, and returns this builder.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -887,7 +887,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public&nbsp;T&nbsp;arity(java.lang.String&nbsp;range)</pre>
<pre>public&nbsp;T&nbsp;arity(<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>&nbsp;range)</pre>
<div class="block">Sets how many arguments this option or positional parameter requires, and returns this builder.</div>
</li>
</ul>
@@ -907,7 +907,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public&nbsp;T&nbsp;paramLabel(java.lang.String&nbsp;paramLabel)</pre>
<pre>public&nbsp;T&nbsp;paramLabel(<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>&nbsp;paramLabel)</pre>
<div class="block">Sets the name of the option or positional parameter used in the usage help message, and returns this builder.</div>
</li>
</ul>
@@ -933,7 +933,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>auxiliaryTypes</h4>
<pre>public&nbsp;T&nbsp;auxiliaryTypes(java.lang.Class&lt;?&gt;...&nbsp;types)</pre>
<pre>public&nbsp;T&nbsp;auxiliaryTypes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;types)</pre>
<div class="block">Sets auxiliary type information, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -958,7 +958,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>splitRegex</h4>
<pre>public&nbsp;T&nbsp;splitRegex(java.lang.String&nbsp;splitRegex)</pre>
<pre>public&nbsp;T&nbsp;splitRegex(<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>&nbsp;splitRegex)</pre>
<div class="block">Sets a regular expression to split option parameter values or <code>""</code> if the value should not be split, and returns this builder.</div>
</li>
</ul>
@@ -978,7 +978,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public&nbsp;T&nbsp;completionCandidates(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;completionCandidates)</pre>
<pre>public&nbsp;T&nbsp;completionCandidates(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&nbsp;completionCandidates)</pre>
<div class="block">Sets the completion candidates for this option or positional parameter, and returns this builder.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -1002,7 +1002,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;T&nbsp;type(java.lang.Class&lt;?&gt;&nbsp;propertyType)</pre>
<pre>public&nbsp;T&nbsp;type(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;propertyType)</pre>
<div class="block">Sets the type to convert the option or positional parameter to before <a href="../picocli/CommandLine.Model.ArgSpec.html#setValue-T-">setting</a> the value, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1032,7 +1032,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>userObject</h4>
<pre>public&nbsp;T&nbsp;userObject(java.lang.Object&nbsp;userObject)</pre>
<pre>public&nbsp;T&nbsp;userObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;userObject)</pre>
<div class="block">Sets the user object associated with this option or positional parameters, and returns this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1048,7 +1048,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;T&nbsp;defaultValue(java.lang.String&nbsp;defaultValue)</pre>
<pre>public&nbsp;T&nbsp;defaultValue(<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>&nbsp;defaultValue)</pre>
<div class="block">Sets the default value of this option or positional parameter to the specified value, and returns this builder.
Before parsing the command line, the result of <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#splitRegex--">splitting</a> and <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#converters--">type converting</a>
this default value is applied to the option or positional parameter. A value of <code>null</code> or <code>"__no_default_value__"</code> means no default.</div>
@@ -1060,7 +1060,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>public&nbsp;T&nbsp;initialValue(java.lang.Object&nbsp;initialValue)</pre>
<pre>public&nbsp;T&nbsp;initialValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;initialValue)</pre>
<div class="block">Sets the initial value of this option or positional parameter to the specified value, and returns this builder.
If <a href="../picocli/CommandLine.Model.PositionalParamSpec.Builder.html#hasInitialValue--"><code>hasInitialValue()</code></a> is true, the option will be reset to the initial value before parsing (regardless
of whether a default value exists), to clear values that would otherwise remain from parsing previous input.</div>
@@ -1113,7 +1113,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>withToString</h4>
<pre>public&nbsp;T&nbsp;withToString(java.lang.String&nbsp;toString)</pre>
<pre>public&nbsp;T&nbsp;withToString(<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>&nbsp;toString)</pre>
<div class="block">Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.</div>
</li>
</ul>

26
docs/apidocs/picocli/CommandLine.Model.PositionalParamSpec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.PositionalParamSpec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.PositionalParamSpec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.PositionalParamSpec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.PositionalParamSpec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">picocli.CommandLine.Model.ArgSpec</a></li>
@@ -228,10 +228,10 @@ extends <a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in pico
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.util.Collection&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.PositionalParamSpec.html#getAdditionalDescriptionKeys--">getAdditionalDescriptionKeys</a></span>()</code>
<div class="block">Returns the additional lookup keys for finding description lines in the resource bundle for this positional parameter.</div>
</td>
@@ -276,8 +276,8 @@ extends <a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in pico
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -362,7 +362,7 @@ extends <a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in pico
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalDescriptionKeys</h4>
<pre>protected&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;&nbsp;getAdditionalDescriptionKeys()</pre>
<div class="block">Returns the additional lookup keys for finding description lines in the resource bundle for this positional parameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -400,7 +400,7 @@ extends <a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in pico
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -410,10 +410,10 @@ extends <a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in pico
<ul class="blockListLast">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

16
docs/apidocs/picocli/CommandLine.Model.UnmatchedArgsBinding.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model.UnmatchedArgsBinding (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Model.UnmatchedArgsBinding (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model.UnmatchedArgsBinding (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model.UnmatchedArgsBinding (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model.UnmatchedArgsBinding</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Model.UnmatchedArgsBinding</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class allows applications to specify a custom binding that will be invoked for unmatched arguments.
A binding can be created with a <code>ISetter</code> that consumes the unmatched arguments <code>String[]</code>, or with a
<code>IGetter</code> that produces a <code>Collection&lt;String&gt;</code> that the unmatched arguments can be added to.</div>
@@ -168,8 +168,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>

433
docs/apidocs/picocli/CommandLine.Model.UsageMessageSpec.html
View File

File diff suppressed because it is too large Load Diff

16
docs/apidocs/picocli/CommandLine.Model.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Model (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:48 JST 2019 -->
<title>CommandLine.Model (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Model (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Model (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,7 +90,7 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Model</li>
@@ -107,7 +107,7 @@
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">CommandLine.Model</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class provides a namespace for classes and interfaces that model concepts and attributes of command line interfaces in picocli.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -245,8 +245,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>

30
docs/apidocs/picocli/CommandLine.MutuallyExclusiveArgsException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.MutuallyExclusiveArgsException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.MutuallyExclusiveArgsException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.MutuallyExclusiveArgsException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.MutuallyExclusiveArgsException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -127,7 +127,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -163,7 +163,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.MutuallyExclusiveArgsException.html#MutuallyExclusiveArgsException-picocli.CommandLine-java.lang.String-">MutuallyExclusiveArgsException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -185,15 +185,15 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -216,7 +216,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList">
<h4>MutuallyExclusiveArgsException</h4>
<pre>public&nbsp;MutuallyExclusiveArgsException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

62
docs/apidocs/picocli/CommandLine.Option.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Option (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Option (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Option (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Option (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,PARAMETER})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
public static @interface <span class="memberNameLabel">CommandLine.Option</span></pre>
<div class="block"><p>
Annotate fields in your class with <code>@Option</code> and picocli will initialize these fields when matching
@@ -142,7 +142,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#names--">names</a></span></code>
<div class="block">One or more option names.</div>
</td>
@@ -163,38 +163,38 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#arity--">arity</a></span></code>
<div class="block">Specifies the minimum number of required parameters and the maximum number of accepted parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends java.lang.Iterable&lt;java.lang.String&gt;&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#completionCandidates--">completionCandidates</a></span></code>
<div class="block">Use this attribute to specify an <code>Iterable&lt;String&gt;</code> class that generates completion candidates for this option.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#converter--">converter</a></span></code>
<div class="block">Optionally specify one or more <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> classes to use to convert the command line argument into
a strongly typed value (or key-value pair for map fields).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#defaultValue--">defaultValue</a></span></code>
<div class="block">Returns the default value of this option, before splitting and type conversion.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#description--">description</a></span></code>
<div class="block">Description of this option, used when generating the usage documentation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#descriptionKey--">descriptionKey</a></span></code>
<div class="block">ResourceBundle key for this option.</div>
</td>
@@ -232,7 +232,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#paramLabel--">paramLabel</a></span></code>
<div class="block">Specify a <code>paramLabel</code> for the option parameter to be used in the usage help message.</div>
</td>
@@ -251,13 +251,13 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#split--">split</a></span></code>
<div class="block">Specify a regular expression to use to split option parameter values before applying them to the field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Option.html#type--">type</a></span></code>
<div class="block">
Optionally specify a <code>type</code> to control exactly what Class the option parameter should be converted
@@ -297,7 +297,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
<ul class="blockListLast">
<li class="blockList">
<h4>names</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;names</pre>
<pre>public abstract&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>[]&nbsp;names</pre>
<div class="block">One or more option names. At least one option name is required.
<p>
Different environments have different conventions for naming options, but usually options have a prefix
@@ -378,7 +378,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Option</span>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre>@Deprecated
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public abstract&nbsp;boolean&nbsp;help</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../picocli/CommandLine.Option.html#usageHelp--"><code>usageHelp()</code></a> and <a href="../picocli/CommandLine.Option.html#versionHelp--"><code>versionHelp()</code></a> instead. See <a href="../picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-"><code>CommandLine.printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)</code></a></span></div>
<div class="block">Set <code>help=true</code> if this option should disable validation of the remaining arguments:
@@ -494,9 +494,9 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;description</pre>
<pre>public abstract&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>[]&nbsp;description</pre>
<div class="block">Description of this option, used when generating the usage documentation. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.
</p><p>
The description may contain variables that are rendered when help is requested.
The string <code>${DEFAULT-VALUE}</code> is replaced with the default value of the option. This is regardless of
@@ -524,7 +524,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;arity</pre>
<pre>public abstract&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>&nbsp;arity</pre>
<div class="block">Specifies the minimum number of required parameters and the maximum number of accepted parameters.
If an option declares a positive arity, and the user specifies an insufficient number of parameters on the
command line, a <a href="../picocli/CommandLine.MissingParameterException.html" title="class in picocli"><code>CommandLine.MissingParameterException</code></a> is thrown by the <a href="../picocli/CommandLine.html#parse-java.lang.String...-"><code>CommandLine.parse(String...)</code></a> method.
@@ -580,7 +580,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;paramLabel</pre>
<pre>public abstract&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>&nbsp;paramLabel</pre>
<div class="block">Specify a <code>paramLabel</code> for the option parameter to be used in the usage help message. If omitted,
picocli uses the field name in fish brackets (<code>'&lt;'</code> and <code>'&gt;'</code>) by default. Example:
<pre>class Example {
@@ -636,7 +636,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;type</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;type</pre>
<div class="block"><p>
Optionally specify a <code>type</code> to control exactly what Class the option parameter should be converted
to. This may be useful when the field type is an interface or an abstract class. For example, a field can
@@ -681,12 +681,12 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>converter</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]&nbsp;converter</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]&nbsp;converter</pre>
<div class="block">Optionally specify one or more <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> classes to use to convert the command line argument into
a strongly typed value (or key-value pair for map fields). This is useful when a particular field should
use a custom conversion that is different from the normal conversion for the field's type.
<p>For example, for a specific field you may want to use a converter that maps the constant names defined
in <code>java.sql.Types</code> to the <code>int</code> value of these constants, but any other <code>int</code> fields should
in <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true" title="class or interface in java.sql"><code>java.sql.Types</code></a> to the <code>int</code> value of these constants, but any other <code>int</code> fields should
not be affected by this and should continue to use the standard int converter that parses numeric values.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -709,14 +709,14 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>split</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;split</pre>
<pre>public abstract&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>&nbsp;split</pre>
<div class="block">Specify a regular expression to use to split option parameter values before applying them to the field.
All elements resulting from the split are added to the array or Collection. Ignored for single-value fields.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a regular expression to split option parameter values or <code>""</code> if the value should not be split</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>String.split(String)</code></dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#split-java.lang.String-" title="class or interface in java.lang"><code>String.split(String)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
@@ -754,7 +754,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;defaultValue</pre>
<pre>public abstract&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>&nbsp;defaultValue</pre>
<div class="block">Returns the default value of this option, before splitting and type conversion.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -802,7 +802,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends java.lang.Iterable&lt;java.lang.String&gt;&gt;&nbsp;completionCandidates</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&gt;&nbsp;completionCandidates</pre>
<div class="block">Use this attribute to specify an <code>Iterable&lt;String&gt;</code> class that generates completion candidates for this option.
For map fields, completion candidates should be in <code>key=value</code> form.
<p>
@@ -840,7 +840,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<pre>public abstract&nbsp;boolean&nbsp;interactive</pre>
<div class="block">Set <code>interactive=true</code> if this option will prompt the end user for a value (like a password).
Only supported for single-value options (not arrays, collections or maps).
When running on Java 6 or greater, this will use the <code>Console.readPassword()</code> API to get a value without echoing input to the console.</div>
When running on Java 6 or greater, this will use the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Console.html?is-external=true#readPassword--" title="class or interface in java.io"><code>Console.readPassword()</code></a> API to get a value without echoing input to the console.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this option prompts the end user for a value to be entered on the command line</dd>
@@ -862,7 +862,7 @@ public abstract&nbsp;boolean&nbsp;help</pre>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;descriptionKey</pre>
<pre>public abstract&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>&nbsp;descriptionKey</pre>
<div class="block">ResourceBundle key for this option. If not specified, (and a ResourceBundle <a href="../picocli/CommandLine.Command.html#resourceBundle--">exists for this command</a>) an attempt
is made to find the option description using any of the option names (without leading hyphens) as key.</div>
<dl>

30
docs/apidocs/picocli/CommandLine.OverwrittenOptionException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.OverwrittenOptionException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.OverwrittenOptionException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.OverwrittenOptionException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.OverwrittenOptionException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,16 +96,16 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -133,7 +133,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -168,7 +168,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.OverwrittenOptionException.html#OverwrittenOptionException-picocli.CommandLine-picocli.CommandLine.Model.ArgSpec-java.lang.String-">OverwrittenOptionException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;overwritten,
java.lang.String&nbsp;msg)</code>&nbsp;</td>
<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -203,15 +203,15 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -235,7 +235,7 @@ extends <a href="../picocli/CommandLine.ParameterException.html" title="class in
<h4>OverwrittenOptionException</h4>
<pre>public&nbsp;OverwrittenOptionException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;overwritten,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

62
docs/apidocs/picocli/CommandLine.ParameterException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParameterException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParameterException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParameterException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParameterException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,16 +96,16 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -128,7 +128,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
@@ -166,31 +166,31 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterException.html#ParameterException-picocli.CommandLine-java.lang.String-">ParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</code>
<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>&nbsp;msg)</code>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterException.html#ParameterException-picocli.CommandLine-java.lang.String-picocli.CommandLine.Model.ArgSpec-java.lang.String-">ParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
<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>&nbsp;msg,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
java.lang.String&nbsp;value)</code>
<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>&nbsp;value)</code>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterException.html#ParameterException-picocli.CommandLine-java.lang.String-java.lang.Throwable-">ParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</code>
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterException.html#ParameterException-picocli.CommandLine-java.lang.String-java.lang.Throwable-picocli.CommandLine.Model.ArgSpec-java.lang.String-">ParameterException</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t,
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
java.lang.String&nbsp;value)</code>
<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>&nbsp;value)</code>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
</td>
</tr>
@@ -222,7 +222,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterException.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the <code>String</code> value for the (sub)command whose input could not be parsed.</div>
</td>
@@ -232,15 +232,15 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -263,7 +263,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ParameterException</h4>
<pre>public&nbsp;ParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg)</pre>
<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>&nbsp;msg)</pre>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -281,8 +281,8 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ParameterException</h4>
<pre>public&nbsp;ParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</pre>
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -301,10 +301,10 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ParameterException</h4>
<pre>public&nbsp;ParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t,
<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
java.lang.String&nbsp;value)</pre>
<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>&nbsp;value)</pre>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -325,9 +325,9 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList">
<h4>ParameterException</h4>
<pre>public&nbsp;ParameterException(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&nbsp;commandLine,
java.lang.String&nbsp;msg,
<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>&nbsp;msg,
<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec,
java.lang.String&nbsp;value)</pre>
<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>&nbsp;value)</pre>
<div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -386,7 +386,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<ul class="blockListLast">
<li class="blockList">
<h4>getValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;getValue()</pre>
<pre>public&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>&nbsp;getValue()</pre>
<div class="block">Returns the <code>String</code> value for the (sub)command whose input could not be parsed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>

30
docs/apidocs/picocli/CommandLine.ParameterIndexGapException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParameterIndexGapException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParameterIndexGapException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParameterIndexGapException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParameterIndexGapException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -127,7 +127,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -160,7 +160,7 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterIndexGapException.html#ParameterIndexGapException-java.lang.String-">ParameterIndexGapException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParameterIndexGapException.html#ParameterIndexGapException-java.lang.String-">ParameterIndexGapException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -175,15 +175,15 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -205,7 +205,7 @@ extends <a href="../picocli/CommandLine.InitializationException.html" title="cla
<ul class="blockListLast">
<li class="blockList">
<h4>ParameterIndexGapException</h4>
<pre>public&nbsp;ParameterIndexGapException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;ParameterIndexGapException(<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

60
docs/apidocs/picocli/CommandLine.Parameters.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Parameters (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Parameters (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Parameters (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Parameters (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,PARAMETER})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
public static @interface <span class="memberNameLabel">CommandLine.Parameters</span></pre>
<div class="block"><p>
Fields annotated with <code>@Parameters</code> will be initialized with positional parameters. By specifying the
@@ -137,39 +137,39 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#arity--">arity</a></span></code>
<div class="block">Specifies the minimum number of required parameters and the maximum number of accepted parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends java.lang.Iterable&lt;java.lang.String&gt;&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#completionCandidates--">completionCandidates</a></span></code>
<div class="block">Use this attribute to specify an <code>Iterable&lt;String&gt;</code> class that generates completion candidates for
this positional parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#converter--">converter</a></span></code>
<div class="block">Optionally specify one or more <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> classes to use to convert the command line argument into
a strongly typed value (or key-value pair for map fields).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#defaultValue--">defaultValue</a></span></code>
<div class="block">Returns the default value of this positional parameter, before splitting and type conversion.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#description--">description</a></span></code>
<div class="block">Description of the parameter(s), used when generating the usage documentation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#descriptionKey--">descriptionKey</a></span></code>
<div class="block">ResourceBundle key for this option.</div>
</td>
@@ -187,7 +187,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#index--">index</a></span></code>
<div class="block">Specify an index ("0", or "1", etc.) to pick which of the command line arguments should be assigned to this
field.</div>
@@ -200,7 +200,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#paramLabel--">paramLabel</a></span></code>
<div class="block">Specify a <code>paramLabel</code> for the parameter to be used in the usage help message.</div>
</td>
@@ -213,13 +213,13 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#split--">split</a></span></code>
<div class="block">Specify a regular expression to use to split positional parameter values before applying them to the field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Parameters.html#type--">type</a></span></code>
<div class="block">
Optionally specify a <code>type</code> to control exactly what Class the positional parameter should be converted
@@ -247,7 +247,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>index</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;index</pre>
<pre>public abstract&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>&nbsp;index</pre>
<div class="block">Specify an index ("0", or "1", etc.) to pick which of the command line arguments should be assigned to this
field. For array or Collection fields, you can also specify an index range ("0..3", or "2..*", etc.) to assign
a subset of the command line arguments to this field. The default is "*", meaning all command line arguments.</div>
@@ -270,9 +270,9 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;description</pre>
<pre>public abstract&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>[]&nbsp;description</pre>
<div class="block">Description of the parameter(s), used when generating the usage documentation. Each element of the array is rendered on a separate line.
<p>May contain embedded format specifiers like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.
<p>May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a> like <code>%n</code> line separators. Literal percent <code>'%'</code> characters must be escaped with another <code>%</code>.
</p><p>
The description may contain variables that are rendered when help is requested.
The string <code>${DEFAULT-VALUE}</code> is replaced with the default value of the positional parameter. This is regardless of
@@ -300,7 +300,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;arity</pre>
<pre>public abstract&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>&nbsp;arity</pre>
<div class="block">Specifies the minimum number of required parameters and the maximum number of accepted parameters. If a
positive arity is declared, and the user specifies an insufficient number of parameters on the command line,
<a href="../picocli/CommandLine.MissingParameterException.html" title="class in picocli"><code>CommandLine.MissingParameterException</code></a> is thrown by the <a href="../picocli/CommandLine.html#parse-java.lang.String...-"><code>CommandLine.parse(String...)</code></a> method.
@@ -328,7 +328,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>paramLabel</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;paramLabel</pre>
<pre>public abstract&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>&nbsp;paramLabel</pre>
<div class="block">Specify a <code>paramLabel</code> for the parameter to be used in the usage help message. If omitted,
picocli uses the field name in fish brackets (<code>'&lt;'</code> and <code>'&gt;'</code>) by default. Example:
<pre>class Example {
@@ -381,7 +381,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;type</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;type</pre>
<div class="block"><p>
Optionally specify a <code>type</code> to control exactly what Class the positional parameter should be converted
to. This may be useful when the field type is an interface or an abstract class. For example, a field can
@@ -426,12 +426,12 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>converter</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]&nbsp;converter</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a>&lt;?&gt;&gt;[]&nbsp;converter</pre>
<div class="block">Optionally specify one or more <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> classes to use to convert the command line argument into
a strongly typed value (or key-value pair for map fields). This is useful when a particular field should
use a custom conversion that is different from the normal conversion for the field's type.
<p>For example, for a specific field you may want to use a converter that maps the constant names defined
in <code>java.sql.Types</code> to the <code>int</code> value of these constants, but any other <code>int</code> fields should
in <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true" title="class or interface in java.sql"><code>java.sql.Types</code></a> to the <code>int</code> value of these constants, but any other <code>int</code> fields should
not be affected by this and should continue to use the standard int converter that parses numeric values.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -454,14 +454,14 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>split</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;split</pre>
<pre>public abstract&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>&nbsp;split</pre>
<div class="block">Specify a regular expression to use to split positional parameter values before applying them to the field.
All elements resulting from the split are added to the array or Collection. Ignored for single-value fields.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a regular expression to split operand values or <code>""</code> if the value should not be split</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>String.split(String)</code></dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#split-java.lang.String-" title="class or interface in java.lang"><code>String.split(String)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
@@ -499,7 +499,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;defaultValue</pre>
<pre>public abstract&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>&nbsp;defaultValue</pre>
<div class="block">Returns the default value of this positional parameter, before splitting and type conversion.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -547,7 +547,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockList">
<li class="blockList">
<h4>completionCandidates</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends java.lang.Iterable&lt;java.lang.String&gt;&gt;&nbsp;completionCandidates</pre>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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>&gt;&gt;&nbsp;completionCandidates</pre>
<div class="block">Use this attribute to specify an <code>Iterable&lt;String&gt;</code> class that generates completion candidates for
this positional parameter. For map fields, completion candidates should be in <code>key=value</code> form.
<p>
@@ -580,7 +580,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<pre>public abstract&nbsp;boolean&nbsp;interactive</pre>
<div class="block">Set <code>interactive=true</code> if this positional parameter will prompt the end user for a value (like a password).
Only supported for single-value positional parameters (not arrays, collections or maps).
When running on Java 6 or greater, this will use the <code>Console.readPassword()</code> API to get a value without echoing input to the console.</div>
When running on Java 6 or greater, this will use the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Console.html?is-external=true#readPassword--" title="class or interface in java.io"><code>Console.readPassword()</code></a> API to get a value without echoing input to the console.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this positional parameter prompts the end user for a value to be entered on the command line</dd>
@@ -602,7 +602,7 @@ public static @interface <span class="memberNameLabel">CommandLine.Parameters</s
<ul class="blockListLast">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;descriptionKey</pre>
<pre>public abstract&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>&nbsp;descriptionKey</pre>
<div class="block">ResourceBundle key for this option. If not specified, (and a ResourceBundle <a href="../picocli/CommandLine.Command.html#resourceBundle--">exists for this command</a>) an attempt
is made to find the positional parameter description using <code>paramLabel() + "[" + index() + "]"</code> as key.</div>
<dl>

12
docs/apidocs/picocli/CommandLine.ParentCommand.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParentCommand (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParentCommand (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParentCommand (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParentCommand (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value=FIELD)
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>)
public static @interface <span class="memberNameLabel">CommandLine.ParentCommand</span></pre>
<div class="block"><p>
Fields annotated with <code>@ParentCommand</code> will be initialized with the parent command of the current subcommand.

28
docs/apidocs/picocli/CommandLine.ParseResult.Builder.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParseResult.Builder (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParseResult.Builder (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParseResult.Builder (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParseResult.Builder (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.ParseResult.Builder</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.ParseResult.Builder</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builds immutable <code>ParseResult</code> instances.</div>
</li>
</ul>
@@ -160,13 +160,13 @@ extends java.lang.Object</pre>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#addUnmatched-java.util.Stack-">addUnmatched</a></span>(java.util.Stack&lt;java.lang.String&gt;&nbsp;args)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#addUnmatched-java.util.Stack-">addUnmatched</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a>&lt;<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>&gt;&nbsp;args)</code>
<div class="block">Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#addUnmatched-java.lang.String-">addUnmatched</a></span>(java.lang.String&nbsp;arg)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#addUnmatched-java.lang.String-">addUnmatched</a></span>(<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>&nbsp;arg)</code>
<div class="block">Adds the specified command line argument to the list of unmatched command line arguments.</div>
</td>
</tr>
@@ -178,7 +178,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#originalArgs-java.lang.String:A-">originalArgs</a></span>(java.lang.String[]&nbsp;originalArgs)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.Builder.html#originalArgs-java.lang.String:A-">originalArgs</a></span>(<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>[]&nbsp;originalArgs)</code>
<div class="block">Sets the specified command line arguments that were parsed.</div>
</td>
</tr>
@@ -193,8 +193,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -273,7 +273,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>addUnmatched</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;addUnmatched(java.lang.String&nbsp;arg)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;addUnmatched(<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>&nbsp;arg)</pre>
<div class="block">Adds the specified command line argument to the list of unmatched command line arguments.</div>
</li>
</ul>
@@ -283,7 +283,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>addUnmatched</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;addUnmatched(java.util.Stack&lt;java.lang.String&gt;&nbsp;args)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;addUnmatched(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a>&lt;<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>&gt;&nbsp;args)</pre>
<div class="block">Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.</div>
</li>
</ul>
@@ -303,7 +303,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>originalArgs</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;originalArgs(java.lang.String[]&nbsp;originalArgs)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.ParseResult.Builder.html" title="class in picocli">CommandLine.ParseResult.Builder</a>&nbsp;originalArgs(<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>[]&nbsp;originalArgs)</pre>
<div class="block">Sets the specified command line arguments that were parsed.</div>
</li>
</ul>

30
docs/apidocs/picocli/CommandLine.ParseResult.GroupMatch.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParseResult.GroupMatch (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParseResult.GroupMatch (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParseResult.GroupMatch (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParseResult.GroupMatch (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.ParseResult.GroupMatch</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.ParseResult.GroupMatch</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A group's <a href="../picocli/CommandLine.ArgGroup.html#multiplicity--">multiplicity</a> specifies how many matches of a group may
appear on the command line. This class models a single "match".
For example, this group: <code>(-a -b) (-a -b)</code> requires two matches of its arguments to fully match.</div>
@@ -158,19 +158,19 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>,<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>,<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.GroupMatch.html#matchedSubgroups--">matchedSubgroups</a></span>()</code>
<div class="block">Returns matches for the subgroups, if any.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.GroupMatch.html#matchedValues-picocli.CommandLine.Model.ArgSpec-">matchedValues</a></span>(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)</code>
<div class="block">Returns the values matched for the specified argument, converted to the type of the argument.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.GroupMatch.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
@@ -178,8 +178,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -231,7 +231,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedSubgroups</h4>
<pre>public&nbsp;java.util.Map&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>,<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;&nbsp;matchedSubgroups()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>,<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;&nbsp;matchedSubgroups()</pre>
<div class="block">Returns matches for the subgroups, if any.</div>
</li>
</ul>
@@ -241,7 +241,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedValues</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;matchedValues(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;matchedValues(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>&nbsp;argSpec)</pre>
<div class="block">Returns the values matched for the specified argument, converted to the type of the argument.</div>
</li>
</ul>
@@ -251,10 +251,10 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

26
docs/apidocs/picocli/CommandLine.ParseResult.GroupMatchContainer.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParseResult.GroupMatchContainer (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParseResult.GroupMatchContainer (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParseResult.GroupMatchContainer (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParseResult.GroupMatchContainer (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.ParseResult.GroupMatchContainer</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.ParseResult.GroupMatchContainer</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Provides information about an <a href="../picocli/CommandLine.ArgGroup.html" title="annotation in picocli"><code>CommandLine.ArgGroup</code></a> that was matched on the command line.
<p>
The <code>ParseResult</code> may have more than one <code>GroupMatchContainer</code> for an <code>ArgGroupSpec</code>, when the
@@ -152,13 +152,13 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html#matches--">matches</a></span>()</code>
<div class="block">Returns the list of <code>GroupMatch</code> instances: <code>ArgGroupSpec</code>s with a multiplicity greater than one may be matched multiple times.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
@@ -166,8 +166,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -199,7 +199,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;&nbsp;matches()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;&nbsp;matches()</pre>
<div class="block">Returns the list of <code>GroupMatch</code> instances: <code>ArgGroupSpec</code>s with a multiplicity greater than one may be matched multiple times.</div>
</li>
</ul>
@@ -209,10 +209,10 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>

64
docs/apidocs/picocli/CommandLine.ParseResult.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.ParseResult (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.ParseResult (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.ParseResult (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.ParseResult (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.ParseResult</li>
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.ParseResult</span>
extends java.lang.Object</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Encapsulates the result of parsing an array of command line arguments.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -172,7 +172,7 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#asCommandLineList--">asCommandLineList</a></span>()</code>
<div class="block">Returns this <code>ParseResult</code> as a list of <code>CommandLine</code> objects, one for each matched command/subcommand.</div>
</td>
@@ -190,19 +190,19 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Exception&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#errors--">errors</a></span>()</code>
<div class="block">If <a href="../picocli/CommandLine.Model.ParserSpec.html#collectErrors"><code>CommandLine.Model.ParserSpec.collectErrors</code></a> is <code>true</code>, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#findMatches-picocli.CommandLine.Model.ArgGroupSpec-">findMatches</a></span>(<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&nbsp;group)</code>
<div class="block">Returns the matches for the specified argument group.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#getGroupMatches--">getGroupMatches</a></span>()</code>
<div class="block">Returns the top-level container for the <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli"><code>ArgGroupSpec</code></a> match or matches found.</div>
</td>
@@ -221,7 +221,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#hasMatchedOption-java.lang.String-">hasMatchedOption</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#hasMatchedOption-java.lang.String-">hasMatchedOption</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns whether an option whose aliases include the specified name was matched on the command line.</div>
</td>
</tr>
@@ -264,12 +264,12 @@ extends java.lang.Object</pre>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedOption-java.lang.String-">matchedOption</a></span>(java.lang.String&nbsp;name)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedOption-java.lang.String-">matchedOption</a></span>(<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>&nbsp;name)</code>
<div class="block">Returns the option with the specified name, or <code>null</code> if no option with that name was matched on the command line.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedOptions--">matchedOptions</a></span>()</code>
<div class="block">Returns a list of matched options, in the order they were found on the command line.</div>
</td>
@@ -283,7 +283,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedOptionValue-java.lang.String-T-">matchedOptionValue</a></span>(java.lang.String&nbsp;name,
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedOptionValue-java.lang.String-T-">matchedOptionValue</a></span>(<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>&nbsp;name,
T&nbsp;defaultValue)</code>
<div class="block">Returns the command line argument value of the option with the specified name, converted to the <a href="../picocli/CommandLine.Model.ArgSpec.html#type--">type</a> of the option, or the specified default value if no option with the specified name was matched.</div>
</td>
@@ -295,13 +295,13 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedPositionals--">matchedPositionals</a></span>()</code>
<div class="block">Returns a list of matched positional parameters.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#matchedPositionals-int-">matchedPositionals</a></span>(int&nbsp;position)</code>
<div class="block">Returns all <code>PositionalParamSpec</code> objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.</div>
</td>
@@ -314,7 +314,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#originalArgs--">originalArgs</a></span>()</code>
<div class="block">Returns the command line arguments that were parsed.</div>
</td>
@@ -326,7 +326,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.ParseResult.html#unmatched--">unmatched</a></span>()</code>
<div class="block">Returns a list of command line arguments that did not match any options or positional parameters.</div>
</td>
@@ -336,8 +336,8 @@ extends java.lang.Object</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -369,7 +369,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>findMatches</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;&nbsp;findMatches(<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&nbsp;group)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatchContainer.html" title="class in picocli">CommandLine.ParseResult.GroupMatchContainer</a>&gt;&nbsp;findMatches(<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>&nbsp;group)</pre>
<div class="block">Returns the matches for the specified argument group.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -383,7 +383,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getGroupMatches</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;&nbsp;getGroupMatches()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.ParseResult.GroupMatch.html" title="class in picocli">CommandLine.ParseResult.GroupMatch</a>&gt;&nbsp;getGroupMatches()</pre>
<div class="block">Returns the top-level container for the <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli"><code>ArgGroupSpec</code></a> match or matches found.
<p>
If the user input was a valid combination of group arguments, the returned list should contain a single
@@ -431,7 +431,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedOption</h4>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&nbsp;matchedOption(java.lang.String&nbsp;name)</pre>
<pre>public&nbsp;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&nbsp;matchedOption(<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>&nbsp;name)</pre>
<div class="block">Returns the option with the specified name, or <code>null</code> if no option with that name was matched on the command line.
<p>Use <a href="../picocli/CommandLine.Model.ArgSpec.html#getValue--"><code>getValue</code></a> on the returned <code>OptionSpec</code> to get the matched value (or values),
converted to the type of the option. Alternatively, use <a href="../picocli/CommandLine.Model.ArgSpec.html#stringValues--"><code>stringValues</code></a>
@@ -466,7 +466,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedPositionals</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;matchedPositionals(int&nbsp;position)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;matchedPositionals(int&nbsp;position)</pre>
<div class="block">Returns all <code>PositionalParamSpec</code> objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.</div>
</li>
</ul>
@@ -500,7 +500,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>hasMatchedOption</h4>
<pre>public&nbsp;boolean&nbsp;hasMatchedOption(java.lang.String&nbsp;name)</pre>
<pre>public&nbsp;boolean&nbsp;hasMatchedOption(<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>&nbsp;name)</pre>
<div class="block">Returns whether an option whose aliases include the specified name was matched on the command line.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -545,7 +545,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedOptions</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;matchedOptions()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>&gt;&nbsp;matchedOptions()</pre>
<div class="block">Returns a list of matched options, in the order they were found on the command line.</div>
</li>
</ul>
@@ -555,7 +555,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedPositionals</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;matchedPositionals()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>&gt;&nbsp;matchedPositionals()</pre>
<div class="block">Returns a list of matched positional parameters.</div>
</li>
</ul>
@@ -565,7 +565,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>unmatched</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;unmatched()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;unmatched()</pre>
<div class="block">Returns a list of command line arguments that did not match any options or positional parameters.</div>
</li>
</ul>
@@ -575,7 +575,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>originalArgs</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;originalArgs()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;originalArgs()</pre>
<div class="block">Returns the command line arguments that were parsed.</div>
</li>
</ul>
@@ -585,7 +585,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>errors</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Exception&gt;&nbsp;errors()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&gt;&nbsp;errors()</pre>
<div class="block">If <a href="../picocli/CommandLine.Model.ParserSpec.html#collectErrors"><code>CommandLine.Model.ParserSpec.collectErrors</code></a> is <code>true</code>, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -614,7 +614,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>matchedOptionValue</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;matchedOptionValue(java.lang.String&nbsp;name,
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;matchedOptionValue(<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>&nbsp;name,
T&nbsp;defaultValue)</pre>
<div class="block">Returns the command line argument value of the option with the specified name, converted to the <a href="../picocli/CommandLine.Model.ArgSpec.html#type--">type</a> of the option, or the specified default value if no option with the specified name was matched.</div>
</li>
@@ -678,7 +678,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>asCommandLineList</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;asCommandLineList()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;asCommandLineList()</pre>
<div class="block">Returns this <code>ParseResult</code> as a list of <code>CommandLine</code> objects, one for each matched command/subcommand.
For backwards compatibility with pre-3.0 methods.</div>
</li>

40
docs/apidocs/picocli/CommandLine.PicocliException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.PicocliException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.PicocliException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.PicocliException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.PicocliException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.PicocliException</li>
@@ -117,7 +117,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
@@ -130,7 +130,7 @@
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.PicocliException</span>
extends java.lang.RuntimeException</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></pre>
<div class="block">Base class of all exceptions thrown by <code>picocli.CommandLine</code>.
<h2>Class Diagram of the Picocli Exceptions</h2>
<p>
@@ -160,11 +160,11 @@ extends java.lang.RuntimeException</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.PicocliException.html#PicocliException-java.lang.String-">PicocliException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.PicocliException.html#PicocliException-java.lang.String-">PicocliException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.PicocliException.html#PicocliException-java.lang.String-java.lang.Throwable-">PicocliException</a></span>(java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.PicocliException.html#PicocliException-java.lang.String-java.lang.Throwable-">PicocliException</a></span>(<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -179,15 +179,15 @@ extends java.lang.RuntimeException</pre>
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -209,7 +209,7 @@ extends java.lang.RuntimeException</pre>
<ul class="blockList">
<li class="blockList">
<h4>PicocliException</h4>
<pre>public&nbsp;PicocliException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;PicocliException(<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>&nbsp;msg)</pre>
</li>
</ul>
<a name="PicocliException-java.lang.String-java.lang.Throwable-">
@@ -218,8 +218,8 @@ extends java.lang.RuntimeException</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>PicocliException</h4>
<pre>public&nbsp;PicocliException(java.lang.String&nbsp;msg,
java.lang.Throwable&nbsp;t)</pre>
<pre>public&nbsp;PicocliException(<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>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
</li>
</ul>
</li>

170
docs/apidocs/picocli/CommandLine.Range.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Range (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Range (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Range (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Range (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":41,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":9,"i12":9,"i13":10,"i14":10,"i15":9};
var methods = {"i0":10,"i1":10,"i2":41,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9,"i15":9,"i16":10,"i17":10,"i18":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -96,7 +96,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Range</li>
@@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -117,8 +117,8 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.Range</span>
extends java.lang.Object
implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</pre>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</pre>
<div class="block">Describes the number of parameters required and accepted by an option or a positional parameter.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -144,18 +144,26 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#isVariable">isVariable</a></span></code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#isVariable">isVariable</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#isVariable--"><code>isVariable()</code></a> instead</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#max">max</a></span></code>
<div class="block">Maximum accepted number of parameters for an option or positional parameter.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#max--"><code>max()</code></a> instead</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#min">min</a></span></code>
<div class="block">Required number of parameters for an option or positional parameter.</div>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#min--"><code>min()</code></a> instead</span></div>
</div>
</td>
</tr>
</table>
@@ -177,7 +185,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
int&nbsp;max,
boolean&nbsp;variable,
boolean&nbsp;unspecified,
java.lang.String&nbsp;originalValue)</code>
<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>&nbsp;originalValue)</code>
<div class="block">Constructs a new Range object with the specified parameters.</div>
</td>
</tr>
@@ -208,7 +216,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.Class-">defaultArity</a></span>(java.lang.Class&lt;?&gt;&nbsp;type)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.Class-">defaultArity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.reflect.Field-"><code>defaultArity(Field)</code></a> instead</span></div>
</div>
@@ -216,7 +224,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.reflect.Field-">defaultArity</a></span>(java.lang.reflect.Field&nbsp;field)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.reflect.Field-">defaultArity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</code>
<div class="block">Returns the default arity <code>Range</code>: for interactive options/positional parameters,
this is 0; for <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>options</code></a> this is 0 for booleans and 1 for
other types, for <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>parameters</code></a> booleans have arity 0, arrays or Collections have
@@ -225,7 +233,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;object)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
@@ -245,50 +253,68 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#isVariable--">isVariable</a></span>()</code>
<div class="block">Returns <code>true</code> if this range has no fixed upper bound.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#max--">max</a></span>()</code>
<div class="block">Returns the upper bound of this range (inclusive), or <code>Integer.MAX_VALUE</code> if this range has <a href="../picocli/CommandLine.Range.html#isVariable--">no upper bound</a>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#max-int-">max</a></span>(int&nbsp;newMax)</code>
<div class="block">Returns a new Range object with the <code>max</code> value replaced by the specified value.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#min--">min</a></span>()</code>
<div class="block">Returns the lower bound of this range (inclusive).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#min-int-">min</a></span>(int&nbsp;newMin)</code>
<div class="block">Returns a new Range object with the <code>min</code> value replaced by the specified value.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#optionArity-java.lang.reflect.Field-">optionArity</a></span>(java.lang.reflect.Field&nbsp;field)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#optionArity-java.lang.reflect.Field-">optionArity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</code>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Option.html#arity--"><code>CommandLine.Option.arity()</code></a> annotation on the specified field,
or the field type's default arity if no arity was specified.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#parameterArity-java.lang.reflect.Field-">parameterArity</a></span>(java.lang.reflect.Field&nbsp;field)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#parameterArity-java.lang.reflect.Field-">parameterArity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</code>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Parameters.html#arity--"><code>CommandLine.Parameters.arity()</code></a> annotation on the specified field,
or the field type's default arity if no arity was specified.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#parameterIndex-java.lang.reflect.Field-">parameterIndex</a></span>(java.lang.reflect.Field&nbsp;field)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#parameterIndex-java.lang.reflect.Field-">parameterIndex</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</code>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Parameters.html#index--"><code>CommandLine.Parameters.index()</code></a> annotation on the specified field.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<tr id="i16" class="altColor">
<td class="colFirst"><code><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 class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#unspecified-boolean-">unspecified</a></span>(boolean&nbsp;unspecified)</code>
<div class="block">Returns a new Range object with the <code>isUnspecified</code> value replaced by the specified value.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;range)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Range.html#valueOf-java.lang.String-">valueOf</a></span>(<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>&nbsp;range)</code>
<div class="block">Leniently parses the specified String as an <code>Range</code> value and return the result.</div>
</td>
</tr>
@@ -297,8 +323,8 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -320,8 +346,9 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public final&nbsp;int min</pre>
<div class="block">Required number of parameters for an option or positional parameter.</div>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public final&nbsp;int min</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#min--"><code>min()</code></a> instead</span></div>
</li>
</ul>
<a name="max">
@@ -330,8 +357,9 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public final&nbsp;int max</pre>
<div class="block">Maximum accepted number of parameters for an option or positional parameter.</div>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public final&nbsp;int max</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#max--"><code>max()</code></a> instead</span></div>
</li>
</ul>
<a name="isVariable">
@@ -340,7 +368,9 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockListLast">
<li class="blockList">
<h4>isVariable</h4>
<pre>public final&nbsp;boolean isVariable</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public final&nbsp;boolean isVariable</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#isVariable--"><code>isVariable()</code></a> instead</span></div>
</li>
</ul>
</li>
@@ -361,7 +391,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
int&nbsp;max,
boolean&nbsp;variable,
boolean&nbsp;unspecified,
java.lang.String&nbsp;originalValue)</pre>
<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>&nbsp;originalValue)</pre>
<div class="block">Constructs a new Range object with the specified parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -387,7 +417,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>optionArity</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;optionArity(java.lang.reflect.Field&nbsp;field)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;optionArity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</pre>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Option.html#arity--"><code>CommandLine.Option.arity()</code></a> annotation on the specified field,
or the field type's default arity if no arity was specified.</div>
<dl>
@@ -404,7 +434,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>parameterArity</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;parameterArity(java.lang.reflect.Field&nbsp;field)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;parameterArity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</pre>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Parameters.html#arity--"><code>CommandLine.Parameters.arity()</code></a> annotation on the specified field,
or the field type's default arity if no arity was specified.</div>
<dl>
@@ -421,7 +451,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>parameterIndex</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;parameterIndex(java.lang.reflect.Field&nbsp;field)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;parameterIndex(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</pre>
<div class="block">Returns a new <code>Range</code> based on the <a href="../picocli/CommandLine.Parameters.html#index--"><code>CommandLine.Parameters.index()</code></a> annotation on the specified field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -437,7 +467,7 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>defaultArity</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;defaultArity(java.lang.reflect.Field&nbsp;field)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;defaultArity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;field)</pre>
<div class="block">Returns the default arity <code>Range</code>: for interactive options/positional parameters,
this is 0; for <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>options</code></a> this is 0 for booleans and 1 for
other types, for <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>parameters</code></a> booleans have arity 0, arrays or Collections have
@@ -458,8 +488,8 @@ implements java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" t
<ul class="blockList">
<li class="blockList">
<h4>defaultArity</h4>
<pre>@Deprecated
public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;defaultArity(java.lang.Class&lt;?&gt;&nbsp;type)</pre>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;defaultArity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../picocli/CommandLine.Range.html#defaultArity-java.lang.reflect.Field-"><code>defaultArity(Field)</code></a> instead</span></div>
<div class="block">Returns the default arity <code>Range</code> for <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>options</code></a>: booleans have arity 0, other types have arity 1.</div>
<dl>
@@ -476,7 +506,7 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;valueOf(java.lang.String&nbsp;range)</pre>
<pre>public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;valueOf(<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>&nbsp;range)</pre>
<div class="block">Leniently parses the specified String as an <code>Range</code> value and return the result. A range string can
be a fixed integer value or a range of the form <code>MIN_VALUE + ".." + MAX_VALUE</code>. If the
<code>MIN_VALUE</code> string is not numeric, the minimum is zero. If the <code>MAX_VALUE</code> is not numeric, the
@@ -568,6 +598,48 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
</dl>
</li>
</ul>
<a name="min--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public&nbsp;int&nbsp;min()</pre>
<div class="block">Returns the lower bound of this range (inclusive).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="max--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public&nbsp;int&nbsp;max()</pre>
<div class="block">Returns the upper bound of this range (inclusive), or <code>Integer.MAX_VALUE</code> if this range has <a href="../picocli/CommandLine.Range.html#isVariable--">no upper bound</a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="isVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVariable</h4>
<pre>public&nbsp;boolean&nbsp;isVariable()</pre>
<div class="block">Returns <code>true</code> if this range has no fixed upper bound.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contains-int-">
<!-- -->
</a>
@@ -590,10 +662,10 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;object)</pre>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -606,7 +678,7 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -616,10 +688,10 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<pre>public&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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
@@ -632,7 +704,7 @@ public static&nbsp;<a href="../picocli/CommandLine.Range.html" title="class in p
<pre>public&nbsp;int&nbsp;compareTo(<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&nbsp;other)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a>&gt;</code></dd>
</dl>
</li>
</ul>

85
docs/apidocs/picocli/CommandLine.RunAll.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.RunAll (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.RunAll (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.RunAll (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.RunAll (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -96,13 +96,13 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;R&gt;&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</li>
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.RunAll</li>
@@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</dd>
<dd><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a>, <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -127,11 +127,11 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.RunAll</span>
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;
implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a></pre>
<div class="block">Command line parse result handler that prints help if requested, and otherwise executes the top-level command and
all subcommands as <code>Runnable</code> or <code>Callable</code>.
For use in the <a href="../picocli/CommandLine.html#parseWithHandlers-picocli.CommandLine.IParseResultHandler2-picocli.CommandLine.IExceptionHandler2-java.lang.String...-"><code>parseWithHandler</code></a> methods.</div>
<div class="block">Command line <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">execution strategy</a> that prints help if requested, and otherwise executes the top-level command and
all subcommands as <code>Runnable</code>, <code>Callable</code> or <code>Method</code>.
For use by the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
@@ -172,21 +172,25 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunAll.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunAll.html#handle-picocli.CommandLine.ParseResult-">handle</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">Executes the top-level command and all subcommands as <code>Runnable</code> or <code>Callable</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunAll.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunAll.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Prints help if requested, and otherwise executes the top-level command and all subcommands as <code>Runnable</code>
or <code>Callable</code>.</div>
<div class="block">Prints help if requested, and otherwise executes the top-level command and all subcommands as <code>Runnable</code>,
<code>Callable</code> or <code>Method</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.RunAll.html" title="class in picocli">CommandLine.RunAll</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunAll.html#self--">self</a></span>()</code>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
@@ -198,21 +202,21 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#execute-picocli.CommandLine.ParseResult-">execute</a>, <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.picocli.CommandLine.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -251,11 +255,11 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handleParseResult</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handleParseResult(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Prints help if requested, and otherwise executes the top-level command and all subcommands as <code>Runnable</code>
or <code>Callable</code>. Finally, either a list of result objects is returned, or the JVM is terminated if an exit
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleParseResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Prints help if requested, and otherwise executes the top-level command and all subcommands as <code>Runnable</code>,
<code>Callable</code> or <code>Method</code>. Finally, either a list of result objects is returned, or the JVM is terminated if an exit
code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>. If any of the <code>CommandLine</code> commands does not implement either
<code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
is thrown detailing the problem and capturing the offending <code>CommandLine</code> object.</div>
@@ -283,14 +287,14 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre>protected&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block">Executes the top-level command and all subcommands as <code>Runnable</code> or <code>Callable</code>.
If any of the <code>CommandLine</code> commands does not implement either <code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
If any of the <code>CommandLine</code> commands does not implement either <code>Runnable</code> or <code>Callable</code> and is not a <code>Method</code>, an <code>ExecutionException</code>
is thrown detailing the problem and capturing the offending <code>CommandLine</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the <code>ParseResult</code> that resulted from successfully parsing the command line arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -304,6 +308,19 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
</dl>
</li>
</ul>
<a name="extractExitCodeGenerators-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractExitCodeGenerators</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;&nbsp;extractExitCodeGenerators(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="self--">
<!-- -->
</a>
@@ -315,7 +332,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;&gt;</code></dd>
</dl>
</li>
</ul>

75
docs/apidocs/picocli/CommandLine.RunFirst.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.RunFirst (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.RunFirst (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.RunFirst (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.RunFirst (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -96,13 +96,13 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;R&gt;&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</li>
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.RunFirst</li>
@@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</dd>
<dd><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a>, <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -127,11 +127,11 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.RunFirst</span>
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;
implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a></pre>
<div class="block">Command line parse result handler that prints help if requested, and otherwise executes the top-level
<div class="block">Command line <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">execution strategy</a> that prints help if requested, and otherwise executes the top-level
<code>Runnable</code> or <code>Callable</code> command.
For use in the <a href="../picocli/CommandLine.html#parseWithHandlers-picocli.CommandLine.IParseResultHandler2-picocli.CommandLine.IExceptionHandler2-java.lang.String...-"><code>parseWithHandler</code></a> methods.</div>
For use by the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
@@ -172,20 +172,24 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunFirst.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunFirst.html#handle-picocli.CommandLine.ParseResult-">handle</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">Executes the top-level <code>Runnable</code> or <code>Callable</code> subcommand.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunFirst.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunFirst.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Prints help if requested, and otherwise executes the top-level <code>Runnable</code> or <code>Callable</code> command.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.RunFirst.html" title="class in picocli">CommandLine.RunFirst</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunFirst.html#self--">self</a></span>()</code>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
@@ -197,21 +201,21 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#execute-picocli.CommandLine.ParseResult-">execute</a>, <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.picocli.CommandLine.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -250,9 +254,9 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handleParseResult</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handleParseResult(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleParseResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Prints help if requested, and otherwise executes the top-level <code>Runnable</code> or <code>Callable</code> command.
Finally, either a list of result objects is returned, or the JVM is terminated if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>.
If the top-level command does not implement either <code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
@@ -281,14 +285,14 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre>protected&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block">Executes the top-level <code>Runnable</code> or <code>Callable</code> subcommand.
If the top-level command does not implement either <code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
If the top-level command does not implement either <code>Runnable</code> or <code>Callable</code> and is not a <code>Method</code>, an <code>ExecutionException</code>
is thrown detailing the problem and capturing the offending <code>CommandLine</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the <code>ParseResult</code> that resulted from successfully parsing the command line arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -302,6 +306,19 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
</dl>
</li>
</ul>
<a name="extractExitCodeGenerators-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractExitCodeGenerators</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;&nbsp;extractExitCodeGenerators(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="self--">
<!-- -->
</a>
@@ -313,7 +330,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;&gt;</code></dd>
</dl>
</li>
</ul>

77
docs/apidocs/picocli/CommandLine.RunLast.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.RunLast (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.RunLast (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,13 +12,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.RunLast (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.RunLast (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -96,13 +96,13 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">picocli.CommandLine.AbstractHandler</a>&lt;R,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;R&gt;&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</li>
<li><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">picocli.CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.RunLast</li>
@@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</dd>
<dd><a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">CommandLine.IExecutionStrategy</a>, <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a>, <a href="../picocli/CommandLine.IParseResultHandler2.html" title="interface in picocli">CommandLine.IParseResultHandler2</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -127,11 +127,11 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public static class <span class="typeNameLabel">CommandLine.RunLast</span>
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;
extends <a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;
implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a></pre>
<div class="block">Command line parse result handler that prints help if requested, and otherwise executes the most specific
<div class="block">Command line <a href="../picocli/CommandLine.IExecutionStrategy.html" title="interface in picocli">execution strategy</a> that prints help if requested, and otherwise executes the most specific
<code>Runnable</code> or <code>Callable</code> subcommand.
For use in the <a href="../picocli/CommandLine.html#parseWithHandlers-picocli.CommandLine.IParseResultHandler2-picocli.CommandLine.IExceptionHandler2-java.lang.String...-"><code>parseWithHandler</code></a> methods.
For use by the <a href="../picocli/CommandLine.html#execute-java.lang.String...-"><code>execute</code></a> method.
<p>
Something like this:</p>
<pre><code>
@@ -158,7 +158,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
} else {
throw new ExecutionException(last, "Parsed command (" + command + ") is not Runnable or Callable");
}
if (hasExitCode()) { System.exit(exitCode()); }
last.setExecutionResult(result);
return Arrays.asList(result);
</code></pre>
<p>
@@ -205,20 +205,24 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunLast.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunLast.html#handle-picocli.CommandLine.ParseResult-">handle</a></span>(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</code>
<div class="block">Executes the most specific <code>Runnable</code> or <code>Callable</code> subcommand.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunLast.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunLast.html#handleParseResult-java.util.List-java.io.PrintStream-picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</code>
<div class="block">Prints help if requested, and otherwise executes the most specific <code>Runnable</code> or <code>Callable</code> subcommand.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.RunLast.html" title="class in picocli">CommandLine.RunLast</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.RunLast.html#self--">self</a></span>()</code>
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
@@ -230,21 +234,21 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#execute-picocli.CommandLine.ParseResult-">execute</a>, <a href="../picocli/CommandLine.AbstractParseResultHandler.html#handleParseResult-picocli.CommandLine.ParseResult-">handleParseResult</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.picocli.CommandLine.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;picocli.<a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a></h3>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
<code><a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">andExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#ansi--">ansi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#colorScheme--">colorScheme</a>, <a href="../picocli/CommandLine.AbstractHandler.html#err--">err</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exit-int-">exit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#exitCode--">exitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#hasExitCode--">hasExitCode</a>, <a href="../picocli/CommandLine.AbstractHandler.html#out--">out</a>, <a href="../picocli/CommandLine.AbstractHandler.html#returnResultOrExit-R-">returnResultOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#throwOrExit-picocli.CommandLine.ExecutionException-">throwOrExit</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useAnsi-picocli.CommandLine.Help.Ansi-">useAnsi</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useErr-java.io.PrintStream-">useErr</a>, <a href="../picocli/CommandLine.AbstractHandler.html#useOut-java.io.PrintStream-">useOut</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -283,9 +287,9 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handleParseResult</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handleParseResult(java.util.List&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
java.io.PrintStream&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handleParseResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>&gt;&nbsp;parsedCommands,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;out,
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a>&nbsp;ansi)</pre>
<div class="block">Prints help if requested, and otherwise executes the most specific <code>Runnable</code> or <code>Callable</code> subcommand.
Finally, either a list of result objects is returned, or the JVM is terminated if an exit code <a href="../picocli/CommandLine.AbstractHandler.html#andExit-int-">was set</a>.
If the last (sub)command does not implement either <code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
@@ -314,14 +318,14 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre>protected&nbsp;java.util.List&lt;java.lang.Object&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;handle(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)
throws <a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></pre>
<div class="block">Executes the most specific <code>Runnable</code> or <code>Callable</code> subcommand.
If the last (sub)command does not implement either <code>Runnable</code> or <code>Callable</code>, an <code>ExecutionException</code>
If the last (sub)command does not implement either <code>Runnable</code> or <code>Callable</code> and is not a <code>Method</code>, an <code>ExecutionException</code>
is thrown detailing the problem and capturing the offending <code>CommandLine</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#handle-picocli.CommandLine.ParseResult-">handle</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parseResult</code> - the <code>ParseResult</code> that resulted from successfully parsing the command line arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -335,6 +339,19 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
</dl>
</li>
</ul>
<a name="extractExitCodeGenerators-picocli.CommandLine.ParseResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractExitCodeGenerators</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../picocli/CommandLine.IExitCodeGenerator.html" title="interface in picocli">CommandLine.IExitCodeGenerator</a>&gt;&nbsp;extractExitCodeGenerators(<a href="../picocli/CommandLine.ParseResult.html" title="class in picocli">CommandLine.ParseResult</a>&nbsp;parseResult)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractParseResultHandler.html#extractExitCodeGenerators-picocli.CommandLine.ParseResult-">extractExitCodeGenerators</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="self--">
<!-- -->
</a>
@@ -346,7 +363,7 @@ implements <a href="../picocli/CommandLine.IParseResultHandler.html" title="inte
<div class="block">Returns <code>this</code> to allow method chaining when calling the setters for a fluent API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;java.util.List&lt;java.lang.Object&gt;&gt;&gt;</code></dd>
<dd><code><a href="../picocli/CommandLine.AbstractHandler.html#self--">self</a></code>&nbsp;in class&nbsp;<code><a href="../picocli/CommandLine.AbstractHandler.html" title="class in picocli">CommandLine.AbstractHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;,<a href="../picocli/CommandLine.AbstractParseResultHandler.html" title="class in picocli">CommandLine.AbstractParseResultHandler</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;&gt;</code></dd>
</dl>
</li>
</ul>

12
docs/apidocs/picocli/CommandLine.Spec.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Spec (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Spec (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Spec (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Spec (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>})
public static @interface <span class="memberNameLabel">CommandLine.Spec</span></pre>
<div class="block">Fields annotated with <code>@Spec</code> will be initialized with the <code>CommandSpec</code> for the command the field is part of. Example usage:
<pre>

30
docs/apidocs/picocli/CommandLine.TypeConversionException.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.TypeConversionException (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.TypeConversionException (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.TypeConversionException (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.TypeConversionException (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -90,16 +90,16 @@
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li>
<li>
<ul class="inheritance">
<li><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">picocli.CommandLine.PicocliException</a></li>
@@ -122,7 +122,7 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
@@ -155,7 +155,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.TypeConversionException.html#TypeConversionException-java.lang.String-">TypeConversionException</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../picocli/CommandLine.TypeConversionException.html#TypeConversionException-java.lang.String-">TypeConversionException</a></span>(<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>&nbsp;msg)</code>&nbsp;</td>
</tr>
</table>
</li>
@@ -170,15 +170,15 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -200,7 +200,7 @@ extends <a href="../picocli/CommandLine.PicocliException.html" title="class in p
<ul class="blockListLast">
<li class="blockList">
<h4>TypeConversionException</h4>
<pre>public&nbsp;TypeConversionException(java.lang.String&nbsp;msg)</pre>
<pre>public&nbsp;TypeConversionException(<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>&nbsp;msg)</pre>
</li>
</ul>
</li>

12
docs/apidocs/picocli/CommandLine.Unmatched.html
View File

@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_202) on Thu Apr 18 19:56:12 JST 2019 -->
<title>CommandLine.Unmatched (picocli 4.0.0-alpha-2 API)</title>
<meta name="date" content="2019-04-18">
<!-- Generated by javadoc (1.8.0_202) on Mon May 13 21:10:50 JST 2019 -->
<title>CommandLine.Unmatched (picocli 4.0.0-alpha-3 API)</title>
<meta name="date" content="2019-05-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Unmatched (picocli 4.0.0-alpha-2 API)";
parent.document.title="CommandLine.Unmatched (picocli 4.0.0-alpha-3 API)";
}
}
catch(err) {
@@ -92,8 +92,8 @@
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value=FIELD)
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>)
public static @interface <span class="memberNameLabel">CommandLine.Unmatched</span></pre>
<div class="block">Fields annotated with <code>@Unmatched</code> will be initialized with the list of unmatched command line arguments, if any.
If this annotation is found, picocli automatically sets <a href="../picocli/CommandLine.html#setUnmatchedArgumentsAllowed-boolean-">unmatchedArgumentsAllowed</a> to <code>true</code>.</div>

Some files were not shown because too many files have changed in this diff Show More