mirror of
https://github.com/jlengrand/picocli.git
synced 2026-03-10 08:41:17 +00:00
1942 lines
126 KiB
HTML
1942 lines
126 KiB
HTML
<!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 Aug 26 23:54:07 JST 2019 -->
|
|
<title>CommandLine.Model.UsageMessageSpec (picocli 4.0.3 API)</title>
|
|
<meta name="date" content="2019-08-26">
|
|
<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.Model.UsageMessageSpec (picocli 4.0.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,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":9,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="../picocli/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.Model.UnmatchedArgsBinding.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.MutuallyExclusiveArgsException.html" title="class in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.Model.UsageMessageSpec.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.Model.UsageMessageSpec.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>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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.Model.UsageMessageSpec" class="title">Class CommandLine.Model.UsageMessageSpec</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.Model.UsageMessageSpec</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>Enclosing class:</dt>
|
|
<dd><a href="../picocli/CommandLine.Model.html" title="class in picocli">CommandLine.Model</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public static class <span class="typeNameLabel">CommandLine.Model.UsageMessageSpec</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">Models the usage help message specification and can be used to customize the usage help message.
|
|
<p>
|
|
This class provides two ways to customize the usage help message:
|
|
</p>
|
|
<ul>
|
|
<li>Change the text of the predefined sections (this may also be done declaratively using the annotations)</li>
|
|
<li>Add custom sections, or remove or re-order predefined sections</li>
|
|
</ul>
|
|
<p>
|
|
The pre-defined sections have getters and setters that return a String (or array of Strings). For example:
|
|
<a href="../picocli/CommandLine.Model.UsageMessageSpec.html#description--"><code>description()</code></a> and <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#description-java.lang.String...-"><code>description(String...)</code></a> or <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#header--"><code>header()</code></a> and <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#header-java.lang.String...-"><code>header(String...)</code></a>.
|
|
</p><p>
|
|
Changing the section order, or adding custom sections can be accomplished with <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys-java.util.List-"><code>sectionKeys(List)</code></a> and <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap-java.util.Map-"><code>sectionMap(Map)</code></a>.
|
|
This gives complete freedom on how a usage help message section is rendered, but it also means that the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a>
|
|
is responsible for all aspects of rendering the section, including layout and emitting ANSI escape codes.
|
|
The <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a> and <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><code>CommandLine.Help.Ansi.Text</code></a> classes, and the <a href="../picocli/CommandLine.Help.Ansi.html#string-java.lang.String-"><code>CommandLine.Help.Ansi.string(String)</code></a> and <a href="../picocli/CommandLine.Help.Ansi.html#text-java.lang.String-"><code>CommandLine.Help.Ansi.text(String)</code></a> methods may be useful.
|
|
</p><p>
|
|
The usage help message is created more or less like this:
|
|
</p>
|
|
<pre>
|
|
// CommandLine.usage(...) or CommandLine.getUsageMessage(...)
|
|
Help.ColorScheme colorScheme = Help.defaultColorScheme(Help.Ansi.AUTO);
|
|
Help help = getHelpFactory().create(getCommandSpec(), colorScheme)
|
|
StringBuilder result = new StringBuilder();
|
|
for (String key : getHelpSectionKeys()) {
|
|
IHelpSectionRenderer renderer = getHelpSectionMap().get(key);
|
|
if (renderer != null) { result.append(renderer.render(help)); }
|
|
}
|
|
// return or print result
|
|
</pre>
|
|
<p>
|
|
Where the default <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">help section map</a> is constructed like this:</p>
|
|
<pre><code>
|
|
// The default section renderers delegate to methods in Help for their implementation
|
|
// (using Java 8 lambda notation for brevity):
|
|
Map<String, IHelpSectionRenderer> sectionMap = new HashMap<>();
|
|
sectionMap.put(SECTION_KEY_HEADER_HEADING, help -> help.headerHeading());
|
|
sectionMap.put(SECTION_KEY_HEADER, help -> help.header());
|
|
sectionMap.put(SECTION_KEY_SYNOPSIS_HEADING, help -> help.synopsisHeading()); //e.g. Usage:
|
|
sectionMap.put(SECTION_KEY_SYNOPSIS, help -> help.synopsis(help.synopsisHeadingLength())); //e.g. <cmd> [OPTIONS] <subcmd> [COMMAND-OPTIONS] [ARGUMENTS]
|
|
sectionMap.put(SECTION_KEY_DESCRIPTION_HEADING, help -> help.descriptionHeading()); //e.g. %nDescription:%n%n
|
|
sectionMap.put(SECTION_KEY_DESCRIPTION, help -> help.description()); //e.g. {"Converts foos to bars.", "Use options to control conversion mode."}
|
|
sectionMap.put(SECTION_KEY_PARAMETER_LIST_HEADING, help -> help.parameterListHeading()); //e.g. %nPositional parameters:%n%n
|
|
sectionMap.put(SECTION_KEY_PARAMETER_LIST, help -> help.parameterList()); //e.g. [FILE...] the files to convert
|
|
sectionMap.put(SECTION_KEY_OPTION_LIST_HEADING, help -> help.optionListHeading()); //e.g. %nOptions:%n%n
|
|
sectionMap.put(SECTION_KEY_OPTION_LIST, help -> help.optionList()); //e.g. -h, --help displays this help and exits
|
|
sectionMap.put(SECTION_KEY_COMMAND_LIST_HEADING, help -> help.commandListHeading()); //e.g. %nCommands:%n%n
|
|
sectionMap.put(SECTION_KEY_COMMAND_LIST, help -> help.commandList()); //e.g. add adds the frup to the frooble
|
|
sectionMap.put(SECTION_KEY_EXIT_CODE_LIST_HEADING, help -> help.exitCodeListHeading());
|
|
sectionMap.put(SECTION_KEY_EXIT_CODE_LIST, help -> help.exitCodeList());
|
|
sectionMap.put(SECTION_KEY_FOOTER_HEADING, help -> help.footerHeading());
|
|
sectionMap.put(SECTION_KEY_FOOTER, help -> help.footer());
|
|
</code></pre></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.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"> </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.Model.UsageMessageSpec.html#DEFAULT_USAGE_WIDTH">DEFAULT_USAGE_WIDTH</a></span></code>
|
|
<div class="block">Constant holding the default usage message width: <code>80</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST">SECTION_KEY_COMMAND_LIST</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Subcommand List section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST_HEADING">SECTION_KEY_COMMAND_LIST_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Subcommand List Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION">SECTION_KEY_DESCRIPTION</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Description section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION_HEADING">SECTION_KEY_DESCRIPTION_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Description Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST">SECTION_KEY_EXIT_CODE_LIST</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Exit Code List section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST_HEADING">SECTION_KEY_EXIT_CODE_LIST_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Exit Code List Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_FOOTER">SECTION_KEY_FOOTER</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Footer section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_FOOTER_HEADING">SECTION_KEY_FOOTER_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Footer Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_HEADER">SECTION_KEY_HEADER</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Header section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_HEADER_HEADING">SECTION_KEY_HEADER_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Header Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST">SECTION_KEY_OPTION_LIST</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Option List section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST_HEADING">SECTION_KEY_OPTION_LIST_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Option List Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST">SECTION_KEY_PARAMETER_LIST</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Parameter List section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST_HEADING">SECTION_KEY_PARAMETER_LIST_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Parameter List Heading section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS">SECTION_KEY_SYNOPSIS</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Synopsis section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS_HEADING">SECTION_KEY_SYNOPSIS_HEADING</a></span></code>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Synopsis Heading section.</div>
|
|
</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"> </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.Model.UsageMessageSpec.html#UsageMessageSpec--">UsageMessageSpec</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#abbreviateSynopsis--">abbreviateSynopsis</a></span>()</code>
|
|
<div class="block">Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#abbreviateSynopsis-boolean-">abbreviateSynopsis</a></span>(boolean newValue)</code>
|
|
<div class="block">Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.</div>
|
|
</td>
|
|
</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.UsageMessageSpec.html#adjustLineBreaksForWideCJKCharacters--">adjustLineBreaksForWideCJKCharacters</a></span>()</code>
|
|
<div class="block">Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#adjustLineBreaksForWideCJKCharacters-boolean-">adjustLineBreaksForWideCJKCharacters</a></span>(boolean adjustForWideChars)</code>
|
|
<div class="block">Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.</div>
|
|
</td>
|
|
</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.UsageMessageSpec.html#autoWidth--">autoWidth</a></span>()</code>
|
|
<div class="block">Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width
|
|
to take the full terminal width.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#autoWidth-boolean-">autoWidth</a></span>(boolean detectTerminalSize)</code>
|
|
<div class="block">Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width
|
|
to take the full terminal width.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" 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.Model.UsageMessageSpec.html#commandListHeading--">commandListHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the subcommand list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#commandListHeading-java.lang.String-">commandListHeading</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> newValue)</code>
|
|
<div class="block">Sets the optional heading preceding the subcommand list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" 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.Model.UsageMessageSpec.html#customSynopsis--">customSynopsis</a></span>()</code>
|
|
<div class="block">Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#customSynopsis-java.lang.String...-">customSynopsis</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>... customSynopsis)</code>
|
|
<div class="block">Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" 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.Model.UsageMessageSpec.html#description--">description</a></span>()</code>
|
|
<div class="block">Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the
|
|
options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.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>... description)</code>
|
|
<div class="block">Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the
|
|
options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" 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.Model.UsageMessageSpec.html#descriptionHeading--">descriptionHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the description section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#descriptionHeading-java.lang.String-">descriptionHeading</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> newValue)</code>
|
|
<div class="block">Sets the heading preceding the description section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<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><<a href="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="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.UsageMessageSpec.html#exitCodeList--">exitCodeList</a></span>()</code>
|
|
<div class="block">Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#exitCodeList-java.util.Map-">exitCodeList</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><<a href="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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> newValue)</code>
|
|
<div class="block">Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.</div>
|
|
</td>
|
|
</tr>
|
|
<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.Model.UsageMessageSpec.html#exitCodeListHeading--">exitCodeListHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the exit codes section, may contain <code>"%n"</code> line separators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#exitCodeListHeading-java.lang.String-">exitCodeListHeading</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> newValue)</code>
|
|
<div class="block">Sets the optional heading preceding the exit codes section, may contain <code>"%n"</code> line separators.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" 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.Model.UsageMessageSpec.html#footer--">footer</a></span>()</code>
|
|
<div class="block">Returns the optional footer text lines displayed at the bottom of the help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#footer-java.lang.String...-">footer</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>... footer)</code>
|
|
<div class="block">Sets the optional footer text lines displayed at the bottom of the help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" 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.Model.UsageMessageSpec.html#footerHeading--">footerHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the footer section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#footerHeading-java.lang.String-">footerHeading</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> newValue)</code>
|
|
<div class="block">Sets the optional heading preceding the footer section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" 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.Model.UsageMessageSpec.html#header--">header</a></span>()</code>
|
|
<div class="block">Returns the optional header lines displayed at the top of the help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#header-java.lang.String...-">header</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>... header)</code>
|
|
<div class="block">Sets the optional header lines displayed at the top of the help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" 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.Model.UsageMessageSpec.html#headerHeading--">headerHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the header section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#headerHeading-java.lang.String-">headerHeading</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> headerHeading)</code>
|
|
<div class="block">Sets the heading preceding the header section.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli">CommandLine.IHelpFactory</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#helpFactory--">helpFactory</a></span>()</code>
|
|
<div class="block">Returns the <code>IHelpFactory</code> that is used to construct the usage help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#helpFactory-picocli.CommandLine.IHelpFactory-">helpFactory</a></span>(<a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli">CommandLine.IHelpFactory</a> helpFactory)</code>
|
|
<div class="block">Sets a new <code>IHelpFactory</code> to customize the usage help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#hidden--">hidden</a></span>()</code>
|
|
<div class="block">Returns whether this command should be hidden from the usage help message of the parent command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#hidden-boolean-">hidden</a></span>(boolean value)</code>
|
|
<div class="block">Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code>static <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><<a href="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="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.UsageMessageSpec.html#keyValuesMap-java.lang.String...-">keyValuesMap</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>... entries)</code>
|
|
<div class="block">Creates and returns a <code>Map</code> that contains an entry for each specified String that is in <code>"key:value"</code> format.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages--">messages</a></span>()</code>
|
|
<div class="block">Returns the Messages for this usage help message specification, or <code>null</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages-picocli.CommandLine.Model.Messages-">messages</a></span>(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a> msgs)</code>
|
|
<div class="block">Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" 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.Model.UsageMessageSpec.html#optionListHeading--">optionListHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#optionListHeading-java.lang.String-">optionListHeading</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> newValue)</code>
|
|
<div class="block">Sets the heading preceding the options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" 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.Model.UsageMessageSpec.html#parameterListHeading--">parameterListHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the parameter list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#parameterListHeading-java.lang.String-">parameterListHeading</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> newValue)</code>
|
|
<div class="block">Sets the optional heading preceding the parameter list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code>char</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#requiredOptionMarker--">requiredOptionMarker</a></span>()</code>
|
|
<div class="block">Returns the character used to prefix required options in the options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#requiredOptionMarker-char-">requiredOptionMarker</a></span>(char newValue)</code>
|
|
<div class="block">Sets the character used to prefix required options in the options list.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" 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><<a href="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.UsageMessageSpec.html#sectionKeys--">sectionKeys</a></span>()</code>
|
|
<div class="block">Returns the section keys in the order that the usage help message should render the sections.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys-java.util.List-">sectionKeys</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><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> keys)</code>
|
|
<div class="block">Sets the section keys in the order that the usage help message should render the sections.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<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><<a href="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.IHelpSectionRenderer.html" title="interface in picocli">CommandLine.IHelpSectionRenderer</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">sectionMap</a></span>()</code>
|
|
<div class="block">Returns the map of section keys and renderers used to construct the usage help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap-java.util.Map-">sectionMap</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><<a href="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.IHelpSectionRenderer.html" title="interface in picocli">CommandLine.IHelpSectionRenderer</a>> map)</code>
|
|
<div class="block">Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#showDefaultValues--">showDefaultValues</a></span>()</code>
|
|
<div class="block">Returns whether the options list in the usage help message should show default values for all non-boolean options.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#showDefaultValues-boolean-">showDefaultValues</a></span>(boolean newValue)</code>
|
|
<div class="block">Sets whether the options list in the usage help message should show default values for all non-boolean options.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sortOptions--">sortOptions</a></span>()</code>
|
|
<div class="block">Returns whether the options list in the usage help message should be sorted alphabetically.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sortOptions-boolean-">sortOptions</a></span>(boolean newValue)</code>
|
|
<div class="block">Sets whether the options list in the usage help message should be sorted alphabetically.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold--">synopsisAutoIndentThreshold</a></span>()</code>
|
|
<div class="block">Returns the fraction of the usage help <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> that is the threshold up to which
|
|
the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold-double-">synopsisAutoIndentThreshold</a></span>(double newValue)</code>
|
|
<div class="block">Sets the fraction of the usage help <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> that is the threshold up to which
|
|
the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.</div>
|
|
</td>
|
|
</tr>
|
|
<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.Model.UsageMessageSpec.html#synopsisHeading--">synopsisHeading</a></span>()</code>
|
|
<div class="block">Returns the optional heading preceding the synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisHeading-java.lang.String-">synopsisHeading</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> newValue)</code>
|
|
<div class="block">Sets the optional heading preceding the synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisIndent--">synopsisIndent</a></span>()</code>
|
|
<div class="block">Returns the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis
|
|
when the length of the synopsis heading and the fully qualified command name exceed the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> times the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold--"><code>synopsisAutoIndentThreshold()</code></a>, <code>-1</code> by default.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisIndent-int-">synopsisIndent</a></span>(int newValue)</code>
|
|
<div class="block">Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis
|
|
when the length of the synopsis heading and the fully qualified command name exceed the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold--"><code>synopsisAutoIndentThreshold()</code></a> fraction of the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a>, <code>-1</code> by default.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i53" 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.Model.UsageMessageSpec.html#synopsisSubcommandLabel--">synopsisSubcommandLabel</a></span>()</code>
|
|
<div class="block">Returns the String representing the subcommands in the synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i54" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisSubcommandLabel-java.lang.String-">synopsisSubcommandLabel</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> newValue)</code>
|
|
<div class="block">Sets the String representing the subcommands in the synopsis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i55" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--">width</a></span>()</code>
|
|
<div class="block">Returns the maximum usage help message width.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i56" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width-int-">width</a></span>(int newValue)</code>
|
|
<div class="block">Sets the maximum usage help message width to the specified value.</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 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="SECTION_KEY_HEADER_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_HEADER_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_HEADER_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Header Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#headerHeading-java.lang.Object...-"><code>CommandLine.Help.headerHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_HEADER_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_HEADER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_HEADER</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_HEADER</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Header section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#header-java.lang.Object...-"><code>CommandLine.Help.header(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_HEADER">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_SYNOPSIS_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_SYNOPSIS_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_SYNOPSIS_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Synopsis Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#synopsisHeading-java.lang.Object...-"><code>CommandLine.Help.synopsisHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_SYNOPSIS_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_SYNOPSIS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_SYNOPSIS</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_SYNOPSIS</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Synopsis section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#synopsis-int-"><code>CommandLine.Help.synopsis(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_SYNOPSIS">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_DESCRIPTION_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_DESCRIPTION_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_DESCRIPTION_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Description Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#descriptionHeading-java.lang.Object...-"><code>CommandLine.Help.descriptionHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_DESCRIPTION_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_DESCRIPTION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_DESCRIPTION</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_DESCRIPTION</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Description section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#description-java.lang.Object...-"><code>CommandLine.Help.description(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_DESCRIPTION">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_PARAMETER_LIST_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_PARAMETER_LIST_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_PARAMETER_LIST_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Parameter List Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#parameterListHeading-java.lang.Object...-"><code>CommandLine.Help.parameterListHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_PARAMETER_LIST_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_PARAMETER_LIST">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_PARAMETER_LIST</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_PARAMETER_LIST</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Parameter List section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#parameterList--"><code>CommandLine.Help.parameterList()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_PARAMETER_LIST">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_OPTION_LIST_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_OPTION_LIST_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_OPTION_LIST_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Option List Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#optionListHeading-java.lang.Object...-"><code>CommandLine.Help.optionListHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_OPTION_LIST">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_OPTION_LIST</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_OPTION_LIST</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Option List section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#optionList--"><code>CommandLine.Help.optionList()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_COMMAND_LIST_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_COMMAND_LIST_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_COMMAND_LIST_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Subcommand List Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#commandListHeading-java.lang.Object...-"><code>CommandLine.Help.commandListHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_COMMAND_LIST">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_COMMAND_LIST</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_COMMAND_LIST</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Subcommand List section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#commandList--"><code>CommandLine.Help.commandList()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_COMMAND_LIST">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_EXIT_CODE_LIST_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_EXIT_CODE_LIST_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_EXIT_CODE_LIST_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Exit Code List Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#exitCodeListHeading-java.lang.Object...-"><code>CommandLine.Help.exitCodeListHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_EXIT_CODE_LIST_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_EXIT_CODE_LIST">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_EXIT_CODE_LIST</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_EXIT_CODE_LIST</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Exit Code List section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#exitCodeList--"><code>CommandLine.Help.exitCodeList()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_EXIT_CODE_LIST">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_FOOTER_HEADING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_FOOTER_HEADING</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_FOOTER_HEADING</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Footer Heading section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#footerHeading-java.lang.Object...-"><code>CommandLine.Help.footerHeading(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_FOOTER_HEADING">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="SECTION_KEY_FOOTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SECTION_KEY_FOOTER</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SECTION_KEY_FOOTER</pre>
|
|
<div class="block"><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--">Section key</a> to <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionMap--">control</a> the <a href="../picocli/CommandLine.IHelpSectionRenderer.html" title="interface in picocli">section renderer</a> for the Footer section.
|
|
The default renderer for this section calls <a href="../picocli/CommandLine.Help.html#footer-java.lang.Object...-"><code>CommandLine.Help.footer(Object...)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_FOOTER">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="DEFAULT_USAGE_WIDTH">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DEFAULT_USAGE_WIDTH</h4>
|
|
<pre>public static final int DEFAULT_USAGE_WIDTH</pre>
|
|
<div class="block">Constant holding the default usage message width: <code>80</code>.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../constant-values.html#picocli.CommandLine.Model.UsageMessageSpec.DEFAULT_USAGE_WIDTH">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="UsageMessageSpec--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>UsageMessageSpec</h4>
|
|
<pre>public UsageMessageSpec()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="width-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>width</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> width(int newValue)</pre>
|
|
<div class="block">Sets the maximum usage help message width to the specified value. Longer values are wrapped.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>newValue</code> - the new maximum usage help message width. Must be 55 or greater.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <code>UsageMessageSpec</code> for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<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 width is less than 55</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="width--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>width</h4>
|
|
<pre>public int width()</pre>
|
|
<div class="block">Returns the maximum usage help message width. Derived from system property <code>"picocli.usage.width"</code>
|
|
if set, otherwise returns the value set via the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width-int-"><code>width(int)</code></a> method, or if not set, the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#DEFAULT_USAGE_WIDTH">default width</a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the maximum usage help message width. Never returns less than 55.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="autoWidth--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>autoWidth</h4>
|
|
<pre>public boolean autoWidth()</pre>
|
|
<div class="block">Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width
|
|
to take the full terminal width. End users may enable this by setting system property <code>"picocli.usage.width"</code> to <code>AUTO</code>,
|
|
and may disable this by setting this system property to a <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--">numeric value</a>.
|
|
This feature requires Java 7 or greater. The default is <code>false</code>.</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.Command.html#usageHelpAutoWidth--"><code>CommandLine.Command.usageHelpAutoWidth()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="autoWidth-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>autoWidth</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> autoWidth(boolean detectTerminalSize)</pre>
|
|
<div class="block">Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width
|
|
to take the full terminal width. The default is <code>false</code>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>detectTerminalSize</code> - whether picocli should attempt to detect the terminal size</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Command.html#usageHelpAutoWidth--"><code>CommandLine.Command.usageHelpAutoWidth()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="sectionKeys--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sectionKeys</h4>
|
|
<pre>public <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><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> sectionKeys()</pre>
|
|
<div class="block">Returns the section keys in the order that the usage help message should render the sections.
|
|
This ordering may be modified with the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys-java.util.List-"><code>sectionKeys setter</code></a>. The default keys are (in order):
|
|
<ol start="0">
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_HEADER_HEADING"><code>SECTION_KEY_HEADER_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_HEADER"><code>SECTION_KEY_HEADER</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS_HEADING"><code>SECTION_KEY_SYNOPSIS_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_SYNOPSIS"><code>SECTION_KEY_SYNOPSIS</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION_HEADING"><code>SECTION_KEY_DESCRIPTION_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_DESCRIPTION"><code>SECTION_KEY_DESCRIPTION</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST_HEADING"><code>SECTION_KEY_PARAMETER_LIST_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_PARAMETER_LIST"><code>SECTION_KEY_PARAMETER_LIST</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST_HEADING"><code>SECTION_KEY_OPTION_LIST_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_OPTION_LIST"><code>SECTION_KEY_OPTION_LIST</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST_HEADING"><code>SECTION_KEY_COMMAND_LIST_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_COMMAND_LIST"><code>SECTION_KEY_COMMAND_LIST</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST_HEADING"><code>SECTION_KEY_EXIT_CODE_LIST_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_EXIT_CODE_LIST"><code>SECTION_KEY_EXIT_CODE_LIST</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_FOOTER_HEADING"><code>SECTION_KEY_FOOTER_HEADING</code></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#SECTION_KEY_FOOTER"><code>SECTION_KEY_FOOTER</code></a></li>
|
|
</ol></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="sectionKeys-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sectionKeys</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> sectionKeys(<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><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> keys)</pre>
|
|
<div class="block">Sets the section keys in the order that the usage help message should render the sections.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys"><code>sectionKeys</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="sectionMap--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sectionMap</h4>
|
|
<pre>public <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><<a href="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.IHelpSectionRenderer.html" title="interface in picocli">CommandLine.IHelpSectionRenderer</a>> sectionMap()</pre>
|
|
<div class="block">Returns the map of section keys and renderers used to construct the usage help message.
|
|
The usage help message can be customized by adding, replacing and removing section renderers from this map.
|
|
Sections can be reordered with the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys-java.util.List-"><code>sectionKeys setter</code></a>.
|
|
Sections that are either not in this map or not in the list returned by <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys--"><code>sectionKeys</code></a> are omitted.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys"><code>sectionKeys</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="sectionMap-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sectionMap</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> sectionMap(<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><<a href="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.IHelpSectionRenderer.html" title="interface in picocli">CommandLine.IHelpSectionRenderer</a>> map)</pre>
|
|
<div class="block">Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>map</code> - the mapping of section keys to their renderers, must be non-<code>null</code>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#sectionKeys"><code>sectionKeys</code></a>,
|
|
<a href="../picocli/CommandLine.html#setHelpSectionMap-java.util.Map-"><code>CommandLine.setHelpSectionMap(Map)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="helpFactory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>helpFactory</h4>
|
|
<pre>public <a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli">CommandLine.IHelpFactory</a> helpFactory()</pre>
|
|
<div class="block">Returns the <code>IHelpFactory</code> that is used to construct the usage help message.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.html#setHelpFactory-picocli.CommandLine.IHelpFactory-"><code>CommandLine.setHelpFactory(IHelpFactory)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="helpFactory-picocli.CommandLine.IHelpFactory-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>helpFactory</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> helpFactory(<a href="../picocli/CommandLine.IHelpFactory.html" title="interface in picocli">CommandLine.IHelpFactory</a> helpFactory)</pre>
|
|
<div class="block">Sets a new <code>IHelpFactory</code> to customize the usage help message.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>helpFactory</code> - the new help factory. Must be non-<code>null</code>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <code>UsageMessageSpec</code> object, to allow method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="headerHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>headerHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> headerHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the header section. Initialized from <a href="../picocli/CommandLine.Command.html#headerHeading--"><code>CommandLine.Command.headerHeading()</code></a>, or <code>""</code> (empty string).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="header--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>header</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] header()</pre>
|
|
<div class="block">Returns the optional header lines displayed at the top of the help message. For subcommands, the first header line is
|
|
displayed in the list of commands. Values are initialized from <a href="../picocli/CommandLine.Command.html#header--"><code>CommandLine.Command.header()</code></a>
|
|
if the <code>Command</code> annotation is present, otherwise this is an empty array and the help message has no
|
|
header. Applications may programmatically set this field to create a custom help message.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> synopsisHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the synopsis. Initialized from <a href="../picocli/CommandLine.Command.html#synopsisHeading--"><code>CommandLine.Command.synopsisHeading()</code></a>, <code>"Usage: "</code> by default.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisSubcommandLabel--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisSubcommandLabel</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> synopsisSubcommandLabel()</pre>
|
|
<div class="block">Returns the String representing the subcommands in the synopsis. Initialized from <a href="../picocli/CommandLine.Command.html#synopsisSubcommandLabel--"><code>CommandLine.Command.synopsisSubcommandLabel()</code></a>, <code>"[COMMANDS]"</code> by default.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisAutoIndentThreshold--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisAutoIndentThreshold</h4>
|
|
<pre>public double synopsisAutoIndentThreshold()</pre>
|
|
<div class="block">Returns the fraction of the usage help <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> that is the threshold up to which
|
|
the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
|
|
The default value of this attribute is <code>0.5</code>.
|
|
If the length of the synopsis heading plus the length of the fully qualified command name exceeds this fraction of the width,
|
|
the 2nd and subsequent rows of a multi-line synopsis will be aligned to the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisIndent--"><code>synopsisIndent()</code></a> instead of the end of the command name.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisIndent--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisIndent</h4>
|
|
<pre>public int synopsisIndent()</pre>
|
|
<div class="block">Returns the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis
|
|
when the length of the synopsis heading and the fully qualified command name exceed the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> times the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold--"><code>synopsisAutoIndentThreshold()</code></a>, <code>-1</code> by default.
|
|
A negative value for this option means that the 2nd line and subsequent lines are aligned to the synopsis heading length.
|
|
A positive value means the exact number of spaces to indent for the 2nd line and subsequent lines of the synopsis.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="abbreviateSynopsis--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>abbreviateSynopsis</h4>
|
|
<pre>public boolean abbreviateSynopsis()</pre>
|
|
<div class="block">Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="customSynopsis--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>customSynopsis</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] customSynopsis()</pre>
|
|
<div class="block">Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.
|
|
Initialized from <a href="../picocli/CommandLine.Command.html#customSynopsis--"><code>CommandLine.Command.customSynopsis()</code></a> if the <code>Command</code> annotation is present,
|
|
otherwise this is an empty array and the synopsis is generated.
|
|
Applications may programmatically set this field to create a custom help message.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="descriptionHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>descriptionHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> descriptionHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the description section. Initialized from <a href="../picocli/CommandLine.Command.html#descriptionHeading--"><code>CommandLine.Command.descriptionHeading()</code></a>, or null.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="description--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>description</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] description()</pre>
|
|
<div class="block">Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the
|
|
options list. Initialized from <a href="../picocli/CommandLine.Command.html#description--"><code>CommandLine.Command.description()</code></a> if the <code>Command</code> annotation is present,
|
|
otherwise this is an empty array and the help message has no description.
|
|
Applications may programmatically set this field to create a custom help message.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="parameterListHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parameterListHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> parameterListHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the parameter list. Initialized from <a href="../picocli/CommandLine.Command.html#parameterListHeading--"><code>CommandLine.Command.parameterListHeading()</code></a>, or null.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="optionListHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>optionListHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> optionListHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the options list. Initialized from <a href="../picocli/CommandLine.Command.html#optionListHeading--"><code>CommandLine.Command.optionListHeading()</code></a>, or null.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="sortOptions--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sortOptions</h4>
|
|
<pre>public boolean sortOptions()</pre>
|
|
<div class="block">Returns whether the options list in the usage help message should be sorted alphabetically.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="requiredOptionMarker--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>requiredOptionMarker</h4>
|
|
<pre>public char requiredOptionMarker()</pre>
|
|
<div class="block">Returns the character used to prefix required options in the options list.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="showDefaultValues--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showDefaultValues</h4>
|
|
<pre>public boolean showDefaultValues()</pre>
|
|
<div class="block">Returns whether the options list in the usage help message should show default values for all non-boolean options.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="hidden--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hidden</h4>
|
|
<pre>public boolean hidden()</pre>
|
|
<div class="block">Returns whether this command should be hidden from the usage help message of the parent command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><code>true</code> if this command should not appear in the usage help message of the parent command</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="commandListHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>commandListHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commandListHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the subcommand list. Initialized from <a href="../picocli/CommandLine.Command.html#commandListHeading--"><code>CommandLine.Command.commandListHeading()</code></a>. <code>"Commands:%n"</code> by default.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeListHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeListHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> exitCodeListHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the exit codes section, may contain <code>"%n"</code> line separators. <code>""</code> (empty string) by default.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeList--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeList</h4>
|
|
<pre>public <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><<a href="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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> exitCodeList()</pre>
|
|
<div class="block">Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
|
|
Descriptions may contain <code>"%n"</code> line separators.
|
|
Callers may be interested in the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#keyValuesMap-java.lang.String...-"><code>keyValuesMap</code></a> method for creating a map from a list of <code>"key:value"</code> Strings.
|
|
<p>This may be configured in a resource bundle by listing up multiple <code>"key:value"</code> pairs. For example:</p>
|
|
<pre>
|
|
usage.exitCodeList.0 = 0:Successful program execution.
|
|
usage.exitCodeList.1 = 64:Invalid input: an unknown option or invalid parameter was specified.
|
|
usage.exitCodeList.2 = 70:Execution exception: an exception occurred while executing the business logic.
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an unmodifiable map with values to be displayed in the exit codes section, or an empty map if no exit codes are <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#exitCodeList-java.util.Map-">registered</a>.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#keyValuesMap-java.lang.String...-"><code>keyValuesMap(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="keyValuesMap-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>keyValuesMap</h4>
|
|
<pre>public static <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><<a href="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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> keyValuesMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... entries)</pre>
|
|
<div class="block">Creates and returns a <code>Map</code> that contains an entry for each specified String that is in <code>"key:value"</code> format.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>entries</code> - the strings to process; values that are not in <code>"key:value"</code> format are ignored</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a <code>Map</code> with an entry for each line, preserving the input order</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="footerHeading--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>footerHeading</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> footerHeading()</pre>
|
|
<div class="block">Returns the optional heading preceding the footer section. Initialized from <a href="../picocli/CommandLine.Command.html#footerHeading--"><code>CommandLine.Command.footerHeading()</code></a>, or <code>""</code> (empty string).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="footer--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>footer</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] footer()</pre>
|
|
<div class="block">Returns the optional footer text lines displayed at the bottom of the help message. Initialized from
|
|
<a href="../picocli/CommandLine.Command.html#footer--"><code>CommandLine.Command.footer()</code></a> if the <code>Command</code> annotation is present, otherwise this is an empty array and
|
|
the help message has no footer.
|
|
Applications may programmatically set this field to create a custom help message.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="headerHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>headerHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> headerHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> headerHeading)</pre>
|
|
<div class="block">Sets the heading preceding the header section. Initialized from <a href="../picocli/CommandLine.Command.html#headerHeading--"><code>CommandLine.Command.headerHeading()</code></a>, or null.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="header-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>header</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> header(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... header)</pre>
|
|
<div class="block">Sets the optional header lines displayed at the top of the help message. For subcommands, the first header line is
|
|
displayed in the list of commands.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> synopsisHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the optional heading preceding the synopsis.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisSubcommandLabel-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisSubcommandLabel</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> synopsisSubcommandLabel(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the String representing the subcommands in the synopsis.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisAutoIndentThreshold-double-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisAutoIndentThreshold</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> synopsisAutoIndentThreshold(double newValue)</pre>
|
|
<div class="block">Sets the fraction of the usage help <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a> that is the threshold up to which
|
|
the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
|
|
The default value of this attribute is <code>0.5</code>.
|
|
If the length of the synopsis heading plus the length of the fully qualified command name exceeds this fraction of the width,
|
|
the 2nd and subsequent rows of a multi-line synopsis will be aligned to the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisIndent--"><code>synopsisIndent()</code></a> instead of the end of the command name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>newValue</code> - the new threshold value. Must be a value between 0.0 and 0.9, inclusive</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<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 value is less than 0.0 or greater than 0.9</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="synopsisIndent-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>synopsisIndent</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> synopsisIndent(int newValue)</pre>
|
|
<div class="block">Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis
|
|
when the length of the synopsis heading and the fully qualified command name exceed the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#synopsisAutoIndentThreshold--"><code>synopsisAutoIndentThreshold()</code></a> fraction of the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#width--"><code>width()</code></a>, <code>-1</code> by default.
|
|
A negative value for this option means that the 2nd line and subsequent lines are aligned to the synopsis heading length.
|
|
A positive value means the exact number of spaces to indent for the 2nd line and subsequent lines of the synopsis.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="abbreviateSynopsis-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>abbreviateSynopsis</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> abbreviateSynopsis(boolean newValue)</pre>
|
|
<div class="block">Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="customSynopsis-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>customSynopsis</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> customSynopsis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... customSynopsis)</pre>
|
|
<div class="block">Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="descriptionHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>descriptionHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> descriptionHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the heading preceding the description section.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="description-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>description</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> 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>... description)</pre>
|
|
<div class="block">Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the
|
|
options list.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="parameterListHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parameterListHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> parameterListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the optional heading preceding the parameter list.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="optionListHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>optionListHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> optionListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the heading preceding the options list.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="sortOptions-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>sortOptions</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> sortOptions(boolean newValue)</pre>
|
|
<div class="block">Sets whether the options list in the usage help message should be sorted alphabetically.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="requiredOptionMarker-char-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>requiredOptionMarker</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> requiredOptionMarker(char newValue)</pre>
|
|
<div class="block">Sets the character used to prefix required options in the options list.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="showDefaultValues-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showDefaultValues</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> showDefaultValues(boolean newValue)</pre>
|
|
<div class="block">Sets whether the options list in the usage help message should show default values for all non-boolean options.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hidden-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hidden</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> hidden(boolean value)</pre>
|
|
<div class="block">Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - enable or disable the hidden flag</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Command.html#hidden--"><code>CommandLine.Command.hidden()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="commandListHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>commandListHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> commandListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the optional heading preceding the subcommand list.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeListHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeListHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> exitCodeListHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the optional 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>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeList-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeList</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> exitCodeList(<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><<a href="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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> newValue)</pre>
|
|
<div class="block">Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
|
|
Descriptions may contain <code>"%n"</code> line separators.
|
|
<p>This may be configured in a resource bundle by listing up multiple <code>"key:value"</code> pairs. For example:</p>
|
|
<pre>
|
|
usage.exitCodeList.0 = 0:Successful program execution.
|
|
usage.exitCodeList.1 = 64:Invalid input: an unknown option or invalid parameter was specified.
|
|
usage.exitCodeList.2 = 70:Execution exception: an exception occurred while executing the business logic.
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>newValue</code> - a map with values to be displayed in the exit codes section</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.UsageMessageSpec.html#keyValuesMap-java.lang.String...-"><code>keyValuesMap(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="footerHeading-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>footerHeading</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> footerHeading(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newValue)</pre>
|
|
<div class="block">Sets the optional heading preceding the footer section.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="footer-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>footer</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> footer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... footer)</pre>
|
|
<div class="block">Sets the optional footer text lines displayed at the bottom of the help message.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this UsageMessageSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="messages--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>messages</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a> messages()</pre>
|
|
<div class="block">Returns the Messages for this usage help message specification, or <code>null</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the Messages object that encapsulates this <a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundle--">command's resource bundle</a></dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="messages-picocli.CommandLine.Model.Messages-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>messages</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> messages(<a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">CommandLine.Model.Messages</a> msgs)</pre>
|
|
<div class="block">Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>msgs</code> - the new Messages value that encapsulates this <a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundle--">command's resource bundle</a>, may be <code>null</code></dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="adjustLineBreaksForWideCJKCharacters--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>adjustLineBreaksForWideCJKCharacters</h4>
|
|
<pre>public boolean adjustLineBreaksForWideCJKCharacters()</pre>
|
|
<div class="block">Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if wide Chinese, Japanese and Korean characters are counted as double the size of other characters for line-breaking purposes</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="adjustLineBreaksForWideCJKCharacters-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>adjustLineBreaksForWideCJKCharacters</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> adjustLineBreaksForWideCJKCharacters(boolean adjustForWideChars)</pre>
|
|
<div class="block">Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>adjustForWideChars</code> - if true, wide Chinese, Japanese and Korean characters are counted as double the size of other characters for line-breaking purposes</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</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="../picocli/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.Model.UnmatchedArgsBinding.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.MutuallyExclusiveArgsException.html" title="class in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.Model.UsageMessageSpec.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.Model.UsageMessageSpec.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>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|