| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CLI.CLIBuilder (Storm 2.4.0 API)</title> |
| <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="CLI.CLIBuilder (Storm 2.4.0 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}; |
| var tabs = {65535:["t0","All 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="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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/command/CLI.CLIBuilder.html" target="_top">Frames</a></li> |
| <li><a href="CLI.CLIBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.command</div> |
| <h2 title="Class CLI.CLIBuilder" class="title">Class CLI.CLIBuilder</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>org.apache.storm.command.CLI.CLIBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/storm/command/CLI.html" title="class in org.apache.storm.command">CLI</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">CLI.CLIBuilder</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> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#CLIBuilder--">CLIBuilder</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></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="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#arg-java.lang.String-">arg</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">Add a named argument.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#arg-java.lang.String-org.apache.storm.command.CLI.Assoc-">arg</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="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</code> |
| <div class="block">Add a named argument.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#arg-java.lang.String-org.apache.storm.command.CLI.Parse-">arg</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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</code> |
| <div class="block">Add a named argument.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#arg-java.lang.String-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-">arg</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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</code> |
| <div class="block">Add a named argument.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#boolOpt-java.lang.String-java.lang.String-">boolOpt</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> shortName, |
| <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> longName)</code> |
| <div class="block">Add a boolean option that enables something.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#opt-java.lang.String-java.lang.String-java.lang.Object-">opt</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> shortName, |
| <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> longName, |
| <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> defaultValue)</code> |
| <div class="block">Add an option to be parsed.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#opt-java.lang.String-java.lang.String-java.lang.Object-org.apache.storm.command.CLI.Parse-">opt</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> shortName, |
| <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> longName, |
| <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> defaultValue, |
| <a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</code> |
| <div class="block">Add an option to be parsed.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#opt-java.lang.String-java.lang.String-java.lang.Object-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-">opt</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> shortName, |
| <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> longName, |
| <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> defaultValue, |
| <a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</code> |
| <div class="block">Add an option to be parsed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#optionalArg-java.lang.String-">optionalArg</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">Add a named argument that is optional.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#optionalArg-java.lang.String-org.apache.storm.command.CLI.Assoc-">optionalArg</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="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</code> |
| <div class="block">Add a named argument that is optional.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#optionalArg-java.lang.String-org.apache.storm.command.CLI.Parse-">optionalArg</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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</code> |
| <div class="block">Add a named argument that is optional.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html#optionalArg-java.lang.String-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-">optionalArg</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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</code> |
| <div class="block">Add a named argument that is optional.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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="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="../../../../org/apache/storm/command/CLI.CLIBuilder.html#parse-java.lang.String...-">parse</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>... rawArgs)</code> |
| <div class="block">Parse the command line arguments.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CLIBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CLIBuilder</h4> |
| <pre>public CLIBuilder()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="opt-java.lang.String-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>opt</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> opt(<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> shortName, |
| <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> longName, |
| <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> defaultValue)</pre> |
| <div class="block"><p>Add an option to be parsed.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shortName</code> - the short single character name of the option (no <code>-</code> character proceeds it).</dd> |
| <dd><code>longName</code> - the multi character name of the option (no <code>--</code> 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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="opt-java.lang.String-java.lang.String-java.lang.Object-org.apache.storm.command.CLI.Parse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>opt</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> opt(<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> shortName, |
| <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> longName, |
| <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> defaultValue, |
| <a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</pre> |
| <div class="block"><p>Add an option to be parsed.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shortName</code> - the short single character name of the option (no <code>-</code> character proceeds it).</dd> |
| <dd><code>longName</code> - the multi character name of the option (no <code>--</code> 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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="opt-java.lang.String-java.lang.String-java.lang.Object-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>opt</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> opt(<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> shortName, |
| <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> longName, |
| <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> defaultValue, |
| <a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</pre> |
| <div class="block"><p>Add an option to be parsed.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shortName</code> - the short single character name of the option (no <code>-</code> character proceeds it).</dd> |
| <dd><code>longName</code> - the multi character name of the option (no <code>--</code> 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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="boolOpt-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>boolOpt</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> boolOpt(<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> shortName, |
| <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> longName)</pre> |
| <div class="block"><p>Add a boolean option that enables something.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shortName</code> - the short single character name of the option (no <code>-</code> character proceeds it).</dd> |
| <dd><code>longName</code> - the multi character name of the option (no <code>--</code> characters proceed it).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="arg-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> arg(<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"><p>Add a named argument.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the argument.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="arg-java.lang.String-org.apache.storm.command.CLI.Assoc-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> arg(<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="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</pre> |
| <div class="block"><p>Add a named argument.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="arg-java.lang.String-org.apache.storm.command.CLI.Parse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> arg(<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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</pre> |
| <div class="block"><p>Add a named argument.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="arg-java.lang.String-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> arg(<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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</pre> |
| <div class="block"><p>Add a named argument.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionalArg-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionalArg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> optionalArg(<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"><p>Add a named argument that is optional.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the argument.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionalArg-java.lang.String-org.apache.storm.command.CLI.Assoc-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionalArg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> optionalArg(<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="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</pre> |
| <div class="block"><p>Add a named argument that is optional.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionalArg-java.lang.String-org.apache.storm.command.CLI.Parse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionalArg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> optionalArg(<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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse)</pre> |
| <div class="block"><p>Add a named argument that is optional.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionalArg-java.lang.String-org.apache.storm.command.CLI.Parse-org.apache.storm.command.CLI.Assoc-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionalArg</h4> |
| <pre>public <a href="../../../../org/apache/storm/command/CLI.CLIBuilder.html" title="class in org.apache.storm.command">CLI.CLIBuilder</a> optionalArg(<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="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command">CLI.Parse</a> parse, |
| <a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command">CLI.Assoc</a> assoc)</pre> |
| <div class="block"><p>Add a named argument that is optional.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder to be used to continue creating the command line.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parse-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parse</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> parse(<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>... rawArgs) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><p>Parse the command line arguments.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawArgs</code> - the string arguments to be parsed.</dd> |
| <dt><span class="returnLabel">Returns:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - on any error.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/command/CLI.Assoc.html" title="interface in org.apache.storm.command"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/command/CLI.Parse.html" title="interface in org.apache.storm.command"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/command/CLI.CLIBuilder.html" target="_top">Frames</a></li> |
| <li><a href="CLI.CLIBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
