hoo2
/
virtualModem
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 2 Wiki Activity
Network programming assignment for University
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 Commits
1 Branch
7.9 MiB
 
 
 
 
Tree: 1692276bf8
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1692276bf8'
${ noResults }
virtualModem/libs/commons-cli-1.4/apidocs/org/apache/commons/cli/OptionBuilder.html

738 lines
38 KiB
Raw Blame History 

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <!-- NewPage -->

  3. <html lang="de">

  4. <head>

  5. <!-- Generated by javadoc -->

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  7. <title>OptionBuilder (Apache Commons CLI 1.4 API)</title>

  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

  9. <script type="text/javascript" src="../../../../script.js"></script>

  10. </head>

  11. <body>

  12. <script type="text/javascript"><!--

  13.     try {

  14.         if (location.href.indexOf('is-external=true') == -1) {

  15.             parent.document.title="OptionBuilder (Apache Commons CLI 1.4 API)";

  16.         }

  17.     }

  18.     catch(err) {

  19.     }

  20. //-->

  21. var methods = {"i0":41,"i1":41,"i2":41,"i3":41,"i4":41,"i5":41,"i6":41,"i7":41,"i8":41,"i9":41,"i10":41,"i11":41,"i12":41,"i13":41,"i14":41,"i15":41,"i16":41,"i17":41,"i18":41};

  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};

  23. var altColor = "altColor";

  24. var rowColor = "rowColor";

  25. var tableTab = "tableTab";

  26. var activeTableTab = "activeTableTab";

  27. </script>

  28. <noscript>

  29. <div>JavaScript is disabled on your browser.</div>

  30. </noscript>

  31. <!-- ========= START OF TOP NAVBAR ======= -->

  32. <div class="topNav"><a name="navbar.top">

  33. <!--   -->

  34. </a>

  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>

  36. <a name="navbar.top.firstrow">

  37. <!--   -->

  38. </a>

  39. <ul class="navList" title="Navigation">

  40. <li><a href="../../../../org/apache/commons/cli/package-summary.html">Package</a></li>

  41. <li class="navBarCell1Rev">Class</li>

  42. <li><a href="class-use/OptionBuilder.html">Use</a></li>

  43. <li><a href="package-tree.html">Tree</a></li>

  44. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>

  45. <li><a href="../../../../index-all.html">Index</a></li>

  46. <li><a href="../../../../help-doc.html">Help</a></li>

  47. </ul>

  48. </div>

  49. <div class="subNav">

  50. <ul class="navList">

  51. <li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>

  52. <li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>

  53. </ul>

  54. <ul class="navList">

  55. <li><a href="../../../../index.html?org/apache/commons/cli/OptionBuilder.html" target="_top">Frames</a></li>

  56. <li><a href="OptionBuilder.html" target="_top">No&nbsp;Frames</a></li>

  57. </ul>

  58. <ul class="navList" id="allclasses_navbar_top">

  59. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>

  60. </ul>

  61. <div>

  62. <script type="text/javascript"><!--

  63.   allClassesLink = document.getElementById("allclasses_navbar_top");

  64.   if(window==top) {

  65.     allClassesLink.style.display = "block";

  66.   }

  67.   else {

  68.     allClassesLink.style.display = "none";

  69.   }

  70.   //-->

  71. </script>

  72. </div>

  73. <div>

  74. <ul class="subNavList">

  75. <li>Summary:&nbsp;</li>

  76. <li>Nested&nbsp;|&nbsp;</li>

  77. <li>Field&nbsp;|&nbsp;</li>

  78. <li>Constr&nbsp;|&nbsp;</li>

  79. <li><a href="#method.summary">Method</a></li>

  80. </ul>

  81. <ul class="subNavList">

  82. <li>Detail:&nbsp;</li>

  83. <li>Field&nbsp;|&nbsp;</li>

  84. <li>Constr&nbsp;|&nbsp;</li>

  85. <li><a href="#method.detail">Method</a></li>

  86. </ul>

  87. </div>

  88. <a name="skip.navbar.top">

  89. <!--   -->

  90. </a></div>

  91. <!-- ========= END OF TOP NAVBAR ========= -->

  92. <!-- ======== START OF CLASS DATA ======== -->

  93. <div class="header">

  94. <div class="subTitle">org.apache.commons.cli</div>

  95. <h2 title="Class OptionBuilder" class="title">Class OptionBuilder</h2>

  96. </div>

  97. <div class="contentContainer">

  98. <ul class="inheritance">

  99. <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>

  100. <li>

  101. <ul class="inheritance">

  102. <li>org.apache.commons.cli.OptionBuilder</li>

  103. </ul>

  104. </li>

  105. </ul>

  106. <div class="description">

  107. <ul class="blockList">

  108. <li class="blockList">

  109. <hr>

  110. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;

  111. <div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#builder-java.lang.String-"><code>Option.builder(String)</code></a> instead</span></div>

  112. </div>

  113. <br>

  114. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>

  115. public final class <span class="typeNameLabel">OptionBuilder</span>

  116. 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>

  117. <div class="block">OptionBuilder allows the user to create Options using descriptive methods.

  118.  <p>

  119.  Details on the Builder pattern can be found at

  120.  <a href="http://c2.com/cgi-bin/wiki?BuilderPattern">http://c2.com/cgi-bin/wiki?BuilderPattern</a>.

  121.  <p>

  122.  This class is NOT thread safe. See <a href="https://issues.apache.org/jira/browse/CLI-209">CLI-209</a></div>

  123. <dl>

  124. <dt><span class="simpleTagLabel">Since:</span></dt>

  125. <dd>1.0</dd>

  126. <dt><span class="simpleTagLabel">Version:</span></dt>

  127. <dd>$Id: OptionBuilder.java 1677400 2015-05-03 13:46:08Z britter $</dd>

  128. </dl>

  129. </li>

  130. </ul>

  131. </div>

  132. <div class="summary">

  133. <ul class="blockList">

  134. <li class="blockList">

  135. <!-- ========== METHOD SUMMARY =========== -->

  136. <ul class="blockList">

  137. <li class="blockList"><a name="method.summary">

  138. <!--   -->

  139. </a>

  140. <h3>Method Summary</h3>

  141. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">

  142. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>

  143. <tr>

  144. <th class="colFirst" scope="col">Modifier and Type</th>

  145. <th class="colLast" scope="col">Method and Description</th>

  146. </tr>

  147. <tr id="i0" class="altColor">

  148. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td>

  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create--">create</a></span>()</code>

  150. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  151. <div class="block">Create an Option using the current settings</div>

  152. </td>

  153. </tr>

  154. <tr id="i1" class="rowColor">

  155. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td>

  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create-char-">create</a></span>(char&nbsp;opt)</code>

  157. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  158. <div class="block">Create an Option using the current settings and with

  159.  the specified Option <code>char</code>.</div>

  160. </td>

  161. </tr>

  162. <tr id="i2" class="altColor">

  163. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td>

  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create-java.lang.String-">create</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>&nbsp;opt)</code>

  165. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  166. <div class="block">Create an Option using the current settings and with

  167.  the specified Option <code>char</code>.</div>

  168. </td>

  169. </tr>

  170. <tr id="i3" class="rowColor">

  171. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg--">hasArg</a></span>()</code>

  173. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  174. <div class="block">The next Option created will require an argument value.</div>

  175. </td>

  176. </tr>

  177. <tr id="i4" class="altColor">

  178. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg-boolean-">hasArg</a></span>(boolean&nbsp;hasArg)</code>

  180. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  181. <div class="block">The next Option created will require an argument value if

  182.  <code>hasArg</code> is true.</div>

  183. </td>

  184. </tr>

  185. <tr id="i5" class="rowColor">

  186. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs--">hasArgs</a></span>()</code>

  188. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  189. <div class="block">The next Option created can have unlimited argument values.</div>

  190. </td>

  191. </tr>

  192. <tr id="i6" class="altColor">

  193. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs-int-">hasArgs</a></span>(int&nbsp;num)</code>

  195. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  196. <div class="block">The next Option created can have <code>num</code> argument values.</div>

  197. </td>

  198. </tr>

  199. <tr id="i7" class="rowColor">

  200. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArg--">hasOptionalArg</a></span>()</code>

  202. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  203. <div class="block">The next Option can have an optional argument.</div>

  204. </td>

  205. </tr>

  206. <tr id="i8" class="altColor">

  207. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  208. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs--">hasOptionalArgs</a></span>()</code>

  209. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  210. <div class="block">The next Option can have an unlimited number of optional arguments.</div>

  211. </td>

  212. </tr>

  213. <tr id="i9" class="rowColor">

  214. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs-int-">hasOptionalArgs</a></span>(int&nbsp;numArgs)</code>

  216. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  217. <div class="block">The next Option can have the specified number of optional arguments.</div>

  218. </td>

  219. </tr>

  220. <tr id="i10" class="altColor">

  221. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  222. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired--">isRequired</a></span>()</code>

  223. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  224. <div class="block">The next Option created will be required.</div>

  225. </td>

  226. </tr>

  227. <tr id="i11" class="rowColor">

  228. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired-boolean-">isRequired</a></span>(boolean&nbsp;newRequired)</code>

  230. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  231. <div class="block">The next Option created will be required if <code>required</code>

  232.  is true.</div>

  233. </td>

  234. </tr>

  235. <tr id="i12" class="altColor">

  236. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  237. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withArgName-java.lang.String-">withArgName</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>&nbsp;name)</code>

  238. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  239. <div class="block">The next Option created will have the specified argument value name.</div>

  240. </td>

  241. </tr>

  242. <tr id="i13" class="rowColor">

  243. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  244. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withDescription-java.lang.String-">withDescription</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>&nbsp;newDescription)</code>

  245. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  246. <div class="block">The next Option created will have the specified description</div>

  247. </td>

  248. </tr>

  249. <tr id="i14" class="altColor">

  250. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withLongOpt-java.lang.String-">withLongOpt</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>&nbsp;newLongopt)</code>

  252. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  253. <div class="block">The next Option created will have the following long option value.</div>

  254. </td>

  255. </tr>

  256. <tr id="i15" class="rowColor">

  257. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  258. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-">withType</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>&lt;?&gt;&nbsp;newType)</code>

  259. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  260. <div class="block">The next Option created will have a value that will be an instance

  261.  of <code>type</code>.</div>

  262. </td>

  263. </tr>

  264. <tr id="i16" class="altColor">

  265. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  266. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Object-">withType</a></span>(<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>&nbsp;newType)</code>

  267. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;

  268. <div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-"><code>withType(Class)</code></a> instead</span></div>

  269. </div>

  270. </td>

  271. </tr>

  272. <tr id="i17" class="rowColor">

  273. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  274. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator--">withValueSeparator</a></span>()</code>

  275. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  276. <div class="block">The next Option created uses '<code>=</code>' as a means to

  277.  separate argument values.</div>

  278. </td>

  279. </tr>

  280. <tr id="i18" class="altColor">

  281. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td>

  282. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator-char-">withValueSeparator</a></span>(char&nbsp;sep)</code>

  283. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  284. <div class="block">The next Option created uses <code>sep</code> as a means to

  285.  separate argument values.</div>

  286. </td>

  287. </tr>

  288. </table>

  289. <ul class="blockList">

  290. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">

  291. <!--   -->

  292. </a>

  293. <h3>Methods inherited from class&nbsp;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>

  294. <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>

  295. </ul>

  296. </li>

  297. </ul>

  298. </li>

  299. </ul>

  300. </div>

  301. <div class="details">

  302. <ul class="blockList">

  303. <li class="blockList">

  304. <!-- ============ METHOD DETAIL ========== -->

  305. <ul class="blockList">

  306. <li class="blockList"><a name="method.detail">

  307. <!--   -->

  308. </a>

  309. <h3>Method Detail</h3>

  310. <a name="withLongOpt-java.lang.String-">

  311. <!--   -->

  312. </a>

  313. <ul class="blockList">

  314. <li class="blockList">

  315. <h4>withLongOpt</h4>

  316. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withLongOpt(<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>&nbsp;newLongopt)</pre>

  317. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  318. <div class="block">The next Option created will have the following long option value.</div>

  319. <dl>

  320. <dt><span class="paramLabel">Parameters:</span></dt>

  321. <dd><code>newLongopt</code> - the long option value</dd>

  322. <dt><span class="returnLabel">Returns:</span></dt>

  323. <dd>the OptionBuilder instance</dd>

  324. </dl>

  325. </li>

  326. </ul>

  327. <a name="hasArg--">

  328. <!--   -->

  329. </a>

  330. <ul class="blockList">

  331. <li class="blockList">

  332. <h4>hasArg</h4>

  333. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasArg()</pre>

  334. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  335. <div class="block">The next Option created will require an argument value.</div>

  336. <dl>

  337. <dt><span class="returnLabel">Returns:</span></dt>

  338. <dd>the OptionBuilder instance</dd>

  339. </dl>

  340. </li>

  341. </ul>

  342. <a name="hasArg-boolean-">

  343. <!--   -->

  344. </a>

  345. <ul class="blockList">

  346. <li class="blockList">

  347. <h4>hasArg</h4>

  348. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasArg(boolean&nbsp;hasArg)</pre>

  349. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  350. <div class="block">The next Option created will require an argument value if

  351.  <code>hasArg</code> is true.</div>

  352. <dl>

  353. <dt><span class="paramLabel">Parameters:</span></dt>

  354. <dd><code>hasArg</code> - if true then the Option has an argument value</dd>

  355. <dt><span class="returnLabel">Returns:</span></dt>

  356. <dd>the OptionBuilder instance</dd>

  357. </dl>

  358. </li>

  359. </ul>

  360. <a name="withArgName-java.lang.String-">

  361. <!--   -->

  362. </a>

  363. <ul class="blockList">

  364. <li class="blockList">

  365. <h4>withArgName</h4>

  366. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withArgName(<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>&nbsp;name)</pre>

  367. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  368. <div class="block">The next Option created will have the specified argument value name.</div>

  369. <dl>

  370. <dt><span class="paramLabel">Parameters:</span></dt>

  371. <dd><code>name</code> - the name for the argument value</dd>

  372. <dt><span class="returnLabel">Returns:</span></dt>

  373. <dd>the OptionBuilder instance</dd>

  374. </dl>

  375. </li>

  376. </ul>

  377. <a name="isRequired--">

  378. <!--   -->

  379. </a>

  380. <ul class="blockList">

  381. <li class="blockList">

  382. <h4>isRequired</h4>

  383. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;isRequired()</pre>

  384. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  385. <div class="block">The next Option created will be required.</div>

  386. <dl>

  387. <dt><span class="returnLabel">Returns:</span></dt>

  388. <dd>the OptionBuilder instance</dd>

  389. </dl>

  390. </li>

  391. </ul>

  392. <a name="withValueSeparator-char-">

  393. <!--   -->

  394. </a>

  395. <ul class="blockList">

  396. <li class="blockList">

  397. <h4>withValueSeparator</h4>

  398. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withValueSeparator(char&nbsp;sep)</pre>

  399. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  400. <div class="block">The next Option created uses <code>sep</code> as a means to

  401.  separate argument values.

  402.  <p>

  403.  <b>Example:</b>

  404.  <pre>

  405.  Option opt = OptionBuilder.withValueSeparator('=')

  406.                            .create('D');

  407. 

  408.  String args = "-Dkey=value";

  409.  CommandLine line = parser.parse(args);

  410.  String propertyName = opt.getValue(0);  // will be "key"

  411.  String propertyValue = opt.getValue(1); // will be "value"

  412.  </pre></div>

  413. <dl>

  414. <dt><span class="paramLabel">Parameters:</span></dt>

  415. <dd><code>sep</code> - The value separator to be used for the argument values.</dd>

  416. <dt><span class="returnLabel">Returns:</span></dt>

  417. <dd>the OptionBuilder instance</dd>

  418. </dl>

  419. </li>

  420. </ul>

  421. <a name="withValueSeparator--">

  422. <!--   -->

  423. </a>

  424. <ul class="blockList">

  425. <li class="blockList">

  426. <h4>withValueSeparator</h4>

  427. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withValueSeparator()</pre>

  428. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  429. <div class="block">The next Option created uses '<code>=</code>' as a means to

  430.  separate argument values.

  431. 

  432.  <b>Example:</b>

  433.  <pre>

  434.  Option opt = OptionBuilder.withValueSeparator()

  435.                            .create('D');

  436. 

  437.  CommandLine line = parser.parse(args);

  438.  String propertyName = opt.getValue(0);

  439.  String propertyValue = opt.getValue(1);

  440.  </pre></div>

  441. <dl>

  442. <dt><span class="returnLabel">Returns:</span></dt>

  443. <dd>the OptionBuilder instance</dd>

  444. </dl>

  445. </li>

  446. </ul>

  447. <a name="isRequired-boolean-">

  448. <!--   -->

  449. </a>

  450. <ul class="blockList">

  451. <li class="blockList">

  452. <h4>isRequired</h4>

  453. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;isRequired(boolean&nbsp;newRequired)</pre>

  454. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  455. <div class="block">The next Option created will be required if <code>required</code>

  456.  is true.</div>

  457. <dl>

  458. <dt><span class="paramLabel">Parameters:</span></dt>

  459. <dd><code>newRequired</code> - if true then the Option is required</dd>

  460. <dt><span class="returnLabel">Returns:</span></dt>

  461. <dd>the OptionBuilder instance</dd>

  462. </dl>

  463. </li>

  464. </ul>

  465. <a name="hasArgs--">

  466. <!--   -->

  467. </a>

  468. <ul class="blockList">

  469. <li class="blockList">

  470. <h4>hasArgs</h4>

  471. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasArgs()</pre>

  472. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  473. <div class="block">The next Option created can have unlimited argument values.</div>

  474. <dl>

  475. <dt><span class="returnLabel">Returns:</span></dt>

  476. <dd>the OptionBuilder instance</dd>

  477. </dl>

  478. </li>

  479. </ul>

  480. <a name="hasArgs-int-">

  481. <!--   -->

  482. </a>

  483. <ul class="blockList">

  484. <li class="blockList">

  485. <h4>hasArgs</h4>

  486. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasArgs(int&nbsp;num)</pre>

  487. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  488. <div class="block">The next Option created can have <code>num</code> argument values.</div>

  489. <dl>

  490. <dt><span class="paramLabel">Parameters:</span></dt>

  491. <dd><code>num</code> - the number of args that the option can have</dd>

  492. <dt><span class="returnLabel">Returns:</span></dt>

  493. <dd>the OptionBuilder instance</dd>

  494. </dl>

  495. </li>

  496. </ul>

  497. <a name="hasOptionalArg--">

  498. <!--   -->

  499. </a>

  500. <ul class="blockList">

  501. <li class="blockList">

  502. <h4>hasOptionalArg</h4>

  503. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasOptionalArg()</pre>

  504. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  505. <div class="block">The next Option can have an optional argument.</div>

  506. <dl>

  507. <dt><span class="returnLabel">Returns:</span></dt>

  508. <dd>the OptionBuilder instance</dd>

  509. </dl>

  510. </li>

  511. </ul>

  512. <a name="hasOptionalArgs--">

  513. <!--   -->

  514. </a>

  515. <ul class="blockList">

  516. <li class="blockList">

  517. <h4>hasOptionalArgs</h4>

  518. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasOptionalArgs()</pre>

  519. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  520. <div class="block">The next Option can have an unlimited number of optional arguments.</div>

  521. <dl>

  522. <dt><span class="returnLabel">Returns:</span></dt>

  523. <dd>the OptionBuilder instance</dd>

  524. </dl>

  525. </li>

  526. </ul>

  527. <a name="hasOptionalArgs-int-">

  528. <!--   -->

  529. </a>

  530. <ul class="blockList">

  531. <li class="blockList">

  532. <h4>hasOptionalArgs</h4>

  533. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;hasOptionalArgs(int&nbsp;numArgs)</pre>

  534. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  535. <div class="block">The next Option can have the specified number of optional arguments.</div>

  536. <dl>

  537. <dt><span class="paramLabel">Parameters:</span></dt>

  538. <dd><code>numArgs</code> - - the maximum number of optional arguments

  539.  the next Option created can have.</dd>

  540. <dt><span class="returnLabel">Returns:</span></dt>

  541. <dd>the OptionBuilder instance</dd>

  542. </dl>

  543. </li>

  544. </ul>

  545. <a name="withType-java.lang.Object-">

  546. <!--   -->

  547. </a>

  548. <ul class="blockList">

  549. <li class="blockList">

  550. <h4>withType</h4>

  551. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>

  552. public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withType(<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>&nbsp;newType)</pre>

  553. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-"><code>withType(Class)</code></a> instead</span></div>

  554. <div class="block">The next Option created will have a value that will be an instance

  555.  of <code>type</code>.

  556.  <p>

  557.  <b>Note:</b> this method is kept for binary compatibility and the

  558.  input type is supposed to be a <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> object.</div>

  559. <dl>

  560. <dt><span class="paramLabel">Parameters:</span></dt>

  561. <dd><code>newType</code> - the type of the Options argument value</dd>

  562. <dt><span class="returnLabel">Returns:</span></dt>

  563. <dd>the OptionBuilder instance</dd>

  564. </dl>

  565. </li>

  566. </ul>

  567. <a name="withType-java.lang.Class-">

  568. <!--   -->

  569. </a>

  570. <ul class="blockList">

  571. <li class="blockList">

  572. <h4>withType</h4>

  573. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withType(<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>&lt;?&gt;&nbsp;newType)</pre>

  574. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  575. <div class="block">The next Option created will have a value that will be an instance

  576.  of <code>type</code>.</div>

  577. <dl>

  578. <dt><span class="paramLabel">Parameters:</span></dt>

  579. <dd><code>newType</code> - the type of the Options argument value</dd>

  580. <dt><span class="returnLabel">Returns:</span></dt>

  581. <dd>the OptionBuilder instance</dd>

  582. <dt><span class="simpleTagLabel">Since:</span></dt>

  583. <dd>1.3</dd>

  584. </dl>

  585. </li>

  586. </ul>

  587. <a name="withDescription-java.lang.String-">

  588. <!--   -->

  589. </a>

  590. <ul class="blockList">

  591. <li class="blockList">

  592. <h4>withDescription</h4>

  593. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a>&nbsp;withDescription(<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>&nbsp;newDescription)</pre>

  594. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  595. <div class="block">The next Option created will have the specified description</div>

  596. <dl>

  597. <dt><span class="paramLabel">Parameters:</span></dt>

  598. <dd><code>newDescription</code> - a description of the Option's purpose</dd>

  599. <dt><span class="returnLabel">Returns:</span></dt>

  600. <dd>the OptionBuilder instance</dd>

  601. </dl>

  602. </li>

  603. </ul>

  604. <a name="create-char-">

  605. <!--   -->

  606. </a>

  607. <ul class="blockList">

  608. <li class="blockList">

  609. <h4>create</h4>

  610. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;create(char&nbsp;opt)

  611.                      throws <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></pre>

  612. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  613. <div class="block">Create an Option using the current settings and with

  614.  the specified Option <code>char</code>.</div>

  615. <dl>

  616. <dt><span class="paramLabel">Parameters:</span></dt>

  617. <dd><code>opt</code> - the character representation of the Option</dd>

  618. <dt><span class="returnLabel">Returns:</span></dt>

  619. <dd>the Option instance</dd>

  620. <dt><span class="throwsLabel">Throws:</span></dt>

  621. <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 <code>opt</code> is not

  622.  a valid character.  See Option.</dd>

  623. </dl>

  624. </li>

  625. </ul>

  626. <a name="create--">

  627. <!--   -->

  628. </a>

  629. <ul class="blockList">

  630. <li class="blockList">

  631. <h4>create</h4>

  632. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;create()

  633.                      throws <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></pre>

  634. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  635. <div class="block">Create an Option using the current settings</div>

  636. <dl>

  637. <dt><span class="returnLabel">Returns:</span></dt>

  638. <dd>the Option instance</dd>

  639. <dt><span class="throwsLabel">Throws:</span></dt>

  640. <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 <code>longOpt</code> has not been set.</dd>

  641. </dl>

  642. </li>

  643. </ul>

  644. <a name="create-java.lang.String-">

  645. <!--   -->

  646. </a>

  647. <ul class="blockListLast">

  648. <li class="blockList">

  649. <h4>create</h4>

  650. <pre>public static&nbsp;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;create(<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>&nbsp;opt)

  651.                      throws <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></pre>

  652. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>

  653. <div class="block">Create an Option using the current settings and with

  654.  the specified Option <code>char</code>.</div>

  655. <dl>

  656. <dt><span class="paramLabel">Parameters:</span></dt>

  657. <dd><code>opt</code> - the <code>java.lang.String</code> representation

  658.  of the Option</dd>

  659. <dt><span class="returnLabel">Returns:</span></dt>

  660. <dd>the Option instance</dd>

  661. <dt><span class="throwsLabel">Throws:</span></dt>

  662. <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 <code>opt</code> is not

  663.  a valid character.  See Option.</dd>

  664. </dl>

  665. </li>

  666. </ul>

  667. </li>

  668. </ul>

  669. </li>

  670. </ul>

  671. </div>

  672. </div>

  673. <!-- ========= END OF CLASS DATA ========= -->

  674. <!-- ======= START OF BOTTOM NAVBAR ====== -->

  675. <div class="bottomNav"><a name="navbar.bottom">

  676. <!--   -->

  677. </a>

  678. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>

  679. <a name="navbar.bottom.firstrow">

  680. <!--   -->

  681. </a>

  682. <ul class="navList" title="Navigation">

  683. <li><a href="../../../../org/apache/commons/cli/package-summary.html">Package</a></li>

  684. <li class="navBarCell1Rev">Class</li>

  685. <li><a href="class-use/OptionBuilder.html">Use</a></li>

  686. <li><a href="package-tree.html">Tree</a></li>

  687. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>

  688. <li><a href="../../../../index-all.html">Index</a></li>

  689. <li><a href="../../../../help-doc.html">Help</a></li>

  690. </ul>

  691. </div>

  692. <div class="subNav">

  693. <ul class="navList">

  694. <li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>

  695. <li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>

  696. </ul>

  697. <ul class="navList">

  698. <li><a href="../../../../index.html?org/apache/commons/cli/OptionBuilder.html" target="_top">Frames</a></li>

  699. <li><a href="OptionBuilder.html" target="_top">No&nbsp;Frames</a></li>

  700. </ul>

  701. <ul class="navList" id="allclasses_navbar_bottom">

  702. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>

  703. </ul>

  704. <div>

  705. <script type="text/javascript"><!--

  706.   allClassesLink = document.getElementById("allclasses_navbar_bottom");

  707.   if(window==top) {

  708.     allClassesLink.style.display = "block";

  709.   }

  710.   else {

  711.     allClassesLink.style.display = "none";

  712.   }

  713.   //-->

  714. </script>

  715. </div>

  716. <div>

  717. <ul class="subNavList">

  718. <li>Summary:&nbsp;</li>

  719. <li>Nested&nbsp;|&nbsp;</li>

  720. <li>Field&nbsp;|&nbsp;</li>

  721. <li>Constr&nbsp;|&nbsp;</li>

  722. <li><a href="#method.summary">Method</a></li>

  723. </ul>

  724. <ul class="subNavList">

  725. <li>Detail:&nbsp;</li>

  726. <li>Field&nbsp;|&nbsp;</li>

  727. <li>Constr&nbsp;|&nbsp;</li>

  728. <li><a href="#method.detail">Method</a></li>

  729. </ul>

  730. </div>

  731. <a name="skip.navbar.bottom">

  732. <!--   -->

  733. </a></div>

  734. <!-- ======== END OF BOTTOM NAVBAR ======= -->

  735. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>

  736. </body>

  737. </html>