mirror of
https://github.com/jlengrand/picocli.git
synced 2026-03-10 08:41:17 +00:00
1884 lines
121 KiB
HTML
1884 lines
121 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 May 13 21:10:48 JST 2019 -->
|
|
<title>CommandLine.Model.CommandSpec (picocli 4.0.0-alpha-3 API)</title>
|
|
<meta name="date" content="2019-05-13">
|
|
<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.CommandSpec (picocli 4.0.0-alpha-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":9,"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":10,"i31":9,"i32":9,"i33":9,"i34":9,"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,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":9};
|
|
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="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.ArgSpec.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.IAnnotatedElement.html" title="interface in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.Model.CommandSpec.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.Model.CommandSpec.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>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.CommandSpec" class="title">Class CommandLine.Model.CommandSpec</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.CommandSpec</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.CommandSpec</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">The <code>CommandSpec</code> class models a command specification, including the options, positional parameters and subcommands
|
|
supported by the command, as well as attributes for the version help message and the usage help message of the command.
|
|
<p>
|
|
Picocli views a command line application as a hierarchy of commands: there is a top-level command (usually the Java
|
|
class with the <code>main</code> method) with optionally a set of command line options, positional parameters and subcommands.
|
|
Subcommands themselves can have options, positional parameters and nested sub-subcommands to any level of depth.
|
|
</p><p>
|
|
The object model has a corresponding hierarchy of <code>CommandSpec</code> objects, each with a set of <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli"><code>CommandLine.Model.OptionSpec</code></a>,
|
|
<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli"><code>CommandLine.Model.PositionalParamSpec</code></a> and <a href="../picocli/CommandLine.html" title="class in picocli">subcommands</a> associated with it.
|
|
This object model is used by the picocli command line interpreter and help message generator.
|
|
</p><p>Picocli can construct a <code>CommandSpec</code> automatically from classes with <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>@Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>@Option</code></a> and
|
|
<a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>@Parameters</code></a> annotations. Alternatively a <code>CommandSpec</code> can be constructed programmatically.
|
|
</p></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">
|
|
<!-- ========== 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><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#add-picocli.CommandLine.Model.ArgSpec-">add</a></span>(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a> arg)</code>
|
|
<div class="block">Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addArgGroup-picocli.CommandLine.Model.ArgGroupSpec-">addArgGroup</a></span>(<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a> group)</code>
|
|
<div class="block">Adds the specified <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">argument group</a> to the groups in this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addMethodSubcommands--">addMethodSubcommands</a></span>()</code>
|
|
<div class="block">Reflects on the class of the <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
|
|
(class methods annotated with <code>@Command</code>) as subcommands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addMethodSubcommands-picocli.CommandLine.IFactory-">addMethodSubcommands</a></span>(<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</code>
|
|
<div class="block">Reflects on the class of the <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
|
|
(class methods annotated with <code>@Command</code>) as subcommands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addMixin-java.lang.String-picocli.CommandLine.Model.CommandSpec-">addMixin</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> name,
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> mixin)</code>
|
|
<div class="block">Adds the specified mixin <code>CommandSpec</code> object to the map of mixins for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addOption-picocli.CommandLine.Model.OptionSpec-">addOption</a></span>(<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a> option)</code>
|
|
<div class="block">Adds the specified option spec to the list of configured arguments to expect.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addPositional-picocli.CommandLine.Model.PositionalParamSpec-">addPositional</a></span>(<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a> positional)</code>
|
|
<div class="block">Adds the specified positional parameter spec to the list of configured arguments to expect.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine.Model.CommandSpec-">addSubcommand</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> name,
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> subcommand)</code>
|
|
<div class="block">Adds the specified subcommand with the specified name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine-">addSubcommand</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> name,
|
|
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> subCommandLine)</code>
|
|
<div class="block">Adds the specified subcommand with the specified name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#addUnmatchedArgsBinding-picocli.CommandLine.Model.UnmatchedArgsBinding-">addUnmatchedArgsBinding</a></span>(<a href="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli">CommandLine.Model.UnmatchedArgsBinding</a> spec)</code>
|
|
<div class="block">Adds the specified <code>UnmatchedArgsBinding</code> to the list of model objects to capture unmatched arguments for this command.</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.CommandSpec.html#aliases--">aliases</a></span>()</code>
|
|
<div class="block">Returns the alias command names of this subcommand.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#aliases-java.lang.String...-">aliases</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>... aliases)</code>
|
|
<div class="block">Sets the alternative names by which this subcommand is recognized on the command line.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<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="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#argGroups--">argGroups</a></span>()</code>
|
|
<div class="block">Returns the <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">argument groups</a> in this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" 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="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#args--">args</a></span>()</code>
|
|
<div class="block">Returns the list of all options and positional parameters configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#commandLine--">commandLine</a></span>()</code>
|
|
<div class="block">Returns the CommandLine constructed with this <code>CommandSpec</code> model.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#commandLine-picocli.CommandLine-">commandLine</a></span>(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> commandLine)</code>
|
|
<div class="block">Sets the CommandLine constructed with this <code>CommandSpec</code> model.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#create--">create</a></span>()</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> without any associated user object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#defaultValueProvider--">defaultValueProvider</a></span>()</code>
|
|
<div class="block">Returns the default value provider for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#defaultValueProvider-picocli.CommandLine.IDefaultValueProvider-">defaultValueProvider</a></span>(<a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a> defaultValueProvider)</code>
|
|
<div class="block">Sets default value provider for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnExecutionException--">exitCodeOnExecutionException</a></span>()</code>
|
|
<div class="block">Returns exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnExecutionException-int-">exitCodeOnExecutionException</a></span>(int newValue)</code>
|
|
<div class="block">Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnInvalidInput--">exitCodeOnInvalidInput</a></span>()</code>
|
|
<div class="block">Returns exit code for command line usage error.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnInvalidInput-int-">exitCodeOnInvalidInput</a></span>(int newValue)</code>
|
|
<div class="block">Sets exit code for command line usage error.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnSuccess--">exitCodeOnSuccess</a></span>()</code>
|
|
<div class="block">Returns exit code for successful termination.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnSuccess-int-">exitCodeOnSuccess</a></span>(int newValue)</code>
|
|
<div class="block">Sets exit code for successful termination.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnUsageHelp--">exitCodeOnUsageHelp</a></span>()</code>
|
|
<div class="block">Returns exit code for successful termination after printing usage help on user request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnUsageHelp-int-">exitCodeOnUsageHelp</a></span>(int newValue)</code>
|
|
<div class="block">Sets exit code for successful termination after printing usage help on user request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnVersionHelp--">exitCodeOnVersionHelp</a></span>()</code>
|
|
<div class="block">Returns exit code for successful termination after printing version help on user request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#exitCodeOnVersionHelp-int-">exitCodeOnVersionHelp</a></span>(int newValue)</code>
|
|
<div class="block">Sets exit code for successful termination after printing version help on user request.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#findOption-char-">findOption</a></span>(char shortName)</code>
|
|
<div class="block">Returns the option with the specified short name, or <code>null</code> if no option with that name is defined for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#findOption-java.lang.String-">findOption</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> name)</code>
|
|
<div class="block">Returns the option with the specified name, or <code>null</code> if no option with that name is defined for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#forAnnotatedObject-java.lang.Object-">forAnnotatedObject</a></span>(<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> userObject)</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#forAnnotatedObject-java.lang.Object-picocli.CommandLine.IFactory-">forAnnotatedObject</a></span>(<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> userObject,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#forAnnotatedObjectLenient-java.lang.Object-">forAnnotatedObjectLenient</a></span>(<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> userObject)</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#forAnnotatedObjectLenient-java.lang.Object-picocli.CommandLine.IFactory-">forAnnotatedObjectLenient</a></span>(<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> userObject,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#helpCommand--">helpCommand</a></span>()</code>
|
|
<div class="block">Returns whether this subcommand is a help command, and required options and positional
|
|
parameters of the parent command should not be validated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#helpCommand-boolean-">helpCommand</a></span>(boolean newValue)</code>
|
|
<div class="block">Sets whether this is a help command and required parameter checking should be suspended.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#interpolateVariables--">interpolateVariables</a></span>()</code>
|
|
<div class="block">Returns whether whether variables should be interpolated in String values.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#interpolateVariables-java.lang.Boolean-">interpolateVariables</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> interpolate)</code>
|
|
<div class="block">Sets whether whether variables should be interpolated in String values.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#isAddMethodSubcommands--">isAddMethodSubcommands</a></span>()</code>
|
|
<div class="block">Returns whether method commands should be added as subcommands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" 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="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#mixins--">mixins</a></span>()</code>
|
|
<div class="block">Returns a map of the mixin names to mixin <code>CommandSpec</code> objects configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#mixinStandardHelpOptions--">mixinStandardHelpOptions</a></span>()</code>
|
|
<div class="block">Returns <code>true</code> if the standard help options have been mixed in with this command, <code>false</code> otherwise.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#mixinStandardHelpOptions-boolean-">mixinStandardHelpOptions</a></span>(boolean newValue)</code>
|
|
<div class="block">Sets whether the standard help options should be mixed in with this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" 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.CommandSpec.html#name--">name</a></span>()</code>
|
|
<div class="block">Returns name of this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#name-java.lang.String-">name</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> name)</code>
|
|
<div class="block">Sets the String to use as the program name in the synopsis line of the help message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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.CommandSpec.html#names--">names</a></span>()</code>
|
|
<div class="block">Returns all names of this command, including <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name()</code></a> and <a href="../picocli/CommandLine.Model.CommandSpec.html#aliases--"><code>aliases()</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<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="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#options--">options</a></span>()</code>
|
|
<div class="block">Returns the list of options configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" 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.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#optionsMap--">optionsMap</a></span>()</code>
|
|
<div class="block">Returns a map of the option names to option spec objects configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#parent--">parent</a></span>()</code>
|
|
<div class="block">Returns the parent command of this subcommand, or <code>null</code> if this is a top-level command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i49" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#parent-picocli.CommandLine.Model.CommandSpec-">parent</a></span>(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> parent)</code>
|
|
<div class="block">Sets the parent command of this subcommand.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#parser--">parser</a></span>()</code>
|
|
<div class="block">Returns the parser specification for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#parser-picocli.CommandLine.Model.ParserSpec-">parser</a></span>(<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a> settings)</code>
|
|
<div class="block">Initializes the parser specification for this command from the specified settings and returns this commandSpec.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<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="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#positionalParameters--">positionalParameters</a></span>()</code>
|
|
<div class="block">Returns the list of positional parameters configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i53" 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/Character.html?is-external=true" title="class or interface in java.lang">Character</a>,<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#posixOptionsMap--">posixOptionsMap</a></span>()</code>
|
|
<div class="block">Returns a map of the short (single character) option names to option spec objects configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i54" 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.CommandSpec.html#qualifiedName--">qualifiedName</a></span>()</code>
|
|
<div class="block">Returns the String to use as the program name in the synopsis line of the help message:
|
|
this command's <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name</code></a>, preceded by the qualified name of the parent command, if any, separated by a space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i55" 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.CommandSpec.html#qualifiedName-java.lang.String-">qualifiedName</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> separator)</code>
|
|
<div class="block">Returns this command's fully qualified name, which is its <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name</code></a>, preceded by the qualified name of the parent command, if this command has a parent command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i56" class="altColor">
|
|
<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="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#requiredArgs--">requiredArgs</a></span>()</code>
|
|
<div class="block">Returns the list of required options and positional parameters configured for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i57" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundle--">resourceBundle</a></span>()</code>
|
|
<div class="block">Returns the resource bundle for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i58" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundle-java.util.ResourceBundle-">resourceBundle</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> bundle)</code>
|
|
<div class="block">Initializes the resource bundle for this command: sets the <code>UsageMessageSpec.messages</code> to
|
|
a <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli"><code>Messages</code></a> object created from this command spec and the specified bundle, and then sets the
|
|
<code>ArgSpec.messages</code> of all options and positional parameters in this command
|
|
to the same <code>Messages</code> instance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i59" 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.CommandSpec.html#resourceBundleBaseName--">resourceBundleBaseName</a></span>()</code>
|
|
<div class="block">Returns the resource bundle base name for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i60" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundleBaseName-java.lang.String-">resourceBundleBaseName</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> resourceBundleBaseName)</code>
|
|
<div class="block">Initializes the resource bundle for this command: sets the <code>UsageMessageSpec.messages</code> to
|
|
a <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli"><code>Messages</code></a> object created from this command spec and the specified bundle, and then sets the
|
|
<code>ArgSpec.messages</code> of all options and positional parameters in this command
|
|
to the same <code>Messages</code> instance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i61" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#setAddMethodSubcommands-java.lang.Boolean-">setAddMethodSubcommands</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> addMethodSubcommands)</code>
|
|
<div class="block">Sets whether method commands should be added as subcommands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i62" 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="../picocli/CommandLine.html" title="class in picocli">CommandLine</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#subcommands--">subcommands</a></span>()</code>
|
|
<div class="block">Returns a read-only view of the subcommand map.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i63" 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.CommandSpec.html#toString--">toString</a></span>()</code>
|
|
<div class="block">Returns a string representation of this command, used in error messages and trace messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i64" class="altColor">
|
|
<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="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli">CommandLine.Model.UnmatchedArgsBinding</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#unmatchedArgsBindings--">unmatchedArgsBindings</a></span>()</code>
|
|
<div class="block">Returns the list of <a href="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli"><code>UnmatchedArgumentsBindings</code></a> configured for this command;
|
|
each <code>UnmatchedArgsBinding</code> captures the arguments that could not be matched to any options or positional parameters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i65" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#updateCommandAttributes-picocli.CommandLine.Command-picocli.CommandLine.IFactory-">updateCommandAttributes</a></span>(<a href="../picocli/CommandLine.Command.html" title="annotation in picocli">CommandLine.Command</a> cmd,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</code>
|
|
<div class="block">Updates the following attributes from the specified <code>@Command</code> annotation:
|
|
aliases, <a href="../picocli/CommandLine.Model.ParserSpec.html#separator--"><code>parser separator</code></a>, command name, version, help command,
|
|
version provider, default provider and <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli"><code>usage message spec</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i66" 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.CommandSpec.html#usageMessage--">usageMessage</a></span>()</code>
|
|
<div class="block">Returns the usage help message specification for this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i67" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#usageMessage-picocli.CommandLine.Model.UsageMessageSpec-">usageMessage</a></span>(<a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> settings)</code>
|
|
<div class="block">Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i68" class="altColor">
|
|
<td class="colFirst"><code><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></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">userObject</a></span>()</code>
|
|
<div class="block">Returns the user object associated with this command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i69" 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.CommandSpec.html#version--">version</a></span>()</code>
|
|
<div class="block">Returns version information for this command, to print to the console when the user specifies an
|
|
<a href="../picocli/CommandLine.Model.OptionSpec.html#versionHelp--">option</a> to request version help.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i70" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#version-java.lang.String...-">version</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>... version)</code>
|
|
<div class="block">Sets version information literals for this command, to print to the console when the user specifies an
|
|
<a href="../picocli/CommandLine.Model.OptionSpec.html#versionHelp--">option</a> to request version help.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i71" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#versionProvider--">versionProvider</a></span>()</code>
|
|
<div class="block">Returns the version provider for this command, to generate the <a href="../picocli/CommandLine.Model.CommandSpec.html#version--"><code>version()</code></a> strings.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i72" class="altColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#versionProvider-picocli.CommandLine.IVersionProvider-">versionProvider</a></span>(<a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a> versionProvider)</code>
|
|
<div class="block">Sets version provider for this command, to generate the <a href="../picocli/CommandLine.Model.CommandSpec.html#version--"><code>version()</code></a> strings.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i73" class="rowColor">
|
|
<td class="colFirst"><code><a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#withToString-java.lang.String-">withToString</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 representation of this command, used in error messages and trace messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i74" class="altColor">
|
|
<td class="colFirst"><code>static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../picocli/CommandLine.Model.CommandSpec.html#wrapWithoutInspection-java.lang.Object-">wrapWithoutInspection</a></span>(<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> userObject)</code>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> with the specified associated user object.</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#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">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="create--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> create()</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> without any associated user object.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="wrapWithoutInspection-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>wrapWithoutInspection</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> wrapWithoutInspection(<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> userObject)</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> with the specified associated user object.
|
|
The specified user object is <em>not</em> inspected for annotations.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>userObject</code> - the associated user object. May be any object, may be <code>null</code>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forAnnotatedObject-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forAnnotatedObject</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> forAnnotatedObject(<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> userObject)</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object. The specified
|
|
user object must have at least one <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotation.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>userObject</code> - the user object annotated with <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> and/or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified object has no picocli annotations or has invalid annotations</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forAnnotatedObject-java.lang.Object-picocli.CommandLine.IFactory-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forAnnotatedObject</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> forAnnotatedObject(<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> userObject,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object. The specified
|
|
user object must have at least one <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotation.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>userObject</code> - the user object annotated with <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> and/or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations.</dd>
|
|
<dd><code>factory</code> - the factory used to create instances of <a href="../picocli/CommandLine.Command.html#subcommands--">subcommands</a>, <a href="../picocli/CommandLine.Option.html#converter--">converters</a>, etc., that are registered declaratively with annotation attributes</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified object has no picocli annotations or has invalid annotations</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forAnnotatedObjectLenient-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forAnnotatedObjectLenient</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> forAnnotatedObjectLenient(<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> userObject)</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object. If the specified
|
|
user object has no <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations, an empty <code>CommandSpec</code> is returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>userObject</code> - the user object annotated with <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> and/or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified object has invalid annotations</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forAnnotatedObjectLenient-java.lang.Object-picocli.CommandLine.IFactory-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forAnnotatedObjectLenient</h4>
|
|
<pre>public static <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> forAnnotatedObjectLenient(<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> userObject,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</pre>
|
|
<div class="block">Creates and returns a new <code>CommandSpec</code> initialized from the specified associated user object. If the specified
|
|
user object has no <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations, an empty <code>CommandSpec</code> is returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>userObject</code> - the user object annotated with <a href="../picocli/CommandLine.Command.html" title="annotation in picocli"><code>CommandLine.Command</code></a>, <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> and/or <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> annotations.</dd>
|
|
<dd><code>factory</code> - the factory used to create instances of <a href="../picocli/CommandLine.Command.html#subcommands--">subcommands</a>, <a href="../picocli/CommandLine.Option.html#converter--">converters</a>, etc., that are registered declaratively with annotation attributes</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified object has invalid annotations</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="userObject--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>userObject</h4>
|
|
<pre>public <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> userObject()</pre>
|
|
<div class="block">Returns the user object associated with this command.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.html#getCommand--"><code>CommandLine.getCommand()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="commandLine--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>commandLine</h4>
|
|
<pre>public <a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> commandLine()</pre>
|
|
<div class="block">Returns the CommandLine constructed with this <code>CommandSpec</code> model.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="commandLine-picocli.CommandLine-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>commandLine</h4>
|
|
<pre>protected <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> commandLine(<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> commandLine)</pre>
|
|
<div class="block">Sets the CommandLine constructed with this <code>CommandSpec</code> model.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="parser--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parser</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a> parser()</pre>
|
|
<div class="block">Returns the parser specification for this command.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="parser-picocli.CommandLine.Model.ParserSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parser</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> parser(<a href="../picocli/CommandLine.Model.ParserSpec.html" title="class in picocli">CommandLine.Model.ParserSpec</a> settings)</pre>
|
|
<div class="block">Initializes the parser specification for this command from the specified settings and returns this commandSpec.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="usageMessage--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>usageMessage</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> usageMessage()</pre>
|
|
<div class="block">Returns the usage help message specification for this command.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="usageMessage-picocli.CommandLine.Model.UsageMessageSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>usageMessage</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> usageMessage(<a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli">CommandLine.Model.UsageMessageSpec</a> settings)</pre>
|
|
<div class="block">Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="resourceBundleBaseName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resourceBundleBaseName</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> resourceBundleBaseName()</pre>
|
|
<div class="block">Returns the resource bundle base name for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the resource bundle base name from the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages--">CommandLine.Model.UsageMessageSpec.messages()</a></dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="resourceBundleBaseName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resourceBundleBaseName</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> resourceBundleBaseName(<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> resourceBundleBaseName)</pre>
|
|
<div class="block">Initializes the resource bundle for this command: sets the <code>UsageMessageSpec.messages</code> to
|
|
a <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli"><code>Messages</code></a> object created from this command spec and the specified bundle, and then sets the
|
|
<code>ArgSpec.messages</code> of all options and positional parameters in this command
|
|
to the same <code>Messages</code> instance. Subcommands are not modified.
|
|
<p>This method is preferable to <a href="../picocli/CommandLine.Model.CommandSpec.html#resourceBundle-java.util.ResourceBundle-"><code>resourceBundle(ResourceBundle)</code></a> for pre-Java 8</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>resourceBundleBaseName</code> - the base name of the ResourceBundle to set, may be <code>null</code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this commandSpec</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.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine-"><code>addSubcommand(String, CommandLine)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="resourceBundle--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resourceBundle</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> resourceBundle()</pre>
|
|
<div class="block">Returns the resource bundle for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the resource bundle from the <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages--">CommandLine.Model.UsageMessageSpec.messages()</a></dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="resourceBundle-java.util.ResourceBundle-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resourceBundle</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> resourceBundle(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> bundle)</pre>
|
|
<div class="block">Initializes the resource bundle for this command: sets the <code>UsageMessageSpec.messages</code> to
|
|
a <a href="../picocli/CommandLine.Model.Messages.html" title="class in picocli"><code>Messages</code></a> object created from this command spec and the specified bundle, and then sets the
|
|
<code>ArgSpec.messages</code> of all options and positional parameters in this command
|
|
to the same <code>Messages</code> instance. Subcommands are not modified.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>bundle</code> - the ResourceBundle to set, may be <code>null</code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this commandSpec</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine-"><code>addSubcommand(String, CommandLine)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="subcommands--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>subcommands</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.html" title="class in picocli">CommandLine</a>> subcommands()</pre>
|
|
<div class="block">Returns a read-only view of the subcommand map.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="addSubcommand-java.lang.String-picocli.CommandLine.Model.CommandSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addSubcommand</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addSubcommand(<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> name,
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> subcommand)</pre>
|
|
<div class="block">Adds the specified subcommand with the specified name.
|
|
If the specified subcommand does not have a ResourceBundle set, it is initialized to the ResourceBundle of this command spec.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - subcommand name - the preferred subcommand name to register the subcommand under.
|
|
If <code>null</code>, the <a href="../picocli/CommandLine.Model.CommandSpec.html#name--">name</a> of the specified subcommand is used;
|
|
if this is also <code>null</code>, the first <a href="../picocli/CommandLine.Model.CommandSpec.html#aliases--">alias</a> is used.
|
|
When this String is encountered in the command line arguments, the subcommand is invoked.</dd>
|
|
<dd><code>subcommand</code> - describes the subcommand to envoke when the name is encountered on the command line</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <code>CommandSpec</code> object for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified name is <code>null</code>, and no alternative name could be found,
|
|
or if another subcommand was already registered under the same name, or if one of the aliases
|
|
of the specified subcommand was already used by another subcommand.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addSubcommand-java.lang.String-picocli.CommandLine-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addSubcommand</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addSubcommand(<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> name,
|
|
<a href="../picocli/CommandLine.html" title="class in picocli">CommandLine</a> subCommandLine)</pre>
|
|
<div class="block">Adds the specified subcommand with the specified name.
|
|
If the specified subcommand does not have a ResourceBundle set, it is initialized to the ResourceBundle of this command spec.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - subcommand name - the preferred subcommand name to register the subcommand under.
|
|
If <code>null</code>, the <a href="../picocli/CommandLine.html#getCommandName--">name</a> of the specified subcommand is used;
|
|
if this is also <code>null</code>, the first <a href="../picocli/CommandLine.Model.CommandSpec.html#aliases--">alias</a> is used.
|
|
When this String is encountered in the command line arguments, the subcommand is invoked.</dd>
|
|
<dd><code>subCommandLine</code> - the subcommand to envoke when the name is encountered on the command line</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <code>CommandSpec</code> object for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified name is <code>null</code>, and no alternative name could be found,
|
|
or if another subcommand was already registered under the same name, or if one of the aliases
|
|
of the specified subcommand was already used by another subcommand.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isAddMethodSubcommands--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isAddMethodSubcommands</h4>
|
|
<pre>public boolean isAddMethodSubcommands()</pre>
|
|
<div class="block">Returns whether method commands should be added as subcommands. True by default. Used by the annotation processor.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setAddMethodSubcommands-java.lang.Boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAddMethodSubcommands</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> setAddMethodSubcommands(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> addMethodSubcommands)</pre>
|
|
<div class="block">Sets whether method commands should be added as subcommands. True by default. Used by the annotation processor.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="interpolateVariables--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>interpolateVariables</h4>
|
|
<pre>public boolean interpolateVariables()</pre>
|
|
<div class="block">Returns whether whether variables should be interpolated in String values. True by default.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="interpolateVariables-java.lang.Boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>interpolateVariables</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> interpolateVariables(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> interpolate)</pre>
|
|
<div class="block">Sets whether whether variables should be interpolated in String values. True by default.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addMethodSubcommands--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addMethodSubcommands</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addMethodSubcommands()</pre>
|
|
<div class="block">Reflects on the class of the <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
|
|
(class methods annotated with <code>@Command</code>) as subcommands.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli"><code>CommandLine.Model.CommandSpec</code></a> object for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><code>#addMethodSubcommands(IFactory)</code>,
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine-"><code>addSubcommand(String, CommandLine)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addMethodSubcommands-picocli.CommandLine.IFactory-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addMethodSubcommands</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addMethodSubcommands(<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</pre>
|
|
<div class="block">Reflects on the class of the <a href="../picocli/CommandLine.Model.CommandSpec.html#userObject--">user object</a> and registers any command methods
|
|
(class methods annotated with <code>@Command</code>) as subcommands.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>factory</code> - the factory used to create instances of subcommands, converters, etc., that are registered declaratively with annotation attributes</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli"><code>CommandLine.Model.CommandSpec</code></a> object for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.7.0</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.CommandSpec.html#addSubcommand-java.lang.String-picocli.CommandLine-"><code>addSubcommand(String, CommandLine)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="parent--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parent</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> parent()</pre>
|
|
<div class="block">Returns the parent command of this subcommand, or <code>null</code> if this is a top-level command.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="parent-picocli.CommandLine.Model.CommandSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>parent</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> parent(<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> parent)</pre>
|
|
<div class="block">Sets the parent command of this subcommand.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="add-picocli.CommandLine.Model.ArgSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>add</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> add(<a href="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a> arg)</pre>
|
|
<div class="block">Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>arg</code> - the option spec or positional parameter spec to add</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addOption-picocli.CommandLine.Model.OptionSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addOption</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addOption(<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a> option)</pre>
|
|
<div class="block">Adds the specified option spec to the list of configured arguments to expect.
|
|
The option's <a href="../picocli/CommandLine.Model.ArgSpec.html#description--">CommandLine.Model.ArgSpec.description()</a> may now return Strings from this
|
|
CommandSpec's <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages--">messages</a>.
|
|
The option parameter's <a href="../picocli/CommandLine.Model.ArgSpec.html#defaultValueString--">CommandLine.Model.ArgSpec.defaultValueString()</a> may
|
|
now return Strings from this CommandSpec's <a href="../picocli/CommandLine.Model.CommandSpec.html#defaultValueProvider--"><code>defaultValueProvider()</code></a> IDefaultValueProvider}.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>option</code> - the option spec to add</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli">CommandLine.DuplicateOptionAnnotationsException</a></code> - if any of the names of the specified option is the same as the name of another option</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addPositional-picocli.CommandLine.Model.PositionalParamSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addPositional</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addPositional(<a href="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a> positional)</pre>
|
|
<div class="block">Adds the specified positional parameter spec to the list of configured arguments to expect.
|
|
The positional parameter's <a href="../picocli/CommandLine.Model.ArgSpec.html#description--">CommandLine.Model.ArgSpec.description()</a> may
|
|
now return Strings from this CommandSpec's <a href="../picocli/CommandLine.Model.UsageMessageSpec.html#messages--">messages</a>.
|
|
The positional parameter's <a href="../picocli/CommandLine.Model.ArgSpec.html#defaultValueString--">CommandLine.Model.ArgSpec.defaultValueString()</a> may
|
|
now return Strings from this CommandSpec's <a href="../picocli/CommandLine.Model.CommandSpec.html#defaultValueProvider--"><code>defaultValueProvider()</code></a> IDefaultValueProvider}.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>positional</code> - the positional parameter spec to add</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addArgGroup-picocli.CommandLine.Model.ArgGroupSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addArgGroup</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addArgGroup(<a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a> group)</pre>
|
|
<div class="block">Adds the specified <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">argument group</a> to the groups in this command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>group</code> - the group spec to add</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../picocli/CommandLine.InitializationException.html" title="class in picocli">CommandLine.InitializationException</a></code> - if the specified group or one of its <a href="../picocli/CommandLine.Model.ArgGroupSpec.html#parentGroup--">ancestors</a> has already been added</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addMixin-java.lang.String-picocli.CommandLine.Model.CommandSpec-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addMixin</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addMixin(<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> name,
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> mixin)</pre>
|
|
<div class="block">Adds the specified mixin <code>CommandSpec</code> object to the map of mixins for this command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name that can be used to later retrieve the mixin</dd>
|
|
<dd><code>mixin</code> - the mixin whose options and positional parameters and other attributes to add to this command</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addUnmatchedArgsBinding-picocli.CommandLine.Model.UnmatchedArgsBinding-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addUnmatchedArgsBinding</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> addUnmatchedArgsBinding(<a href="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli">CommandLine.Model.UnmatchedArgsBinding</a> spec)</pre>
|
|
<div class="block">Adds the specified <code>UnmatchedArgsBinding</code> to the list of model objects to capture unmatched arguments for this command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>spec</code> - the unmatched arguments binding to capture unmatched arguments</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="mixins--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mixins</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.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a>> mixins()</pre>
|
|
<div class="block">Returns a map of the mixin names to mixin <code>CommandSpec</code> objects configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable map of mixins added to this command.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="options--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>options</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="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>> options()</pre>
|
|
<div class="block">Returns the list of options configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable list of options that this command recognizes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="positionalParameters--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>positionalParameters</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="../picocli/CommandLine.Model.PositionalParamSpec.html" title="class in picocli">CommandLine.Model.PositionalParamSpec</a>> positionalParameters()</pre>
|
|
<div class="block">Returns the list of positional parameters configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable list of positional parameters that this command recognizes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="argGroups--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>argGroups</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="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">CommandLine.Model.ArgGroupSpec</a>> argGroups()</pre>
|
|
<div class="block">Returns the <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">argument groups</a> in this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable list of groups of options and positional parameters in this command</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>4.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="optionsMap--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>optionsMap</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.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>> optionsMap()</pre>
|
|
<div class="block">Returns a map of the option names to option spec objects configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable map of options that this command recognizes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="posixOptionsMap--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>posixOptionsMap</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/Character.html?is-external=true" title="class or interface in java.lang">Character</a>,<a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a>> posixOptionsMap()</pre>
|
|
<div class="block">Returns a map of the short (single character) option names to option spec objects configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable map of options that this command recognizes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="requiredArgs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>requiredArgs</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="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>> requiredArgs()</pre>
|
|
<div class="block">Returns the list of required options and positional parameters configured for this command.
|
|
This does not include options and positional parameters that are part of a <a href="../picocli/CommandLine.Model.ArgGroupSpec.html" title="class in picocli">group</a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable list of the required options and positional parameters for this command.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="unmatchedArgsBindings--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>unmatchedArgsBindings</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="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli">CommandLine.Model.UnmatchedArgsBinding</a>> unmatchedArgsBindings()</pre>
|
|
<div class="block">Returns the list of <a href="../picocli/CommandLine.Model.UnmatchedArgsBinding.html" title="class in picocli"><code>UnmatchedArgumentsBindings</code></a> configured for this command;
|
|
each <code>UnmatchedArgsBinding</code> captures the arguments that could not be matched to any options or positional parameters.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="name--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>name</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> name()</pre>
|
|
<div class="block">Returns name of this command. Used in the synopsis line of the help message.
|
|
<a href="../picocli/CommandLine.Model.CommandSpec.html#DEFAULT_COMMAND_NAME"><code>DEFAULT_COMMAND_NAME</code></a> by default, initialized from <a href="../picocli/CommandLine.Command.html#name--"><code>CommandLine.Command.name()</code></a> if defined.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.CommandSpec.html#qualifiedName--"><code>qualifiedName()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="aliases--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>aliases</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>[] aliases()</pre>
|
|
<div class="block">Returns the alias command names of this subcommand.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.1</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="names--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>names</h4>
|
|
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> names()</pre>
|
|
<div class="block">Returns all names of this command, including <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name()</code></a> and <a href="../picocli/CommandLine.Model.CommandSpec.html#aliases--"><code>aliases()</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.9</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="args--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>args</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="../picocli/CommandLine.Model.ArgSpec.html" title="class in picocli">CommandLine.Model.ArgSpec</a>> args()</pre>
|
|
<div class="block">Returns the list of all options and positional parameters configured for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an immutable list of all options and positional parameters for this command.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="qualifiedName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>qualifiedName</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> qualifiedName()</pre>
|
|
<div class="block">Returns the String to use as the program name in the synopsis line of the help message:
|
|
this command's <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name</code></a>, preceded by the qualified name of the parent command, if any, separated by a space.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.CommandSpec.html#DEFAULT_COMMAND_NAME"><code>DEFAULT_COMMAND_NAME</code></a> by default, initialized from <a href="../picocli/CommandLine.Command.html#name--"><code>CommandLine.Command.name()</code></a> and the parent command if defined.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.0.1</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="qualifiedName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>qualifiedName</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> qualifiedName(<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> separator)</pre>
|
|
<div class="block">Returns this command's fully qualified name, which is its <a href="../picocli/CommandLine.Model.CommandSpec.html#name--"><code>name</code></a>, preceded by the qualified name of the parent command, if this command has a parent command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>separator</code> - the string to put between the names of the commands in the hierarchy</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Model.CommandSpec.html#DEFAULT_COMMAND_NAME"><code>DEFAULT_COMMAND_NAME</code></a> by default, initialized from <a href="../picocli/CommandLine.Command.html#name--"><code>CommandLine.Command.name()</code></a> and the parent command if any.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="version--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>version</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>[] version()</pre>
|
|
<div class="block">Returns version information for this command, to print to the console when the user specifies an
|
|
<a href="../picocli/CommandLine.Model.OptionSpec.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>the version strings generated by the <a href="../picocli/CommandLine.Model.CommandSpec.html#versionProvider--"><code>version provider</code></a> if one is set, otherwise the <a href="../picocli/CommandLine.Model.CommandSpec.html#version-java.lang.String...-">version literals</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="versionProvider--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>versionProvider</h4>
|
|
<pre>public <a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a> versionProvider()</pre>
|
|
<div class="block">Returns the version provider for this command, to generate the <a href="../picocli/CommandLine.Model.CommandSpec.html#version--"><code>version()</code></a> strings.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the version provider or <code>null</code> if the version strings should be returned from the <a href="../picocli/CommandLine.Model.CommandSpec.html#version-java.lang.String...-">version literals</a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="helpCommand--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>helpCommand</h4>
|
|
<pre>public boolean helpCommand()</pre>
|
|
<div class="block">Returns whether this subcommand is a help command, and required options and positional
|
|
parameters of the parent command should not be validated.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><code>true</code> if this subcommand is a help command and picocli should not check for missing required
|
|
options and positional parameters on the parent command</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Command.html#helpCommand--"><code>CommandLine.Command.helpCommand()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnSuccess--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnSuccess</h4>
|
|
<pre>public int exitCodeOnSuccess()</pre>
|
|
<div class="block">Returns exit code for successful termination. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default, may be set programmatically or via the <a href="../picocli/CommandLine.Command.html#exitCodeOnSuccess--"><code>exitCodeOnSuccess</code></a> annotation.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnUsageHelp--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnUsageHelp</h4>
|
|
<pre>public int exitCodeOnUsageHelp()</pre>
|
|
<div class="block">Returns exit code for successful termination after printing usage help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default, may be set programmatically or via the <a href="../picocli/CommandLine.Command.html#exitCodeOnVersionHelp--"><code>exitCodeOnVersionHelp</code></a> annotation.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnVersionHelp--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnVersionHelp</h4>
|
|
<pre>public int exitCodeOnVersionHelp()</pre>
|
|
<div class="block">Returns exit code for successful termination after printing version help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default, may be set programmatically or via the <a href="../picocli/CommandLine.Command.html#exitCodeOnUsageHelp--"><code>exitCodeOnUsageHelp</code></a> annotation.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnInvalidInput--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnInvalidInput</h4>
|
|
<pre>public int exitCodeOnInvalidInput()</pre>
|
|
<div class="block">Returns exit code for command line usage error. <a href="../picocli/CommandLine.ExitCode.html#USAGE">64</a> by default, may be set programmatically or via the <a href="../picocli/CommandLine.Command.html#exitCodeOnInvalidInput--"><code>exitCodeOnInvalidInput</code></a> annotation.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnExecutionException--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnExecutionException</h4>
|
|
<pre>public int exitCodeOnExecutionException()</pre>
|
|
<div class="block">Returns exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
|
|
<a href="../picocli/CommandLine.ExitCode.html#SOFTWARE">70</a> by default, may be set programmatically or via the <a href="../picocli/CommandLine.Command.html#exitCodeOnExecutionException--"><code>exitCodeOnExecutionException</code></a> annotation.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="mixinStandardHelpOptions--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mixinStandardHelpOptions</h4>
|
|
<pre>public boolean mixinStandardHelpOptions()</pre>
|
|
<div class="block">Returns <code>true</code> if the standard help options have been mixed in with this command, <code>false</code> otherwise.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="toString--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>toString</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> toString()</pre>
|
|
<div class="block">Returns a string representation of this command, used in error messages and trace messages.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><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></code> in class <code><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></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="name-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>name</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> name(<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> name)</pre>
|
|
<div class="block">Sets the String to use as the program name in the synopsis line of the help message.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="aliases-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>aliases</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> aliases(<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>... aliases)</pre>
|
|
<div class="block">Sets the alternative names by which this subcommand is recognized on the command line.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.1</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="defaultValueProvider--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>defaultValueProvider</h4>
|
|
<pre>public <a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a> defaultValueProvider()</pre>
|
|
<div class="block">Returns the default value provider for this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the default value provider or <code>null</code></dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="defaultValueProvider-picocli.CommandLine.IDefaultValueProvider-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>defaultValueProvider</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> defaultValueProvider(<a href="../picocli/CommandLine.IDefaultValueProvider.html" title="interface in picocli">CommandLine.IDefaultValueProvider</a> defaultValueProvider)</pre>
|
|
<div class="block">Sets default value provider for this command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>defaultValueProvider</code> - the default value provider to use, or <code>null</code>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.6</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="version-java.lang.String...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>version</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> version(<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>... version)</pre>
|
|
<div class="block">Sets version information literals for this command, to print to the console when the user specifies an
|
|
<a href="../picocli/CommandLine.Model.OptionSpec.html#versionHelp--">option</a> to request version help. Only used if no <a href="../picocli/CommandLine.Model.CommandSpec.html#versionProvider--"><code>versionProvider</code></a> is set.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="versionProvider-picocli.CommandLine.IVersionProvider-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>versionProvider</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> versionProvider(<a href="../picocli/CommandLine.IVersionProvider.html" title="interface in picocli">CommandLine.IVersionProvider</a> versionProvider)</pre>
|
|
<div class="block">Sets version provider for this command, to generate the <a href="../picocli/CommandLine.Model.CommandSpec.html#version--"><code>version()</code></a> strings.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>versionProvider</code> - the version provider to use to generate the version strings, or <code>null</code> if the <a href="../picocli/CommandLine.Model.CommandSpec.html#version-java.lang.String...-">version literals</a> should be used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="helpCommand-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>helpCommand</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> helpCommand(boolean newValue)</pre>
|
|
<div class="block">Sets whether this is a help command and required parameter checking should be suspended.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Command.html#helpCommand--"><code>CommandLine.Command.helpCommand()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnSuccess-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnSuccess</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> exitCodeOnSuccess(int newValue)</pre>
|
|
<div class="block">Sets exit code for successful termination. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnUsageHelp-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnUsageHelp</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> exitCodeOnUsageHelp(int newValue)</pre>
|
|
<div class="block">Sets exit code for successful termination after printing usage help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnVersionHelp-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnVersionHelp</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> exitCodeOnVersionHelp(int newValue)</pre>
|
|
<div class="block">Sets exit code for successful termination after printing version help on user request. <a href="../picocli/CommandLine.ExitCode.html#OK">0</a> by default.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnInvalidInput-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnInvalidInput</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> exitCodeOnInvalidInput(int newValue)</pre>
|
|
<div class="block">Sets exit code for command line usage error. <a href="../picocli/CommandLine.ExitCode.html#USAGE">64</a> by default.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="exitCodeOnExecutionException-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>exitCodeOnExecutionException</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> exitCodeOnExecutionException(int newValue)</pre>
|
|
<div class="block">Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
|
|
<a href="../picocli/CommandLine.ExitCode.html#SOFTWARE">70</a> by default.</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.html#execute-java.lang.String...-"><code>CommandLine.execute(String...)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="mixinStandardHelpOptions-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mixinStandardHelpOptions</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> mixinStandardHelpOptions(boolean newValue)</pre>
|
|
<div class="block">Sets whether the standard help options should be mixed in with this command.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../picocli/CommandLine.Command.html#mixinStandardHelpOptions--"><code>CommandLine.Command.mixinStandardHelpOptions()</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="withToString-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>withToString</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.CommandSpec.html" title="class in picocli">CommandLine.Model.CommandSpec</a> withToString(<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 representation of this command, used in error messages and trace messages.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>newValue</code> - the string representation</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this CommandSpec for method chaining</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="updateCommandAttributes-picocli.CommandLine.Command-picocli.CommandLine.IFactory-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>updateCommandAttributes</h4>
|
|
<pre>public void updateCommandAttributes(<a href="../picocli/CommandLine.Command.html" title="annotation in picocli">CommandLine.Command</a> cmd,
|
|
<a href="../picocli/CommandLine.IFactory.html" title="interface in picocli">CommandLine.IFactory</a> factory)</pre>
|
|
<div class="block">Updates the following attributes from the specified <code>@Command</code> annotation:
|
|
aliases, <a href="../picocli/CommandLine.Model.ParserSpec.html#separator--"><code>parser separator</code></a>, command name, version, help command,
|
|
version provider, default provider and <a href="../picocli/CommandLine.Model.UsageMessageSpec.html" title="class in picocli"><code>usage message spec</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>cmd</code> - the <code>@Command</code> annotation to get attribute values from</dd>
|
|
<dd><code>factory</code> - factory used to instantiate classes</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.7</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="findOption-char-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>findOption</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a> findOption(char shortName)</pre>
|
|
<div class="block">Returns the option with the specified short name, or <code>null</code> if no option with that name is defined for this command.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="findOption-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>findOption</h4>
|
|
<pre>public <a href="../picocli/CommandLine.Model.OptionSpec.html" title="class in picocli">CommandLine.Model.OptionSpec</a> findOption(<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> name)</pre>
|
|
<div class="block">Returns the option with the specified name, or <code>null</code> if no option with that name is defined for this command.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - used to search the options. May include option name prefix characters or not.</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="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.ArgSpec.html" title="class in picocli"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../picocli/CommandLine.Model.IAnnotatedElement.html" title="interface in picocli"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?picocli/CommandLine.Model.CommandSpec.html" target="_top">Frames</a></li>
|
|
<li><a href="CommandLine.Model.CommandSpec.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>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|