<!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 (version 1.7.0_80) on Tue Feb 13 20:01:23 JST 2018 -->
<title>picocli (picocli 2.3.0 API)</title>
<meta name="date" content="2018-02-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="picocli (picocli 2.3.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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>Prev Package</li>
<li><a href="../picocli/groovy/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All 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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package picocli</h1>
<div class="docSummary">
<div class="block">Provides classes and interfaces for the main picocli <a href="../picocli/CommandLine.html" title="class in picocli">command line parsing</a> and
<a href="../picocli/AutoComplete.html" title="class in picocli"><code>autocompletion</code></a> functionality.</div>
</div>
<p>See: <a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Ansi.IStyle.html" title="interface in picocli">CommandLine.Help.Ansi.IStyle</a></td>
<td class="colLast">
<div class="block">Defines the interface for an ANSI escape sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli">CommandLine.Help.IOptionRenderer</a></td>
<td class="colLast">
<div class="block">When customizing online help for <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>Option</code></a> details, a custom <code>IOptionRenderer</code> can be
used to create textual representation of an Option in a tabular format: one or more rows, each containing
one or more columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli">CommandLine.Help.IParameterRenderer</a></td>
<td class="colLast">
<div class="block">When customizing online help for <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>Parameters</code></a> details, a custom <code>IParameterRenderer</code>
can be used to create textual representation of a Parameters field in a tabular format: one or more rows,
each containing one or more columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a></td>
<td class="colLast">
<div class="block">When customizing online usage help for an option parameter or a positional parameter, a custom
<code>IParamLabelRenderer</code> can be used to render the parameter name or label to a String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.IExceptionHandler.html" title="interface in picocli">CommandLine.IExceptionHandler</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a></td>
<td class="colLast">
<div class="block">Factory for instantiating classes that are registered declaratively with annotation attributes, like
<a href="../picocli/CommandLine.Command.html#subcommands()"><code>CommandLine.Command.subcommands()</code></a>, <a href="../picocli/CommandLine.Option.html#converter()"><code>CommandLine.Option.converter()</code></a>, <a href="../picocli/CommandLine.Parameters.html#converter()"><code>CommandLine.Parameters.converter()</code></a> and <a href="../picocli/CommandLine.Command.html#versionProvider()"><code>CommandLine.Command.versionProvider()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.IParseResultHandler.html" title="interface in picocli">CommandLine.IParseResultHandler</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli">CommandLine.ITypeConverter</a><K></td>
<td class="colLast">
<div class="block">
When parsing command line arguments and initializing
fields annotated with <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>@Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>@Parameters</code></a>,
String values can be converted to any type for which a <code>ITypeConverter</code> is registered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a></td>
<td class="colLast">
<div class="block">Provides version information for a command.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></td>
<td class="colLast">
<div class="block">Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></td>
<td class="colLast">
<div class="block">
CommandLine interpreter that uses reflection to initialize an annotated domain object with values obtained from the
command line arguments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli">CommandLine.DefaultExceptionHandler</a></td>
<td class="colLast">
<div class="block">Default exception handler that prints the exception message to the specified <code>PrintStream</code>, followed by the
usage message for the command or subcommand whose input was invalid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Column.html" title="class in picocli">CommandLine.Help.Column</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a></td>
<td class="colLast">
<div class="block">Use a Layout to format usage help text for options and parameters in tabular format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></td>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.TextTable.Cell.html" title="class in picocli">CommandLine.Help.TextTable.Cell</a></td>
<td class="colLast">
<div class="block">Helper class to index positions in a <code>Help.TextTable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></td>
<td class="colLast">
<div class="block">Describes the number of parameters required and accepted by an option or a positional parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.RunAll.html" title="class in picocli">CommandLine.RunAll</a></td>
<td class="colLast">
<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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.RunFirst.html" title="class in picocli">CommandLine.RunFirst</a></td>
<td class="colLast">
<div class="block">Command line parse result handler that prints help if requested, and otherwise executes the top-level
<code>Runnable</code> or <code>Callable</code> command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.RunLast.html" title="class in picocli">CommandLine.RunLast</a></td>
<td class="colLast">
<div class="block">Command line parse result handler that prints help if requested, and otherwise executes the most specific
<code>Runnable</code> or <code>Callable</code> subcommand.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a></td>
<td class="colLast">
<div class="block">Provides methods and inner classes to support using ANSI escape codes in usage help messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a></td>
<td class="colLast">
<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
styles to strings with embedded escape codes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Help.Column.Overflow.html" title="enum in picocli">CommandLine.Help.Column.Overflow</a></td>
<td class="colLast">
<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>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli">CommandLine.DuplicateOptionAnnotationsException</a></td>
<td class="colLast">
<div class="block">Exception indicating that multiple fields have been annotated with the same Option name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.ExecutionException.html" title="class in picocli">CommandLine.ExecutionException</a></td>
<td class="colLast">
<div class="block">Exception indicating a problem while invoking a command or subcommand.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></td>
<td class="colLast">
<div class="block">Exception indicating a problem during <code>CommandLine</code> initialization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.MaxValuesforFieldExceededException.html" title="class in picocli">CommandLine.MaxValuesforFieldExceededException</a></td>
<td class="colLast">
<div class="block">Exception indicating that more values were specified for an option or parameter than its <a href="../picocli/CommandLine.Option.html#arity()"><code>arity</code></a> allows.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.MissingParameterException.html" title="class in picocli">CommandLine.MissingParameterException</a></td>
<td class="colLast">
<div class="block">Exception indicating that a required parameter was not specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.MissingTypeConverterException.html" title="class in picocli">CommandLine.MissingTypeConverterException</a></td>
<td class="colLast">
<div class="block">Exception indicating that an annotated field had a type for which no <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> was
<a href="../picocli/CommandLine.html#registerConverter(java.lang.Class,%20picocli.CommandLine.ITypeConverter)">registered</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.OverwrittenOptionException.html" title="class in picocli">CommandLine.OverwrittenOptionException</a></td>
<td class="colLast">
<div class="block">Exception indicating that an option for a single-value option field has been specified multiple times on the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.ParameterException.html" title="class in picocli">CommandLine.ParameterException</a></td>
<td class="colLast">
<div class="block">Exception indicating something went wrong while parsing command line options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.ParameterIndexGapException.html" title="class in picocli">CommandLine.ParameterIndexGapException</a></td>
<td class="colLast">
<div class="block">Exception indicating that there was a gap in the indices of the fields annotated with <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.PicocliException.html" title="class in picocli">CommandLine.PicocliException</a></td>
<td class="colLast">
<div class="block">Base class of all exceptions thrown by <code>picocli.CommandLine</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.TypeConversionException.html" title="class in picocli">CommandLine.TypeConversionException</a></td>
<td class="colLast">
<div class="block">Exception thrown by <a href="../picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><code>CommandLine.ITypeConverter</code></a> implementations to indicate a String could not be converted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.UnmatchedArgumentException.html" title="class in picocli">CommandLine.UnmatchedArgumentException</a></td>
<td class="colLast">
<div class="block">Exception indicating that a command line argument could not be mapped to any of the fields annotated with
<a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Command.html" title="annotation in picocli">CommandLine.Command</a></td>
<td class="colLast">
<div class="block">Annotate your class with <code>@Command</code> when you want more control over the format of the generated help
message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.Option.html" title="annotation in picocli">CommandLine.Option</a></td>
<td class="colLast">
<div class="block">
Annotate fields in your class with <code>@Option</code> and picocli will initialize these fields when matching
arguments are specified on the command line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli">CommandLine.Parameters</a></td>
<td class="colLast">
<div class="block">
Fields annotated with <code>@Parameters</code> will be initialized with positional parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../picocli/CommandLine.ParentCommand.html" title="annotation in picocli">CommandLine.ParentCommand</a></td>
<td class="colLast">
<div class="block">
Fields annotated with <code>@ParentCommand</code> will be initialized with the parent command of the current subcommand.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package picocli Description">Package picocli Description</h2>
<div class="block">Provides classes and interfaces for the main picocli <a href="../picocli/CommandLine.html" title="class in picocli">command line parsing</a> and
<a href="../picocli/AutoComplete.html" title="class in picocli"><code>autocompletion</code></a> functionality.
<p>
The <a href="../picocli/CommandLine.html" title="class in picocli"><code>CommandLine</code></a> class is a one-file framework for creating Java command line
applications with almost zero code.
<code>CommandLine</code> is in a single file, so it can be included in source form.
This lets users run picocli-based applications without requiring picocli as an external dependency.
</p></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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>Prev Package</li>
<li><a href="../picocli/groovy/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All 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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>