<!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:22 JST 2018 -->
<title>CommandLine.Command (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="CommandLine.Command (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><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.html" title="class in picocli"><span class="strong">Prev Class</span></a></li>
<li><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Command.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Command.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Required | </li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation_type_element_detail">Element</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="Annotation Type CommandLine.Command" class="title">Annotation Type CommandLine.Command</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={TYPE,LOCAL_VARIABLE,PACKAGE})
public static @interface <span class="strong">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.
</p><pre>
@Command(name = "Encrypt",
description = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
version = "Encrypt version 1.0",
footer = "Copyright (c) 2017")
public class Encrypt {
@Parameters(paramLabel = "FILE", description = "Any number of input files")
private List<File> files = new ArrayList<File>();
@Option(names = { "-o", "--out" }, description = "Output file (default: print to console)")
private File outputFile;
@Option(names = { "-v", "--verbose"}, description = "Verbose mode. Helpful for troubleshooting. Multiple -v options increase the verbosity.")
private boolean[] verbose;
@Option(names = { "-h", "--help" }, usageHelp = true, description = "Display this help and exit")
private boolean help;
@Option(names = { "-V", "--version"}, versionHelp = true, description = "Display version information and exit")
private boolean version;
}</pre>
<p>
The structure of a help message looks like this:
</p><ul>
<li>[header]</li>
<li>[synopsis]: <code>Usage: <commandName> [OPTIONS] [FILE...]</code></li>
<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>[footer]</li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_optional_element_summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#abbreviateSynopsis()">abbreviateSynopsis</a></strong></code>
<div class="block">Specify <code>true</code> to generate an abbreviated synopsis like <code>"<main> [OPTIONS] [PARAMETERS...]"</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#commandListHeading()">commandListHeading</a></strong></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="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#customSynopsis()">customSynopsis</a></strong></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.String[]</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#description()">description</a></strong></code>
<div class="block">Optional text to display between the synopsis line(s) and the list of options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#descriptionHeading()">descriptionHeading</a></strong></code>
<div class="block">Set the heading preceding the description section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#footer()">footer</a></strong></code>
<div class="block">Optional text to display after the list of options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#footerHeading()">footerHeading</a></strong></code>
<div class="block">Set the heading preceding the footer section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#header()">header</a></strong></code>
<div class="block">Optional summary description of the command, shown before the synopsis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#headerHeading()">headerHeading</a></strong></code>
<div class="block">Set the heading preceding the header section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#name()">name</a></strong></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>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#optionListHeading()">optionListHeading</a></strong></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>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#parameterListHeading()">parameterListHeading</a></strong></code>
<div class="block">Set the heading preceding the parameters list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#requiredOptionMarker()">requiredOptionMarker</a></strong></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>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#separator()">separator</a></strong></code>
<div class="block">String that separates options from option parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#showDefaultValues()">showDefaultValues</a></strong></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="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#sortOptions()">sortOptions</a></strong></code>
<div class="block">Specify <code>false</code> to show Options in declaration order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#subcommands()">subcommands</a></strong></code>
<div class="block">A list of classes to instantiate and register as subcommands.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#synopsisHeading()">synopsisHeading</a></strong></code>
<div class="block">Set the heading preceding the synopsis text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#version()">version</a></strong></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<? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>></code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Command.html#versionProvider()">versionProvider</a></strong></code>
<div class="block">Class that can provide version information dynamically at runtime.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_element_detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract java.lang.String name</pre>
<div class="block">Program name to show in the synopsis. If omitted, <code>"<main class>"</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>
<dl><dt><span class="strong">Returns:</span></dt><dd>the program name to show in the synopsis</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#commandName"><code>CommandLine.Help.commandName</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>"<main class>"</dd>
</dl>
</li>
</ul>
<a name="subcommands()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subcommands</h4>
<pre>public abstract java.lang.Class<?>[] 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,%20java.lang.Object)"><code>CommandLine.addSubcommand(String, Object)</code></a> method. For example, this:
<pre>
@Command(subcommands = {
GitStatus.class,
GitCommit.class,
GitBranch.class })
public class Git { ... }
CommandLine commandLine = new CommandLine(new Git());
</pre> is equivalent to this:
<pre>
// alternative: programmatically add subcommands.
// NOTE: in this case there should be no `subcommands` attribute on the @Command annotation.
@Command public class Git { ... }
CommandLine commandLine = new CommandLine(new Git())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("branch", new GitBranch());
</pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the declaratively registered subcommands of this command, or an empty array if none</dd><dt><span class="strong">Since:</span></dt>
<dd>0.9.8</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.html#addSubcommand(java.lang.String,%20java.lang.Object)"><code>CommandLine.addSubcommand(String, Object)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="separator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public abstract java.lang.String 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="strong">Returns:</span></dt><dd>the string that separates options from option parameters, used both when parsing and when generating usage help</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#separator"><code>CommandLine.Help.separator</code></a>,
<a href="../picocli/CommandLine.html#setSeparator(java.lang.String)"><code>CommandLine.setSeparator(String)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>"="</dd>
</dl>
</li>
</ul>
<a name="version()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public abstract java.lang.String[] 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. This is not part of the usage help message.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a string or an array of strings with version information about this command (each string in the array is displayed on a separate line).</dd><dt><span class="strong">Since:</span></dt>
<dd>0.9.8</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.html#printVersionHelp(java.io.PrintStream)"><code>CommandLine.printVersionHelp(PrintStream)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="versionProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>versionProvider</h4>
<pre>public abstract java.lang.Class<? extends <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a>> 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><dt><span class="strong">Returns:</span></dt><dd>a Class that can provide version information dynamically at runtime</dd></dl>
<dl>
<dt>Default:</dt>
<dd>picocli.CommandLine.NoVersionProvider.class</dd>
</dl>
</li>
</ul>
<a name="headerHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headerHeading</h4>
<pre>public abstract java.lang.String headerHeading</pre>
<div class="block">Set the heading preceding the header section. May contain embedded format specifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the header section</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#headerHeading(java.lang.Object...)"><code>CommandLine.Help.headerHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
<a name="header()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public abstract java.lang.String[] header</pre>
<div class="block">Optional summary description of the command, shown before the synopsis.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>summary description of the command</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#header"><code>CommandLine.Help.header</code></a>,
<a href="../picocli/CommandLine.Help.html#header(java.lang.Object...)"><code>CommandLine.Help.header(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="synopsisHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>synopsisHeading</h4>
<pre>public abstract java.lang.String synopsisHeading</pre>
<div class="block">Set the heading preceding the synopsis text. May contain embedded
format specifiers. The default heading is <code>"Usage: "</code> (without a line
break between the heading and the synopsis text).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the synopsis text</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#synopsisHeading(java.lang.Object...)"><code>CommandLine.Help.synopsisHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>"Usage: "</dd>
</dl>
</li>
</ul>
<a name="abbreviateSynopsis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abbreviateSynopsis</h4>
<pre>public abstract boolean abbreviateSynopsis</pre>
<div class="block">Specify <code>true</code> to generate an abbreviated synopsis like <code>"<main> [OPTIONS] [PARAMETERS...]"</code>.
By default, a detailed synopsis with individual option names and parameters is generated.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the synopsis should be abbreviated</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#abbreviateSynopsis"><code>CommandLine.Help.abbreviateSynopsis</code></a>,
<a href="../picocli/CommandLine.Help.html#abbreviatedSynopsis()"><code>CommandLine.Help.abbreviatedSynopsis()</code></a>,
<a href="../picocli/CommandLine.Help.html#detailedSynopsis(java.util.Comparator,%20boolean)"><code>CommandLine.Help.detailedSynopsis(Comparator, boolean)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
<a name="customSynopsis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customSynopsis</h4>
<pre>public abstract java.lang.String[] customSynopsis</pre>
<div class="block">Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>custom synopsis text to replace the auto-generated synopsis</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#customSynopsis"><code>CommandLine.Help.customSynopsis</code></a>,
<a href="../picocli/CommandLine.Help.html#customSynopsis(java.lang.Object...)"><code>CommandLine.Help.customSynopsis(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="descriptionHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>descriptionHeading</h4>
<pre>public abstract java.lang.String descriptionHeading</pre>
<div class="block">Set the heading preceding the description section. May contain embedded format specifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the description section</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#descriptionHeading(java.lang.Object...)"><code>CommandLine.Help.descriptionHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
<a name="description()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract java.lang.String[] description</pre>
<div class="block">Optional text to display between the synopsis line(s) and the list of options.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>description of this command</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#description"><code>CommandLine.Help.description</code></a>,
<a href="../picocli/CommandLine.Help.html#description(java.lang.Object...)"><code>CommandLine.Help.description(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
<a name="parameterListHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterListHeading</h4>
<pre>public abstract java.lang.String parameterListHeading</pre>
<div class="block">Set the heading preceding the parameters list. May contain embedded format specifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the parameters list</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#parameterListHeading(java.lang.Object...)"><code>CommandLine.Help.parameterListHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
<a name="optionListHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionListHeading</h4>
<pre>public abstract java.lang.String optionListHeading</pre>
<div class="block">Set the heading preceding the options list. May contain embedded format specifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the options list</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#optionListHeading(java.lang.Object...)"><code>CommandLine.Help.optionListHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
<a name="sortOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortOptions</h4>
<pre>public abstract boolean sortOptions</pre>
<div class="block">Specify <code>false</code> to show Options in declaration order. The default is to sort alphabetically.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether options should be shown in alphabetic order.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#sortOptions"><code>CommandLine.Help.sortOptions</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
<a name="requiredOptionMarker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredOptionMarker</h4>
<pre>public abstract char requiredOptionMarker</pre>
<div class="block">Prefix required options with this character in the options list. The default is no marker: the synopsis
indicates which options and parameters are required.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the character to show in the options list to mark required options</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#requiredOptionMarker"><code>CommandLine.Help.requiredOptionMarker</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>32</dd>
</dl>
</li>
</ul>
<a name="showDefaultValues()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showDefaultValues</h4>
<pre>public abstract boolean showDefaultValues</pre>
<div class="block">Specify <code>true</code> to show default values in the description column of the options list (except for
boolean options). False by default.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the default values for options and parameters should be shown in the description column</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#showDefaultValues"><code>CommandLine.Help.showDefaultValues</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
<a name="commandListHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandListHeading</h4>
<pre>public abstract java.lang.String commandListHeading</pre>
<div class="block">Set the heading preceding the subcommands list. May contain embedded format specifiers.
The default heading is <code>"Commands:%n"</code> (with a line break at the end).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the subcommands list</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#commandListHeading(java.lang.Object...)"><code>CommandLine.Help.commandListHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>"Commands:%n"</dd>
</dl>
</li>
</ul>
<a name="footerHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>footerHeading</h4>
<pre>public abstract java.lang.String footerHeading</pre>
<div class="block">Set the heading preceding the footer section. May contain embedded format specifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the heading preceding the footer section</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#footerHeading(java.lang.Object...)"><code>CommandLine.Help.footerHeading(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
<a name="footer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>footer</h4>
<pre>public abstract java.lang.String[] footer</pre>
<div class="block">Optional text to display after the list of options.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>text to display after the list of options</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.html#footer"><code>CommandLine.Help.footer</code></a>,
<a href="../picocli/CommandLine.Help.html#footer(java.lang.Object...)"><code>CommandLine.Help.footer(Object...)</code></a></dd></dl>
<dl>
<dt>Default:</dt>
<dd>{}</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><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><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.html" title="class in picocli"><span class="strong">Prev Class</span></a></li>
<li><a href="../picocli/CommandLine.DefaultExceptionHandler.html" title="class in picocli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Command.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Command.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Required | </li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation_type_element_detail">Element</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>