|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <!-- Generated by javadoc -->
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <title>Option.Builder (Apache Commons CLI 1.4 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="Option.Builder (Apache Commons CLI 1.4 API)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
- 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="../../../../org/apache/commons/cli/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/Option.Builder.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/commons/cli/Option.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/apache/commons/cli/Option.Builder.html" target="_top">Frames</a></li>
- <li><a href="Option.Builder.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.apache.commons.cli</div>
- <h2 title="Class Option.Builder" class="title">Class Option.Builder</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li><a href="http://docs.oracle.com/javase/7/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.commons.cli.Option.Builder</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>Enclosing class:</dt>
- <dd><a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public static final class <span class="typeNameLabel">Option.Builder</span>
- extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
- <div class="block">A nested builder class to create <code>Option</code> instances
- using descriptive methods.
- <p>
- Example usage:
- <pre>
- Option option = Option.builder("a")
- .required(true)
- .longOpt("arg-name")
- .build();
- </pre></div>
- <dl>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.3</dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#argName-java.lang.String-">argName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> argName)</code>
- <div class="block">Sets the display name for the argument value.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#build--">build</a></span>()</code>
- <div class="block">Constructs an Option with the values declared by this <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a>.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#desc-java.lang.String-">desc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code>
- <div class="block">Sets the description for this option.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#hasArg--">hasArg</a></span>()</code>
- <div class="block">Indicates that the Option will require an argument.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#hasArg-boolean-">hasArg</a></span>(boolean hasArg)</code>
- <div class="block">Indicates if the Option has an argument or not.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#hasArgs--">hasArgs</a></span>()</code>
- <div class="block">Indicates that the Option can have unlimited argument values.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#longOpt-java.lang.String-">longOpt</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt)</code>
- <div class="block">Sets the long name of the Option.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#numberOfArgs-int-">numberOfArgs</a></span>(int numberOfArgs)</code>
- <div class="block">Sets the number of argument values the Option can take.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#optionalArg-boolean-">optionalArg</a></span>(boolean isOptional)</code>
- <div class="block">Sets whether the Option can have an optional argument.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#required--">required</a></span>()</code>
- <div class="block">Marks this Option as required.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#required-boolean-">required</a></span>(boolean required)</code>
- <div class="block">Sets whether the Option is mandatory.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#type-java.lang.Class-">type</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code>
- <div class="block">Sets the type of the Option.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#valueSeparator--">valueSeparator</a></span>()</code>
- <div class="block">The Option will use '=' as a means to separate argument value.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html#valueSeparator-char-">valueSeparator</a></span>(char sep)</code>
- <div class="block">The Option will use <code>sep</code> as a means to
- separate argument values.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
- <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="argName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>argName</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> argName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> argName)</pre>
- <div class="block">Sets the display name for the argument value.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>argName</code> - the display name for the argument value.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="desc-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>desc</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> desc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
- <div class="block">Sets the description for this option.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>description</code> - the description of the option.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="longOpt-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>longOpt</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> longOpt(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt)</pre>
- <div class="block">Sets the long name of the Option.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>longOpt</code> - the long name of the Option</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="numberOfArgs-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>numberOfArgs</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> numberOfArgs(int numberOfArgs)</pre>
- <div class="block">Sets the number of argument values the Option can take.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>numberOfArgs</code> - the number of argument values</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="optionalArg-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>optionalArg</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> optionalArg(boolean isOptional)</pre>
- <div class="block">Sets whether the Option can have an optional argument.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>isOptional</code> - specifies whether the Option can have
- an optional argument.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="required--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>required</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> required()</pre>
- <div class="block">Marks this Option as required.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="required-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>required</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> required(boolean required)</pre>
- <div class="block">Sets whether the Option is mandatory.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>required</code> - specifies whether the Option is mandatory</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="type-java.lang.Class-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>type</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> type(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</pre>
- <div class="block">Sets the type of the Option.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>type</code> - the type of the Option</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="valueSeparator--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>valueSeparator</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> valueSeparator()</pre>
- <div class="block">The Option will use '=' as a means to separate argument value.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="valueSeparator-char-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>valueSeparator</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> valueSeparator(char sep)</pre>
- <div class="block">The Option will use <code>sep</code> as a means to
- separate argument values.
- <p>
- <b>Example:</b>
- <pre>
- Option opt = Option.builder("D").hasArgs()
- .valueSeparator('=')
- .build();
- Options options = new Options();
- options.addOption(opt);
- String[] args = {"-Dkey=value"};
- CommandLineParser parser = new DefaultParser();
- CommandLine line = parser.parse(options, args);
- String propertyName = line.getOptionValues("D")[0]; // will be "key"
- String propertyValue = line.getOptionValues("D")[1]; // will be "value"
- </pre></div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>sep</code> - The value separator.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="hasArg--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasArg</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> hasArg()</pre>
- <div class="block">Indicates that the Option will require an argument.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="hasArg-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasArg</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> hasArg(boolean hasArg)</pre>
- <div class="block">Indicates if the Option has an argument or not.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>hasArg</code> - specifies whether the Option takes an argument or not</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="hasArgs--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasArgs</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> hasArgs()</pre>
- <div class="block">Indicates that the Option can have unlimited argument values.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>this builder, to allow method chaining</dd>
- </dl>
- </li>
- </ul>
- <a name="build--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>build</h4>
- <pre>public <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> build()</pre>
- <div class="block">Constructs an Option with the values declared by this <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a>.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the new <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a></dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if neither <code>opt</code> or <code>longOpt</code> has been set</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="../../../../org/apache/commons/cli/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/Option.Builder.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/commons/cli/Option.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/apache/commons/cli/Option.Builder.html" target="_top">Frames</a></li>
- <li><a href="Option.Builder.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2002–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
- </body>
- </html>
|