blob: 8e8fd2cbf21309582fe2ebc429be66dcbc961225 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>CLI (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">
<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.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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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" class="title">Class CLI</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</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CLI</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">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CLI.Assoc.html" class="type-name-link" title="interface in org.apache.storm.command">CLI.Assoc</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="CLI.CLIBuilder.html" class="type-name-link" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CLI.Parse.html" class="type-name-link" title="interface in org.apache.storm.command">CLI.Parse</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a></code></div>
<div class="col-second even-row-color"><code><a href="#AS_INT" class="member-name-link">AS_INT</a></code></div>
<div class="col-last even-row-color">
<div class="block">Parse function to return an Integer.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a></code></div>
<div class="col-second odd-row-color"><code><a href="#AS_STRING" class="member-name-link">AS_STRING</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Noop parse function, returns the String.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></code></div>
<div class="col-second even-row-color"><code><a href="#FIRST_WINS" class="member-name-link">FIRST_WINS</a></code></div>
<div class="col-last even-row-color">
<div class="block">First occurrence on the command line is the resulting value.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></code></div>
<div class="col-second odd-row-color"><code><a href="#INTO_LIST" class="member-name-link">INTO_LIST</a></code></div>
<div class="col-last odd-row-color">
<div class="block">All values are returned as a List.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></code></div>
<div class="col-second even-row-color"><code><a href="#INTO_MAP" class="member-name-link">INTO_MAP</a></code></div>
<div class="col-last even-row-color">
<div class="block">All values are returned as a map.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></code></div>
<div class="col-second odd-row-color"><code><a href="#LAST_WINS" class="member-name-link">LAST_WINS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Last occurrence on the command line is the resulting value.</div>
</div>
</div>
</section>
</li>
<!-- ======== 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">CLI</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 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-tab1 method-summary-table-tab4"><code>static <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-tab1 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-tab1 method-summary-table-tab4">
<div class="block">Add a named argument that is optional.</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">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="AS_INT">
<h3>AS_INT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a></span>&nbsp;<span class="element-name">AS_INT</span></div>
<div class="block">Parse function to return an Integer.</div>
</section>
</li>
<li>
<section class="detail" id="AS_STRING">
<h3>AS_STRING</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a></span>&nbsp;<span class="element-name">AS_STRING</span></div>
<div class="block">Noop parse function, returns the String.</div>
</section>
</li>
<li>
<section class="detail" id="LAST_WINS">
<h3>LAST_WINS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></span>&nbsp;<span class="element-name">LAST_WINS</span></div>
<div class="block">Last occurrence on the command line is the resulting value.</div>
</section>
</li>
<li>
<section class="detail" id="FIRST_WINS">
<h3>FIRST_WINS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></span>&nbsp;<span class="element-name">FIRST_WINS</span></div>
<div class="block">First occurrence on the command line is the resulting value.</div>
</section>
</li>
<li>
<section class="detail" id="INTO_LIST">
<h3>INTO_LIST</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></span>&nbsp;<span class="element-name">INTO_LIST</span></div>
<div class="block">All values are returned as a List.</div>
</section>
</li>
<li>
<section class="detail" id="INTO_MAP">
<h3>INTO_MAP</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a></span>&nbsp;<span class="element-name">INTO_MAP</span></div>
<div class="block">All values are returned as a map.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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>CLI</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CLI</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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 static</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>
</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>