mirror of
https://github.com/jlengrand/picocli.git
synced 2026-03-10 08:41:17 +00:00
370 lines
20 KiB
HTML
370 lines
20 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.HelpCommand (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.HelpCommand (picocli 4.0.3 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":42,"i1":10,"i2":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
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.Help.Visibility.html" title="enum in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.HelpCommand.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.HelpCommand.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>Field | </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>Field | </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.HelpCommand" class="title">Class CommandLine.HelpCommand</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.HelpCommand</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Enclosing class:</dt>
|
|
<dd><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public static final class <span class="typeNameLabel">CommandLine.HelpCommand</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>
|
|
implements <a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a>, <a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre>
|
|
<div class="block">Help command that can be installed as a subcommand on all application commands. When invoked with a subcommand
|
|
argument, it prints usage help for the specified subcommand. For example:<pre>
|
|
|
|
// print help for subcommand
|
|
command help subcommand
|
|
</pre><p>
|
|
When invoked without additional parameters, it prints usage help for the parent command. For example:
|
|
</p><pre>
|
|
|
|
// print help for command
|
|
command help
|
|
</pre>
|
|
For <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli">internationalization</a>: this command has a <code>--help</code> option with <code>descriptionKey = "helpCommand.help"</code>,
|
|
and a <code>COMMAND</code> positional parameter with <code>descriptionKey = "helpCommand.command"</code>.</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">
|
|
<!-- ======== 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.HelpCommand.html#HelpCommand--">HelpCommand</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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> helpCommandLine,
|
|
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a> ansi,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> err)</code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">init</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> helpCommandLine,
|
|
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> out,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> err)</code>
|
|
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.HelpCommand.html#run--">run</a></span>()</code>
|
|
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-"><code>usage</code></a> for the specified command, or for the parent command.</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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="HelpCommand--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>HelpCommand</h4>
|
|
<pre>public HelpCommand()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="run--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>run</h4>
|
|
<pre>public void run()</pre>
|
|
<div class="block">Invokes <a href="../picocli/CommandLine.html#usage-java.io.PrintStream-picocli.CommandLine.Help.ColorScheme-"><code>usage</code></a> for the specified command, or for the parent command.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>init</h4>
|
|
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
public void init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> helpCommandLine,
|
|
<a href="../picocli/CommandLine.Help.Ansi.html" title="enum in picocli">CommandLine.Help.Ansi</a> ansi,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> err)</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
|
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.IHelpCommandInitializable.html#init-picocli.CommandLine-picocli.CommandLine.Help.Ansi-java.io.PrintStream-java.io.PrintStream-">init</a></code> in interface <code><a href="../picocli/CommandLine.IHelpCommandInitializable.html" title="interface in picocli">CommandLine.IHelpCommandInitializable</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>helpCommandLine</code> - the <code>CommandLine</code> object associated with this help command. Implementors can use
|
|
this to walk the command hierarchy and get access to the help command's parent and sibling commands.</dd>
|
|
<dd><code>ansi</code> - whether to use Ansi colors or not</dd>
|
|
<dd><code>out</code> - the stream to print the usage help message to</dd>
|
|
<dd><code>err</code> - the error stream to print any diagnostic messages to, in addition to the output from the exception handler</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>init</h4>
|
|
<pre>public void init(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> helpCommandLine,
|
|
<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> out,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> err)</pre>
|
|
<div class="block">Initializes this object with the information needed to implement a help command that provides usage help for other commands.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.IHelpCommandInitializable2.html#init-picocli.CommandLine-picocli.CommandLine.Help.ColorScheme-java.io.PrintWriter-java.io.PrintWriter-">init</a></code> in interface <code><a href="../picocli/CommandLine.IHelpCommandInitializable2.html" title="interface in picocli">CommandLine.IHelpCommandInitializable2</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>helpCommandLine</code> - the <code>CommandLine</code> object associated with this help command. Implementors can use
|
|
this to walk the command hierarchy and get access to the help command's parent and sibling commands.</dd>
|
|
<dd><code>colorScheme</code> - the color scheme to use when printing help, including whether to use Ansi colors or not</dd>
|
|
<dd><code>out</code> - the output writer to print the usage help message to</dd>
|
|
<dd><code>err</code> - the error writer to print any diagnostic messages to, in addition to the output from the exception handler</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</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.Help.Visibility.html" title="enum in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.HelpCommand.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.HelpCommand.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>Field | </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>Field | </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>
|