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.
1 Commit
1 Branch
7.9 MiB
 
 
 
 
Tree: e2a6319055
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e2a6319055'
${ noResults }
virtualModem/libs/commons-cli-1.4/apidocs/org/apache/commons/cli/Options.html

669 lines
37 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>Options (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="Options (Apache Commons CLI 1.4 API)";

  16.         }

  17.     }

  18.     catch(err) {

  19.     }

  20. //-->

  21. 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,"i14":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/Options.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/OptionGroup.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/ParseException.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/Options.html" target="_top">Frames</a></li>

  56. <li><a href="Options.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 Options" class="title">Class Options</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.Options</li>

  103. </ul>

  104. </li>

  105. </ul>

  106. <div class="description">

  107. <ul class="blockList">

  108. <li class="blockList">

  109. <dl>

  110. <dt>All Implemented Interfaces:</dt>

  111. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>

  112. </dl>

  113. <hr>

  114. <br>

  115. <pre>public class <span class="typeNameLabel">Options</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>

  117. implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>

  118. <div class="block">Main entry-point into the library.

  119.  <p>

  120.  Options represents a collection of <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> objects, which

  121.  describe the possible options for a command-line.

  122.  <p>

  123.  It may flexibly parse long and short options, with or without

  124.  values.  Additionally, it may parse only a portion of a commandline,

  125.  allowing for flexible multi-stage parsing.</div>

  126. <dl>

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

  128. <dd>$Id: Options.java 1754332 2016-07-27 18:47:57Z britter $</dd>

  129. <dt><span class="seeLabel">See Also:</span></dt>

  130. <dd><a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><code>CommandLine</code></a>, 

  131. <a href="../../../../serialized-form.html#org.apache.commons.cli.Options">Serialized Form</a></dd>

  132. </dl>

  133. </li>

  134. </ul>

  135. </div>

  136. <div class="summary">

  137. <ul class="blockList">

  138. <li class="blockList">

  139. <!-- ======== CONSTRUCTOR SUMMARY ======== -->

  140. <ul class="blockList">

  141. <li class="blockList"><a name="constructor.summary">

  142. <!--   -->

  143. </a>

  144. <h3>Constructor Summary</h3>

  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">

  146. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>

  147. <tr>

  148. <th class="colOne" scope="col">Constructor and Description</th>

  149. </tr>

  150. <tr class="altColor">

  151. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#Options--">Options</a></span>()</code>&nbsp;</td>

  152. </tr>

  153. </table>

  154. </li>

  155. </ul>

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

  157. <ul class="blockList">

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

  159. <!--   -->

  160. </a>

  161. <h3>Method Summary</h3>

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

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

  164. <tr>

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

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

  167. </tr>

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

  169. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.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>

  171. <div class="block">Adds an option instance</div>

  172. </td>

  173. </tr>

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

  175. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#addOption-java.lang.String-boolean-java.lang.String-">addOption</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,

  177.          boolean&nbsp;hasArg,

  178.          <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;description)</code>

  179. <div class="block">Add an option that only contains a short-name.</div>

  180. </td>

  181. </tr>

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

  183. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-">addOption</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,

  185.          <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;description)</code>

  186. <div class="block">Add an option that only contains a short name.</div>

  187. </td>

  188. </tr>

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

  190. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addOption</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,

  192.          <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;longOpt,

  193.          boolean&nbsp;hasArg,

  194.          <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;description)</code>

  195. <div class="block">Add an option that contains a short-name and a long-name.</div>

  196. </td>

  197. </tr>

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

  199. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#addOptionGroup-org.apache.commons.cli.OptionGroup-">addOptionGroup</a></span>(<a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a>&nbsp;group)</code>

  201. <div class="block">Add the specified option group.</div>

  202. </td>

  203. </tr>

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

  205. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></code></td>

  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#addRequiredOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addRequiredOption</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,

  207.                  <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;longOpt,

  208.                  boolean&nbsp;hasArg,

  209.                  <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;description)</code>

  210. <div class="block">Add an option that contains a short-name and a long-name.</div>

  211. </td>

  212. </tr>

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

  214. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>

  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#getMatchingOptions-java.lang.String-">getMatchingOptions</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>

  216. <div class="block">Returns the options with a long name starting with the name specified.</div>

  217. </td>

  218. </tr>

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

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

  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#getOption-java.lang.String-">getOption</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>

  222. <div class="block">Retrieve the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> matching the long or short name specified.</div>

  223. </td>

  224. </tr>

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

  226. <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></code></td>

  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#getOptionGroup-org.apache.commons.cli.Option-">getOptionGroup</a></span>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;opt)</code>

  228. <div class="block">Returns the OptionGroup the <code>opt</code> belongs to.</div>

  229. </td>

  230. </tr>

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

  232. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&gt;</code></td>

  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#getOptions--">getOptions</a></span>()</code>

  234. <div class="block">Retrieve a read-only list of options in this set</div>

  235. </td>

  236. </tr>

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

  238. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>

  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#getRequiredOptions--">getRequiredOptions</a></span>()</code>

  240. <div class="block">Returns the required options.</div>

  241. </td>

  242. </tr>

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

  244. <td class="colFirst"><code>boolean</code></td>

  245. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#hasLongOption-java.lang.String-">hasLongOption</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>

  246. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  247. </td>

  248. </tr>

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

  250. <td class="colFirst"><code>boolean</code></td>

  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#hasOption-java.lang.String-">hasOption</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>

  252. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  253. </td>

  254. </tr>

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

  256. <td class="colFirst"><code>boolean</code></td>

  257. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#hasShortOption-java.lang.String-">hasShortOption</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>

  258. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  259. </td>

  260. </tr>

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

  262. <td class="colFirst"><code><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></code></td>

  263. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Options.html#toString--">toString</a></span>()</code>

  264. <div class="block">Dump state, suitable for debugging.</div>

  265. </td>

  266. </tr>

  267. </table>

  268. <ul class="blockList">

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

  270. <!--   -->

  271. </a>

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

  273. <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#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>

  274. </ul>

  275. </li>

  276. </ul>

  277. </li>

  278. </ul>

  279. </div>

  280. <div class="details">

  281. <ul class="blockList">

  282. <li class="blockList">

  283. <!-- ========= CONSTRUCTOR DETAIL ======== -->

  284. <ul class="blockList">

  285. <li class="blockList"><a name="constructor.detail">

  286. <!--   -->

  287. </a>

  288. <h3>Constructor Detail</h3>

  289. <a name="Options--">

  290. <!--   -->

  291. </a>

  292. <ul class="blockListLast">

  293. <li class="blockList">

  294. <h4>Options</h4>

  295. <pre>public&nbsp;Options()</pre>

  296. </li>

  297. </ul>

  298. </li>

  299. </ul>

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

  301. <ul class="blockList">

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

  303. <!--   -->

  304. </a>

  305. <h3>Method Detail</h3>

  306. <a name="addOptionGroup-org.apache.commons.cli.OptionGroup-">

  307. <!--   -->

  308. </a>

  309. <ul class="blockList">

  310. <li class="blockList">

  311. <h4>addOptionGroup</h4>

  312. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addOptionGroup(<a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a>&nbsp;group)</pre>

  313. <div class="block">Add the specified option group.</div>

  314. <dl>

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

  316. <dd><code>group</code> - the OptionGroup that is to be added</dd>

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

  318. <dd>the resulting Options instance</dd>

  319. </dl>

  320. </li>

  321. </ul>

  322. <a name="addOption-java.lang.String-java.lang.String-">

  323. <!--   -->

  324. </a>

  325. <ul class="blockList">

  326. <li class="blockList">

  327. <h4>addOption</h4>

  328. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addOption(<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,

  329.                          <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;description)</pre>

  330. <div class="block">Add an option that only contains a short name.

  331.  

  332.  <p>

  333.  The option does not take an argument.

  334.  </p></div>

  335. <dl>

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

  337. <dd><code>opt</code> - Short single-character name of the option.</dd>

  338. <dd><code>description</code> - Self-documenting description</dd>

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

  340. <dd>the resulting Options instance</dd>

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

  342. <dd>1.3</dd>

  343. </dl>

  344. </li>

  345. </ul>

  346. <a name="addOption-java.lang.String-boolean-java.lang.String-">

  347. <!--   -->

  348. </a>

  349. <ul class="blockList">

  350. <li class="blockList">

  351. <h4>addOption</h4>

  352. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addOption(<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,

  353.                          boolean&nbsp;hasArg,

  354.                          <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;description)</pre>

  355. <div class="block">Add an option that only contains a short-name.

  356. 

  357.  <p>

  358.  It may be specified as requiring an argument.

  359.  </p></div>

  360. <dl>

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

  362. <dd><code>opt</code> - Short single-character name of the option.</dd>

  363. <dd><code>hasArg</code> - flag signally if an argument is required after this option</dd>

  364. <dd><code>description</code> - Self-documenting description</dd>

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

  366. <dd>the resulting Options instance</dd>

  367. </dl>

  368. </li>

  369. </ul>

  370. <a name="addOption-java.lang.String-java.lang.String-boolean-java.lang.String-">

  371. <!--   -->

  372. </a>

  373. <ul class="blockList">

  374. <li class="blockList">

  375. <h4>addOption</h4>

  376. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addOption(<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,

  377.                          <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;longOpt,

  378.                          boolean&nbsp;hasArg,

  379.                          <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;description)</pre>

  380. <div class="block">Add an option that contains a short-name and a long-name.

  381. 

  382.  <p>

  383.  It may be specified as requiring an argument.

  384.  </p></div>

  385. <dl>

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

  387. <dd><code>opt</code> - Short single-character name of the option.</dd>

  388. <dd><code>longOpt</code> - Long multi-character name of the option.</dd>

  389. <dd><code>hasArg</code> - flag signally if an argument is required after this option</dd>

  390. <dd><code>description</code> - Self-documenting description</dd>

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

  392. <dd>the resulting Options instance</dd>

  393. </dl>

  394. </li>

  395. </ul>

  396. <a name="addRequiredOption-java.lang.String-java.lang.String-boolean-java.lang.String-">

  397. <!--   -->

  398. </a>

  399. <ul class="blockList">

  400. <li class="blockList">

  401. <h4>addRequiredOption</h4>

  402. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addRequiredOption(<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,

  403.                                  <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;longOpt,

  404.                                  boolean&nbsp;hasArg,

  405.                                  <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;description)</pre>

  406. <div class="block">Add an option that contains a short-name and a long-name.

  407.  

  408.  <p>

  409.  The added option is set as required. It may be specified as requiring an argument. This method is a shortcut for:

  410.  </p>

  411. 

  412.  <pre>

  413.  <code>

  414.  Options option = new Option(opt, longOpt, hasArg, description);

  415.  option.setRequired(true);

  416.  options.add(option);

  417.  </code>

  418.  </pre></div>

  419. <dl>

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

  421. <dd><code>opt</code> - Short single-character name of the option.</dd>

  422. <dd><code>longOpt</code> - Long multi-character name of the option.</dd>

  423. <dd><code>hasArg</code> - flag signally if an argument is required after this option</dd>

  424. <dd><code>description</code> - Self-documenting description</dd>

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

  426. <dd>the resulting Options instance</dd>

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

  428. <dd>1.4</dd>

  429. </dl>

  430. </li>

  431. </ul>

  432. <a name="addOption-org.apache.commons.cli.Option-">

  433. <!--   -->

  434. </a>

  435. <ul class="blockList">

  436. <li class="blockList">

  437. <h4>addOption</h4>

  438. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;addOption(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;opt)</pre>

  439. <div class="block">Adds an option instance</div>

  440. <dl>

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

  442. <dd><code>opt</code> - the option that is to be added</dd>

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

  444. <dd>the resulting Options instance</dd>

  445. </dl>

  446. </li>

  447. </ul>

  448. <a name="getOptions--">

  449. <!--   -->

  450. </a>

  451. <ul class="blockList">

  452. <li class="blockList">

  453. <h4>getOptions</h4>

  454. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&gt;&nbsp;getOptions()</pre>

  455. <div class="block">Retrieve a read-only list of options in this set</div>

  456. <dl>

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

  458. <dd>read-only Collection of <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> objects in this descriptor</dd>

  459. </dl>

  460. </li>

  461. </ul>

  462. <a name="getRequiredOptions--">

  463. <!--   -->

  464. </a>

  465. <ul class="blockList">

  466. <li class="blockList">

  467. <h4>getRequiredOptions</h4>

  468. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;getRequiredOptions()</pre>

  469. <div class="block">Returns the required options.</div>

  470. <dl>

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

  472. <dd>read-only List of required options</dd>

  473. </dl>

  474. </li>

  475. </ul>

  476. <a name="getOption-java.lang.String-">

  477. <!--   -->

  478. </a>

  479. <ul class="blockList">

  480. <li class="blockList">

  481. <h4>getOption</h4>

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

  483. <div class="block">Retrieve the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> matching the long or short name specified.

  484. 

  485.  <p>

  486.  The leading hyphens in the name are ignored (up to 2).

  487.  </p></div>

  488. <dl>

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

  490. <dd><code>opt</code> - short or long name of the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a></dd>

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

  492. <dd>the option represented by opt</dd>

  493. </dl>

  494. </li>

  495. </ul>

  496. <a name="getMatchingOptions-java.lang.String-">

  497. <!--   -->

  498. </a>

  499. <ul class="blockList">

  500. <li class="blockList">

  501. <h4>getMatchingOptions</h4>

  502. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;getMatchingOptions(<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)</pre>

  503. <div class="block">Returns the options with a long name starting with the name specified.</div>

  504. <dl>

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

  506. <dd><code>opt</code> - the partial name of the option</dd>

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

  508. <dd>the options matching the partial name specified, or an empty list if none matches</dd>

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

  510. <dd>1.3</dd>

  511. </dl>

  512. </li>

  513. </ul>

  514. <a name="hasOption-java.lang.String-">

  515. <!--   -->

  516. </a>

  517. <ul class="blockList">

  518. <li class="blockList">

  519. <h4>hasOption</h4>

  520. <pre>public&nbsp;boolean&nbsp;hasOption(<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)</pre>

  521. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  522. <dl>

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

  524. <dd><code>opt</code> - short or long name of the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a></dd>

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

  526. <dd>true if the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a></dd>

  527. </dl>

  528. </li>

  529. </ul>

  530. <a name="hasLongOption-java.lang.String-">

  531. <!--   -->

  532. </a>

  533. <ul class="blockList">

  534. <li class="blockList">

  535. <h4>hasLongOption</h4>

  536. <pre>public&nbsp;boolean&nbsp;hasLongOption(<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)</pre>

  537. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  538. <dl>

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

  540. <dd><code>opt</code> - long name of the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a></dd>

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

  542. <dd>true if the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a></dd>

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

  544. <dd>1.3</dd>

  545. </dl>

  546. </li>

  547. </ul>

  548. <a name="hasShortOption-java.lang.String-">

  549. <!--   -->

  550. </a>

  551. <ul class="blockList">

  552. <li class="blockList">

  553. <h4>hasShortOption</h4>

  554. <pre>public&nbsp;boolean&nbsp;hasShortOption(<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)</pre>

  555. <div class="block">Returns whether the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>

  556. <dl>

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

  558. <dd><code>opt</code> - short name of the <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a></dd>

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

  560. <dd>true if the named <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a></dd>

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

  562. <dd>1.3</dd>

  563. </dl>

  564. </li>

  565. </ul>

  566. <a name="getOptionGroup-org.apache.commons.cli.Option-">

  567. <!--   -->

  568. </a>

  569. <ul class="blockList">

  570. <li class="blockList">

  571. <h4>getOptionGroup</h4>

  572. <pre>public&nbsp;<a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a>&nbsp;getOptionGroup(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&nbsp;opt)</pre>

  573. <div class="block">Returns the OptionGroup the <code>opt</code> belongs to.</div>

  574. <dl>

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

  576. <dd><code>opt</code> - the option whose OptionGroup is being queried.</dd>

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

  578. <dd>the OptionGroup if <code>opt</code> is part of an OptionGroup, otherwise return null</dd>

  579. </dl>

  580. </li>

  581. </ul>

  582. <a name="toString--">

  583. <!--   -->

  584. </a>

  585. <ul class="blockListLast">

  586. <li class="blockList">

  587. <h4>toString</h4>

  588. <pre>public&nbsp;<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;toString()</pre>

  589. <div class="block">Dump state, suitable for debugging.</div>

  590. <dl>

  591. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>

  592. <dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>

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

  594. <dd>Stringified form of this object</dd>

  595. </dl>

  596. </li>

  597. </ul>

  598. </li>

  599. </ul>

  600. </li>

  601. </ul>

  602. </div>

  603. </div>

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

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

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

  607. <!--   -->

  608. </a>

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

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

  611. <!--   -->

  612. </a>

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

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

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

  616. <li><a href="class-use/Options.html">Use</a></li>

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

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

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

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

  621. </ul>

  622. </div>

  623. <div class="subNav">

  624. <ul class="navList">

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

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

  627. </ul>

  628. <ul class="navList">

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

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

  631. </ul>

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

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

  634. </ul>

  635. <div>

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

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

  638.   if(window==top) {

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

  640.   }

  641.   else {

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

  643.   }

  644.   //-->

  645. </script>

  646. </div>

  647. <div>

  648. <ul class="subNavList">

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

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

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

  652. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>

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

  654. </ul>

  655. <ul class="subNavList">

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

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

  658. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>

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

  660. </ul>

  661. </div>

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

  663. <!--   -->

  664. </a></div>

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

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

  667. </body>

  668. </html>