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.

CommandLine.Builder.html 14 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>CommandLine.Builder (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="CommandLine.Builder (Apache Commons CLI 1.4 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CommandLine.Builder.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/CommandLine.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/CommandLineParser.html" title="interface 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/CommandLine.Builder.html" target="_top">Frames</a></li>
  56. <li><a href="CommandLine.Builder.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 CommandLine.Builder" class="title">Class CommandLine.Builder</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.CommandLine.Builder</li>
  103. </ul>
  104. </li>
  105. </ul>
  106. <div class="description">
  107. <ul class="blockList">
  108. <li class="blockList">
  109. <dl>
  110. <dt>Enclosing class:</dt>
  111. <dd><a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dd>
  112. </dl>
  113. <hr>
  114. <br>
  115. <pre>public static final class <span class="typeNameLabel">CommandLine.Builder</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">A nested builder class to create <code>CommandLine</code> instance
  118. using descriptive methods.</div>
  119. <dl>
  120. <dt><span class="simpleTagLabel">Since:</span></dt>
  121. <dd>1.4</dd>
  122. </dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="constructor.summary">
  132. <!-- -->
  133. </a>
  134. <h3>Constructor Summary</h3>
  135. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  136. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  137. <tr>
  138. <th class="colOne" scope="col">Constructor and Description</th>
  139. </tr>
  140. <tr class="altColor">
  141. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html#Builder--">Builder</a></span>()</code>&nbsp;</td>
  142. </tr>
  143. </table>
  144. </li>
  145. </ul>
  146. <!-- ========== METHOD SUMMARY =========== -->
  147. <ul class="blockList">
  148. <li class="blockList"><a name="method.summary">
  149. <!-- -->
  150. </a>
  151. <h3>Method Summary</h3>
  152. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  153. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></caption>
  154. <tr>
  155. <th class="colFirst" scope="col">Modifier and Type</th>
  156. <th class="colLast" scope="col">Method and Description</th>
  157. </tr>
  158. <tr id="i0" class="altColor">
  159. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html#addArg-java.lang.String-">addArg</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;arg)</code>
  161. <div class="block">Add left-over unrecognized option/argument.</div>
  162. </td>
  163. </tr>
  164. <tr id="i1" class="rowColor">
  165. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html#addOption-org.apache.commons.cli.Option-">addOption</a></span>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;opt)</code>
  167. <div class="block">Add an option to the command line.</div>
  168. </td>
  169. </tr>
  170. <tr id="i2" class="altColor">
  171. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html#build--">build</a></span>()</code>&nbsp;</td>
  173. </tr>
  174. </table>
  175. <ul class="blockList">
  176. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  177. <!-- -->
  178. </a>
  179. <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>
  180. <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>
  181. </ul>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. <div class="details">
  188. <ul class="blockList">
  189. <li class="blockList">
  190. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  191. <ul class="blockList">
  192. <li class="blockList"><a name="constructor.detail">
  193. <!-- -->
  194. </a>
  195. <h3>Constructor Detail</h3>
  196. <a name="Builder--">
  197. <!-- -->
  198. </a>
  199. <ul class="blockListLast">
  200. <li class="blockList">
  201. <h4>Builder</h4>
  202. <pre>public&nbsp;Builder()</pre>
  203. </li>
  204. </ul>
  205. </li>
  206. </ul>
  207. <!-- ============ METHOD DETAIL ========== -->
  208. <ul class="blockList">
  209. <li class="blockList"><a name="method.detail">
  210. <!-- -->
  211. </a>
  212. <h3>Method Detail</h3>
  213. <a name="addOption-org.apache.commons.cli.Option-">
  214. <!-- -->
  215. </a>
  216. <ul class="blockList">
  217. <li class="blockList">
  218. <h4>addOption</h4>
  219. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a>&nbsp;addOption(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;opt)</pre>
  220. <div class="block">Add an option to the command line. The values of the option are stored.</div>
  221. <dl>
  222. <dt><span class="paramLabel">Parameters:</span></dt>
  223. <dd><code>opt</code> - the processed option</dd>
  224. <dt><span class="returnLabel">Returns:</span></dt>
  225. <dd>this Builder instance for method chaining.</dd>
  226. </dl>
  227. </li>
  228. </ul>
  229. <a name="addArg-java.lang.String-">
  230. <!-- -->
  231. </a>
  232. <ul class="blockList">
  233. <li class="blockList">
  234. <h4>addArg</h4>
  235. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a>&nbsp;addArg(<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;arg)</pre>
  236. <div class="block">Add left-over unrecognized option/argument.</div>
  237. <dl>
  238. <dt><span class="paramLabel">Parameters:</span></dt>
  239. <dd><code>arg</code> - the unrecognized option/argument.</dd>
  240. <dt><span class="returnLabel">Returns:</span></dt>
  241. <dd>this Builder instance for method chaining.</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. <a name="build--">
  246. <!-- -->
  247. </a>
  248. <ul class="blockListLast">
  249. <li class="blockList">
  250. <h4>build</h4>
  251. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a>&nbsp;build()</pre>
  252. </li>
  253. </ul>
  254. </li>
  255. </ul>
  256. </li>
  257. </ul>
  258. </div>
  259. </div>
  260. <!-- ========= END OF CLASS DATA ========= -->
  261. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  262. <div class="bottomNav"><a name="navbar.bottom">
  263. <!-- -->
  264. </a>
  265. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  266. <a name="navbar.bottom.firstrow">
  267. <!-- -->
  268. </a>
  269. <ul class="navList" title="Navigation">
  270. <li><a href="../../../../org/apache/commons/cli/package-summary.html">Package</a></li>
  271. <li class="navBarCell1Rev">Class</li>
  272. <li><a href="class-use/CommandLine.Builder.html">Use</a></li>
  273. <li><a href="package-tree.html">Tree</a></li>
  274. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  275. <li><a href="../../../../index-all.html">Index</a></li>
  276. <li><a href="../../../../help-doc.html">Help</a></li>
  277. </ul>
  278. </div>
  279. <div class="subNav">
  280. <ul class="navList">
  281. <li><a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  282. <li><a href="../../../../org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  283. </ul>
  284. <ul class="navList">
  285. <li><a href="../../../../index.html?org/apache/commons/cli/CommandLine.Builder.html" target="_top">Frames</a></li>
  286. <li><a href="CommandLine.Builder.html" target="_top">No&nbsp;Frames</a></li>
  287. </ul>
  288. <ul class="navList" id="allclasses_navbar_bottom">
  289. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  290. </ul>
  291. <div>
  292. <script type="text/javascript"><!--
  293. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  294. if(window==top) {
  295. allClassesLink.style.display = "block";
  296. }
  297. else {
  298. allClassesLink.style.display = "none";
  299. }
  300. //-->
  301. </script>
  302. </div>
  303. <div>
  304. <ul class="subNavList">
  305. <li>Summary:&nbsp;</li>
  306. <li>Nested&nbsp;|&nbsp;</li>
  307. <li>Field&nbsp;|&nbsp;</li>
  308. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  309. <li><a href="#method.summary">Method</a></li>
  310. </ul>
  311. <ul class="subNavList">
  312. <li>Detail:&nbsp;</li>
  313. <li>Field&nbsp;|&nbsp;</li>
  314. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  315. <li><a href="#method.detail">Method</a></li>
  316. </ul>
  317. </div>
  318. <a name="skip.navbar.bottom">
  319. <!-- -->
  320. </a></div>
  321. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  322. <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>
  323. </body>
  324. </html>