Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.3 / log4j-core / apidocs / org / apache / logging / log4j / core / tools / picocli / CommandLine.Command.html
blob: b62bdbb603ebc6d02a91da4f66c20251d23eb48b [file] [log] [blame]
<!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_144) on Sun May 10 12:47:45 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CommandLine.Command (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<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.Command (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CommandLine.Command.html">Use</a></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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.DefaultExceptionHandler.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Command.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.core.tools.picocli</div>
<h2 title="Annotation Type CommandLine.Command" class="title">Annotation Type CommandLine.Command</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#LOCAL_VARIABLE" title="class or interface in java.lang.annotation">LOCAL_VARIABLE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PACKAGE" title="class or interface in java.lang.annotation">PACKAGE</a>})
public static @interface <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.html#line.1456">CommandLine.Command</a></pre>
<div class="block"><p>Annotate your class with <code>@Command</code> when you want more control over the format of the generated help
message.
</p><pre>
&#064;Command(name = "Encrypt",
description = "Encrypt FILE(s), or standard input, to standard output or to the output file.",
footer = "Copyright (c) 2017")
public class Encrypt {
&#064;Parameters(paramLabel = "FILE", type = File.class, description = "Any number of input files")
private List&lt;File&gt; files = new ArrayList&lt;File&gt;();
&#064;Option(names = { "-o", "--out" }, description = "Output file (default: print to console)")
private File outputFile;
}</pre>
<p>
The structure of a help message looks like this:
</p><ul>
<li>[header]</li>
<li>[synopsis]: <code>Usage: &lt;commandName&gt; [OPTIONS] [FILE...]</code></li>
<li>[description]</li>
<li>[parameter list]: <code>[FILE...] Any number of input files</code></li>
<li>[option list]: <code>-h, --help prints this help message and exits</code></li>
<li>[footer]</li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#abbreviateSynopsis--">abbreviateSynopsis</a></span></code>
<div class="block">Specify <code>true</code> to generate an abbreviated synopsis like <code>"&lt;main&gt; [OPTIONS] [PARAMETERS...]"</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#commandListHeading--">commandListHeading</a></span></code>
<div class="block">Set the heading preceding the subcommands list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#customSynopsis--">customSynopsis</a></span></code>
<div class="block">Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#description--">description</a></span></code>
<div class="block">Optional text to display between the synopsis line(s) and the list of options.</div>
</td>
</tr>
<tr class="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#descriptionHeading--">descriptionHeading</a></span></code>
<div class="block">Set the heading preceding the description section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#footer--">footer</a></span></code>
<div class="block">Optional text to display after the list of options.</div>
</td>
</tr>
<tr class="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#footerHeading--">footerHeading</a></span></code>
<div class="block">Set the heading preceding the footer section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#header--">header</a></span></code>
<div class="block">Optional summary description of the command, shown before the synopsis.</div>
</td>
</tr>
<tr class="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#headerHeading--">headerHeading</a></span></code>
<div class="block">Set the heading preceding the header section.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#name--">name</a></span></code>
<div class="block">Program name to show in the synopsis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#optionListHeading--">optionListHeading</a></span></code>
<div class="block">Set the heading preceding the options list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#parameterListHeading--">parameterListHeading</a></span></code>
<div class="block">Set the heading preceding the parameters list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#requiredOptionMarker--">requiredOptionMarker</a></span></code>
<div class="block">Prefix required options with this character in the options list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#separator--">separator</a></span></code>
<div class="block">String that separates options from option parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#showDefaultValues--">showDefaultValues</a></span></code>
<div class="block">Specify <code>true</code> to show default values in the description column of the options list (except for
boolean options).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#sortOptions--">sortOptions</a></span></code>
<div class="block">Specify <code>false</code> to show Options in declaration order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#subcommands--">subcommands</a></span></code>
<div class="block">A list of classes to instantiate and register as subcommands.</div>
</td>
</tr>
<tr class="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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#synopsisHeading--">synopsisHeading</a></span></code>
<div class="block">Set the heading preceding the synopsis text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#version--">version</a></span></code>
<div class="block">Version information for this command, to print to the console when the user specifies an
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#versionHelp--">option</a> to request version help.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1462">name</a></pre>
<div class="block">Program name to show in the synopsis. If omitted, <code>"&lt;main class&gt;"</code> is used.
For <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#subcommands--">declaratively added</a> subcommands, this attribute is also used
by the parser to recognize subcommands in the command line arguments.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the program name to show in the synopsis</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandName"><code>CommandLine.Help.commandName</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"&lt;main class&gt;"</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="subcommands--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subcommands</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1489">subcommands</a></pre>
<div class="block">A list of classes to instantiate and register as subcommands. When registering subcommands declaratively
like this, you don't need to call the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-"><code>CommandLine.addSubcommand(String, Object)</code></a> method. For example, this:
<pre>
&#064;Command(subcommands = {
GitStatus.class,
GitCommit.class,
GitBranch.class })
public class Git { ... }
CommandLine commandLine = new CommandLine(new Git());
</pre> is equivalent to this:
<pre>
// alternative: programmatically add subcommands.
// NOTE: in this case there should be no `subcommands` attribute on the @Command annotation.
&#064;Command public class Git { ... }
CommandLine commandLine = new CommandLine(new Git())
.addSubcommand("status", new GitStatus())
.addSubcommand("commit", new GitCommit())
.addSubcommand("branch", new GitBranch());
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the declaratively registered subcommands of this command, or an empty array if none</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.9.8</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-"><code>CommandLine.addSubcommand(String, Object)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="separator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1495">separator</a></pre>
<div class="block">String that separates options from option parameters. Default is <code>"="</code>. Spaces are also accepted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string that separates options from option parameters, used both when parsing and when generating usage help</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#separator"><code>CommandLine.Help.separator</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#setSeparator-java.lang.String-"><code>CommandLine.setSeparator(String)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"="</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="version--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1504">version</a></pre>
<div class="block">Version information for this command, to print to the console when the user specifies an
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#versionHelp--">option</a> to request version help. This is not part of the usage help message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string or an array of strings with version information about this command.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.9.8</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#printVersionHelp-java.io.PrintStream-"><code>CommandLine.printVersionHelp(PrintStream)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="headerHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headerHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1509">headerHeading</a></pre>
<div class="block">Set the heading preceding the header section. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the header section</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#headerHeading-java.lang.Object...-"><code>CommandLine.Help.headerHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="header--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1515">header</a></pre>
<div class="block">Optional summary description of the command, shown before the synopsis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>summary description of the command</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#header"><code>CommandLine.Help.header</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#header-java.lang.Object...-"><code>CommandLine.Help.header(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="synopsisHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>synopsisHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1522">synopsisHeading</a></pre>
<div class="block">Set the heading preceding the synopsis text. May contain embedded
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>. The default heading is <code>"Usage: "</code> (without a line
break between the heading and the synopsis text).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the synopsis text</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsisHeading-java.lang.Object...-"><code>CommandLine.Help.synopsisHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"Usage: "</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="abbreviateSynopsis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abbreviateSynopsis</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1530">abbreviateSynopsis</a></pre>
<div class="block">Specify <code>true</code> to generate an abbreviated synopsis like <code>"&lt;main&gt; [OPTIONS] [PARAMETERS...]"</code>.
By default, a detailed synopsis with individual option names and parameters is generated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the synopsis should be abbreviated</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviateSynopsis"><code>CommandLine.Help.abbreviateSynopsis</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviatedSynopsis--"><code>CommandLine.Help.abbreviatedSynopsis()</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-"><code>CommandLine.Help.detailedSynopsis(Comparator, boolean)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="customSynopsis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customSynopsis</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1536">customSynopsis</a></pre>
<div class="block">Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>custom synopsis text to replace the auto-generated synopsis</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#customSynopsis"><code>CommandLine.Help.customSynopsis</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#customSynopsis-java.lang.Object...-"><code>CommandLine.Help.customSynopsis(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="descriptionHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>descriptionHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1541">descriptionHeading</a></pre>
<div class="block">Set the heading preceding the description section. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the description section</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#descriptionHeading-java.lang.Object...-"><code>CommandLine.Help.descriptionHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="description--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1547">description</a></pre>
<div class="block">Optional text to display between the synopsis line(s) and the list of options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>description of this command</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#description"><code>CommandLine.Help.description</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#description-java.lang.Object...-"><code>CommandLine.Help.description(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="parameterListHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterListHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1552">parameterListHeading</a></pre>
<div class="block">Set the heading preceding the parameters list. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the parameters list</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterListHeading-java.lang.Object...-"><code>CommandLine.Help.parameterListHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="optionListHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionListHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1557">optionListHeading</a></pre>
<div class="block">Set the heading preceding the options list. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the options list</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionListHeading-java.lang.Object...-"><code>CommandLine.Help.optionListHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="sortOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortOptions</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1562">sortOptions</a></pre>
<div class="block">Specify <code>false</code> to show Options in declaration order. The default is to sort alphabetically.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether options should be shown in alphabetic order.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#sortOptions"><code>CommandLine.Help.sortOptions</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="requiredOptionMarker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredOptionMarker</h4>
<pre>public abstract&nbsp;char&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1568">requiredOptionMarker</a></pre>
<div class="block">Prefix required options with this character in the options list. The default is no marker: the synopsis
indicates which options and parameters are required.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the character to show in the options list to mark required options</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#requiredOptionMarker"><code>CommandLine.Help.requiredOptionMarker</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>32</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="showDefaultValues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showDefaultValues</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1574">showDefaultValues</a></pre>
<div class="block">Specify <code>true</code> to show default values in the description column of the options list (except for
boolean options). False by default.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the default values for options and parameters should be shown in the description column</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#showDefaultValues"><code>CommandLine.Help.showDefaultValues</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="commandListHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commandListHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1580">commandListHeading</a></pre>
<div class="block">Set the heading preceding the subcommands list. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.
The default heading is <code>"Commands:%n"</code> (with a line break at the end).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the subcommands list</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandListHeading-java.lang.Object...-"><code>CommandLine.Help.commandListHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>"Commands:%n"</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="footerHeading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>footerHeading</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1585">footerHeading</a></pre>
<div class="block">Set the heading preceding the footer section. May contain embedded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html?is-external=true" title="class or interface in java.util">format specifiers</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the heading preceding the footer section</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footerHeading-java.lang.Object...-"><code>CommandLine.Help.footerHeading(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="footer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>footer</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#line.1591">footer</a></pre>
<div class="block">Optional text to display after the list of options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>text to display after the list of options</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footer"><code>CommandLine.Help.footer</code></a>,
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footer-java.lang.Object...-"><code>CommandLine.Help.footer(Object...)</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CommandLine.Command.html">Use</a></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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.DefaultExceptionHandler.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Command.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>