blob: 1ec91b152ce4b12e414df6273664c26dfd03a19c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>CLI.CLIBuilder (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.storm.command, class: CLI, class: CLIBuilder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CLI.CLIBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.command</a></div>
<h1 title="Class CLI.CLIBuilder" class="title">Class CLI.CLIBuilder</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.storm.command.CLI.CLIBuilder</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="CLI.html" title="class in org.apache.storm.command">CLI</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">CLI.CLIBuilder</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CLIBuilder</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#arg(java.lang.String)" class="member-name-link">arg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#arg(java.lang.String,org.apache.storm.command.CLI.Assoc)" class="member-name-link">arg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#arg(java.lang.String,org.apache.storm.command.CLI.Parse)" class="member-name-link">arg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#arg(java.lang.String,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)" class="member-name-link">arg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#boolOpt(java.lang.String,java.lang.String)" class="member-name-link">boolOpt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a boolean option that enables something.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#opt(java.lang.String,java.lang.String,java.lang.Object)" class="member-name-link">opt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add an option to be parsed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#opt(java.lang.String,java.lang.String,java.lang.Object,org.apache.storm.command.CLI.Parse)" class="member-name-link">opt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add an option to be parsed.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#opt(java.lang.String,java.lang.String,java.lang.Object,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)" class="member-name-link">opt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add an option to be parsed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#optionalArg(java.lang.String)" class="member-name-link">optionalArg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument that is optional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#optionalArg(java.lang.String,org.apache.storm.command.CLI.Assoc)" class="member-name-link">optionalArg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument that is optional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#optionalArg(java.lang.String,org.apache.storm.command.CLI.Parse)" class="member-name-link">optionalArg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument that is optional.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#optionalArg(java.lang.String,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)" class="member-name-link">optionalArg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a named argument that is optional.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parse(java.lang.String...)" class="member-name-link">parse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;rawArgs)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Parse the command line arguments.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>CLIBuilder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CLIBuilder</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="opt(java.lang.String,java.lang.String,java.lang.Object)">
<h3>opt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">opt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue)</span></div>
<div class="block">Add an option to be parsed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shortName</code> - the short single character name of the option (no `-` character proceeds it).</dd>
<dd><code>longName</code> - the multi character name of the option (no `--` characters proceed it).</dd>
<dd><code>defaultValue</code> - the value that will be returned of the command if none is given. null if none is given.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="opt(java.lang.String,java.lang.String,java.lang.Object,org.apache.storm.command.CLI.Parse)">
<h3>opt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">opt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</span></div>
<div class="block">Add an option to be parsed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shortName</code> - the short single character name of the option (no `-` character proceeds it).</dd>
<dd><code>longName</code> - the multi character name of the option (no `--` characters proceed it).</dd>
<dd><code>defaultValue</code> - the value that will be returned of the command if none is given. null if none is given.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="opt(java.lang.String,java.lang.String,java.lang.Object,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)">
<h3>opt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">opt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;defaultValue,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</span></div>
<div class="block">Add an option to be parsed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shortName</code> - the short single character name of the option (no `-` character proceeds it).</dd>
<dd><code>longName</code> - the multi character name of the option (no `--` characters proceed it).</dd>
<dd><code>defaultValue</code> - the value that will be returned of the command if none is given. null if none is given.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dd><code>assoc</code> - an association command to decide what to do if the option appears multiple times. If null LAST_WINS is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="boolOpt(java.lang.String,java.lang.String)">
<h3>boolOpt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">boolOpt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;shortName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;longName)</span></div>
<div class="block">Add a boolean option that enables something.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shortName</code> - the short single character name of the option (no `-` character proceeds it).</dd>
<dd><code>longName</code> - the multi character name of the option (no `--` characters proceed it).</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="arg(java.lang.String)">
<h3>arg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">arg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Add a named argument.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="arg(java.lang.String,org.apache.storm.command.CLI.Assoc)">
<h3>arg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">arg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</span></div>
<div class="block">Add a named argument.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>assoc</code> - an association command to decide what to do if the argument appears multiple times. If null INTO_LIST is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="arg(java.lang.String,org.apache.storm.command.CLI.Parse)">
<h3>arg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">arg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</span></div>
<div class="block">Add a named argument.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="arg(java.lang.String,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)">
<h3>arg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">arg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</span></div>
<div class="block">Add a named argument.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dd><code>assoc</code> - an association command to decide what to do if the argument appears multiple times. If null INTO_LIST is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="optionalArg(java.lang.String)">
<h3>optionalArg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">optionalArg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Add a named argument that is optional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="optionalArg(java.lang.String,org.apache.storm.command.CLI.Assoc)">
<h3>optionalArg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">optionalArg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</span></div>
<div class="block">Add a named argument that is optional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>assoc</code> - an association command to decide what to do if the argument appears multiple times. If null INTO_LIST is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="optionalArg(java.lang.String,org.apache.storm.command.CLI.Parse)">
<h3>optionalArg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">optionalArg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse)</span></div>
<div class="block">Add a named argument that is optional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="optionalArg(java.lang.String,org.apache.storm.command.CLI.Parse,org.apache.storm.command.CLI.Assoc)">
<h3>optionalArg</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></span>&nbsp;<span class="element-name">optionalArg</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a>&nbsp;parse,
<a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a>&nbsp;assoc)</span></div>
<div class="block">Add a named argument that is optional.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the argument.</dd>
<dd><code>parse</code> - an optional function to transform the string to something else. If null a NOOP is used.</dd>
<dd><code>assoc</code> - an association command to decide what to do if the argument appears multiple times. If null INTO_LIST is used.</dd>
<dt>Returns:</dt>
<dd>a builder to be used to continue creating the command line.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="parse(java.lang.String...)">
<h3>parse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;rawArgs)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
<div class="block">Parse the command line arguments.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rawArgs</code> - the string arguments to be parsed.</dd>
<dt>Returns:</dt>
<dd>The parsed command line.
opts will be stored under the short argument name.
args will be stored under the argument name, unless no arguments are configured, and then they will be stored under "ARGS".
The last argument configured is greedy and is used to process all remaining command line arguments.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - on any error.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>