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.
 
 
 
 

1449 lines
118 KiB

  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>Index (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="Index (Apache Commons CLI 1.4 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. </script>
  22. <noscript>
  23. <div>JavaScript is disabled on your browser.</div>
  24. </noscript>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <div class="topNav"><a name="navbar.top">
  27. <!-- -->
  28. </a>
  29. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  30. <a name="navbar.top.firstrow">
  31. <!-- -->
  32. </a>
  33. <ul class="navList" title="Navigation">
  34. <li><a href="org/apache/commons/cli/package-summary.html">Package</a></li>
  35. <li>Class</li>
  36. <li>Use</li>
  37. <li><a href="org/apache/commons/cli/package-tree.html">Tree</a></li>
  38. <li><a href="deprecated-list.html">Deprecated</a></li>
  39. <li class="navBarCell1Rev">Index</li>
  40. <li><a href="help-doc.html">Help</a></li>
  41. </ul>
  42. </div>
  43. <div class="subNav">
  44. <ul class="navList">
  45. <li>Prev</li>
  46. <li>Next</li>
  47. </ul>
  48. <ul class="navList">
  49. <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
  50. <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
  51. </ul>
  52. <ul class="navList" id="allclasses_navbar_top">
  53. <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
  54. </ul>
  55. <div>
  56. <script type="text/javascript"><!--
  57. allClassesLink = document.getElementById("allclasses_navbar_top");
  58. if(window==top) {
  59. allClassesLink.style.display = "block";
  60. }
  61. else {
  62. allClassesLink.style.display = "none";
  63. }
  64. //-->
  65. </script>
  66. </div>
  67. <a name="skip.navbar.top">
  68. <!-- -->
  69. </a></div>
  70. <!-- ========= END OF TOP NAVBAR ========= -->
  71. <div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:W">W</a>&nbsp;<a name="I:A">
  72. <!-- -->
  73. </a>
  74. <h2 class="title">A</h2>
  75. <dl>
  76. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#addArg-java.lang.String-">addArg(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  77. <dd>
  78. <div class="block">Add left-over unrecognized option/argument.</div>
  79. </dd>
  80. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#addArg-java.lang.String-">addArg(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
  81. <dd>
  82. <div class="block">Add left-over unrecognized option/argument.</div>
  83. </dd>
  84. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  85. <dd>
  86. <div class="block">Add an option to the command line.</div>
  87. </dd>
  88. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
  89. <dd>
  90. <div class="block">Add an option to the command line.</div>
  91. </dd>
  92. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  93. <dd>
  94. <div class="block">Add the specified <code>Option</code> to this group.</div>
  95. </dd>
  96. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-">addOption(String, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  97. <dd>
  98. <div class="block">Add an option that only contains a short name.</div>
  99. </dd>
  100. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-boolean-java.lang.String-">addOption(String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  101. <dd>
  102. <div class="block">Add an option that only contains a short-name.</div>
  103. </dd>
  104. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addOption(String, String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  105. <dd>
  106. <div class="block">Add an option that contains a short-name and a long-name.</div>
  107. </dd>
  108. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  109. <dd>
  110. <div class="block">Adds an option instance</div>
  111. </dd>
  112. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOptionGroup-org.apache.commons.cli.OptionGroup-">addOptionGroup(OptionGroup)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  113. <dd>
  114. <div class="block">Add the specified option group.</div>
  115. </dd>
  116. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addRequiredOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addRequiredOption(String, String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  117. <dd>
  118. <div class="block">Add an option that contains a short-name and a long-name.</div>
  119. </dd>
  120. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#addValue-java.lang.String-">addValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  121. <dd>
  122. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  123. </dd>
  124. <dt><a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">AlreadySelectedException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  125. <dd>
  126. <div class="block">Thrown when more than one option in an option group
  127. has been provided.</div>
  128. </dd>
  129. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#AlreadySelectedException-java.lang.String-">AlreadySelectedException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
  130. <dd>
  131. <div class="block">Construct a new <code>AlreadySelectedException</code>
  132. with the specified detail message.</div>
  133. </dd>
  134. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#AlreadySelectedException-org.apache.commons.cli.OptionGroup-org.apache.commons.cli.Option-">AlreadySelectedException(OptionGroup, Option)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
  135. <dd>
  136. <div class="block">Construct a new <code>AlreadySelectedException</code>
  137. for the specified option group.</div>
  138. </dd>
  139. <dt><a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">AmbiguousOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  140. <dd>
  141. <div class="block">Exception thrown when an option can't be identified from a partial name.</div>
  142. </dd>
  143. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AmbiguousOptionException.html#AmbiguousOptionException-java.lang.String-java.util.Collection-">AmbiguousOptionException(String, Collection&lt;String&gt;)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli">AmbiguousOptionException</a></dt>
  144. <dd>
  145. <div class="block">Constructs a new AmbiguousOptionException.</div>
  146. </dd>
  147. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#argName-java.lang.String-">argName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  148. <dd>
  149. <div class="block">Sets the display name for the argument value.</div>
  150. </dd>
  151. </dl>
  152. <a name="I:B">
  153. <!-- -->
  154. </a>
  155. <h2 class="title">B</h2>
  156. <dl>
  157. <dt><a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">BasicParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  158. <dd>
  159. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  160. <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
  161. </div>
  162. </dd>
  163. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/BasicParser.html#BasicParser--">BasicParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli">BasicParser</a></dt>
  164. <dd>
  165. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  166. &nbsp;</dd>
  167. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#build--">build()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
  168. <dd>&nbsp;</dd>
  169. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#build--">build()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  170. <dd>
  171. <div class="block">Constructs an Option with the values declared by this <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a>.</div>
  172. </dd>
  173. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#Builder--">Builder()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
  174. <dd>&nbsp;</dd>
  175. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#builder--">builder()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  176. <dd>
  177. <div class="block">Returns a <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive
  178. methods.</div>
  179. </dd>
  180. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#builder-java.lang.String-">builder(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  181. <dd>
  182. <div class="block">Returns a <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive
  183. methods.</div>
  184. </dd>
  185. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#burstToken-java.lang.String-boolean-">burstToken(String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
  186. <dd>
  187. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  188. <div class="block">Breaks <code>token</code> into its constituent parts
  189. using the following algorithm.</div>
  190. </dd>
  191. </dl>
  192. <a name="I:C">
  193. <!-- -->
  194. </a>
  195. <h2 class="title">C</h2>
  196. <dl>
  197. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#checkRequiredOptions--">checkRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  198. <dd>
  199. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  200. <div class="block">Throws a <a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><code>MissingOptionException</code></a> if all of the required options
  201. are not present.</div>
  202. </dd>
  203. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#CLASS_VALUE">CLASS_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  204. <dd>
  205. <div class="block">Class class</div>
  206. </dd>
  207. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#clone--">clone()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  208. <dd>
  209. <div class="block">A rather odd clone method - due to incorrect code in 1.0 it is public
  210. and in 1.1 rather than throwing a CloneNotSupportedException it throws
  211. a RuntimeException so as to maintain backwards compat at the API level.</div>
  212. </dd>
  213. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#cmd">cmd</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  214. <dd>
  215. <div class="block">The command-line instance.</div>
  216. </dd>
  217. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#cmd">cmd</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  218. <dd>
  219. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  220. <div class="block">commandline instance</div>
  221. </dd>
  222. <dt><a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><span class="typeNameLink">CommandLine</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  223. <dd>
  224. <div class="block">Represents list of arguments parsed against a <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> descriptor.</div>
  225. </dd>
  226. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#CommandLine--">CommandLine()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  227. <dd>
  228. <div class="block">Creates a command line.</div>
  229. </dd>
  230. <dt><a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">CommandLine.Builder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  231. <dd>
  232. <div class="block">A nested builder class to create <code>CommandLine</code> instance
  233. using descriptive methods.</div>
  234. </dd>
  235. <dt><a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli"><span class="typeNameLink">CommandLineParser</span></a> - Interface in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  236. <dd>
  237. <div class="block">A class that implements the <code>CommandLineParser</code> interface
  238. can parse a String array according to the <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> specified
  239. and return a <a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><code>CommandLine</code></a>.</div>
  240. </dd>
  241. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create-char-">create(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  242. <dd>
  243. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  244. <div class="block">Create an Option using the current settings and with
  245. the specified Option <code>char</code>.</div>
  246. </dd>
  247. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create--">create()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  248. <dd>
  249. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  250. <div class="block">Create an Option using the current settings</div>
  251. </dd>
  252. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create-java.lang.String-">create(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  253. <dd>
  254. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  255. <div class="block">Create an Option using the current settings and with
  256. the specified Option <code>char</code>.</div>
  257. </dd>
  258. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createClass-java.lang.String-">createClass(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  259. <dd>
  260. <div class="block">Returns the class whose name is <code>classname</code>.</div>
  261. </dd>
  262. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createDate-java.lang.String-">createDate(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  263. <dd>
  264. <div class="block">Returns the date represented by <code>str</code>.</div>
  265. </dd>
  266. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createFile-java.lang.String-">createFile(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  267. <dd>
  268. <div class="block">Returns the File represented by <code>str</code>.</div>
  269. </dd>
  270. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createFiles-java.lang.String-">createFiles(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  271. <dd>
  272. <div class="block">Returns the File[] represented by <code>str</code>.</div>
  273. </dd>
  274. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createNumber-java.lang.String-">createNumber(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  275. <dd>
  276. <div class="block">Create a number from a String.</div>
  277. </dd>
  278. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createObject-java.lang.String-">createObject(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  279. <dd>
  280. <div class="block">Create an Object from the classname and empty constructor.</div>
  281. </dd>
  282. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#createPadding-int-">createPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  283. <dd>
  284. <div class="block">Return a String of padding of length <code>len</code>.</div>
  285. </dd>
  286. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createURL-java.lang.String-">createURL(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  287. <dd>
  288. <div class="block">Returns the URL represented by <code>str</code>.</div>
  289. </dd>
  290. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createValue-java.lang.String-java.lang.Object-">createValue(String, Object)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  291. <dd>
  292. <div class="block">Returns the <code>Object</code> of type <code>obj</code>
  293. with the value of <code>str</code>.</div>
  294. </dd>
  295. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createValue-java.lang.String-java.lang.Class-">createValue(String, Class&lt;?&gt;)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  296. <dd>
  297. <div class="block">Returns the <code>Object</code> of type <code>clazz</code>
  298. with the value of <code>str</code>.</div>
  299. </dd>
  300. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#currentOption">currentOption</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  301. <dd>
  302. <div class="block">The last option parsed.</div>
  303. </dd>
  304. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#currentToken">currentToken</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  305. <dd>
  306. <div class="block">The token currently processed.</div>
  307. </dd>
  308. </dl>
  309. <a name="I:D">
  310. <!-- -->
  311. </a>
  312. <h2 class="title">D</h2>
  313. <dl>
  314. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#DATE_VALUE">DATE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  315. <dd>
  316. <div class="block">Date class</div>
  317. </dd>
  318. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_ARG_NAME">DEFAULT_ARG_NAME</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  319. <dd>
  320. <div class="block">default name for an argument</div>
  321. </dd>
  322. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_DESC_PAD">DEFAULT_DESC_PAD</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  323. <dd>
  324. <div class="block">number of space characters to be prefixed to each description line</div>
  325. </dd>
  326. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LEFT_PAD">DEFAULT_LEFT_PAD</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  327. <dd>
  328. <div class="block">default padding to the left of each line</div>
  329. </dd>
  330. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_PREFIX">DEFAULT_LONG_OPT_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  331. <dd>
  332. <div class="block">default prefix for long Option</div>
  333. </dd>
  334. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_SEPARATOR">DEFAULT_LONG_OPT_SEPARATOR</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  335. <dd>
  336. <div class="block">default separator displayed between a long Option and its value</div>
  337. </dd>
  338. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_OPT_PREFIX">DEFAULT_OPT_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  339. <dd>
  340. <div class="block">default prefix for shortOpts</div>
  341. </dd>
  342. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_SYNTAX_PREFIX">DEFAULT_SYNTAX_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  343. <dd>
  344. <div class="block">the string to display at the beginning of the usage statement</div>
  345. </dd>
  346. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_WIDTH">DEFAULT_WIDTH</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  347. <dd>
  348. <div class="block">default number of characters per line</div>
  349. </dd>
  350. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultArgName">defaultArgName</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  351. <dd>
  352. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  353. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  354. - use get/setArgName methods instead.</span></div>
  355. </div>
  356. </dd>
  357. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultDescPad">defaultDescPad</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  358. <dd>
  359. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  360. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  361. - use get/setDescPadding methods instead.</span></div>
  362. </div>
  363. </dd>
  364. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultLeftPad">defaultLeftPad</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  365. <dd>
  366. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  367. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  368. - use get/setLeftPadding methods instead.</span></div>
  369. </div>
  370. </dd>
  371. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultLongOptPrefix">defaultLongOptPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  372. <dd>
  373. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  374. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  375. - use get/setLongOptPrefix methods instead.</span></div>
  376. </div>
  377. </dd>
  378. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultNewLine">defaultNewLine</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  379. <dd>
  380. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  381. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  382. - use get/setNewLine methods instead.</span></div>
  383. </div>
  384. </dd>
  385. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultOptPrefix">defaultOptPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  386. <dd>
  387. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  388. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  389. - use get/setOptPrefix methods instead.</span></div>
  390. </div>
  391. </dd>
  392. <dt><a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">DefaultParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  393. <dd>
  394. <div class="block">Default parser.</div>
  395. </dd>
  396. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#DefaultParser--">DefaultParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  397. <dd>&nbsp;</dd>
  398. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultSyntaxPrefix">defaultSyntaxPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  399. <dd>
  400. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  401. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  402. - use get/setSyntaxPrefix methods instead.</span></div>
  403. </div>
  404. </dd>
  405. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultWidth">defaultWidth</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  406. <dd>
  407. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  408. <div class="block"><span class="deprecationComment">Scope will be made private for next major version
  409. - use get/setWidth methods instead.</span></div>
  410. </div>
  411. </dd>
  412. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#desc-java.lang.String-">desc(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  413. <dd>
  414. <div class="block">Sets the description for this option.</div>
  415. </dd>
  416. </dl>
  417. <a name="I:E">
  418. <!-- -->
  419. </a>
  420. <h2 class="title">E</h2>
  421. <dl>
  422. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  423. <dd>&nbsp;</dd>
  424. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#EXISTING_FILE_VALUE">EXISTING_FILE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  425. <dd>
  426. <div class="block">FileInputStream class</div>
  427. </dd>
  428. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#expectedOpts">expectedOpts</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  429. <dd>
  430. <div class="block">The required options and groups expected to be found when parsing the command line.</div>
  431. </dd>
  432. </dl>
  433. <a name="I:F">
  434. <!-- -->
  435. </a>
  436. <h2 class="title">F</h2>
  437. <dl>
  438. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#FILE_VALUE">FILE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  439. <dd>
  440. <div class="block">File class</div>
  441. </dd>
  442. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#FILES_VALUE">FILES_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  443. <dd>
  444. <div class="block">File array class</div>
  445. </dd>
  446. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#findWrapPos-java.lang.String-int-int-">findWrapPos(String, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  447. <dd>
  448. <div class="block">Finds the next text wrap position after <code>startPos</code> for the
  449. text in <code>text</code> with the column width <code>width</code>.</div>
  450. </dd>
  451. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/BasicParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli">BasicParser</a></dt>
  452. <dd>
  453. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  454. <div class="block">A simple implementation of <a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><code>Parser</code></a>'s abstract
  455. <a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-"><code>flatten</code></a> method.</div>
  456. </dd>
  457. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/GnuParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli">GnuParser</a></dt>
  458. <dd>
  459. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  460. <div class="block">This flatten method does so using the following rules:
  461. If an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> exists for the first character of
  462. the <code>arguments</code> entry <b>AND</b> an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a>
  463. does not exist for the whole <code>argument</code> then
  464. add the first character as an option to the processed tokens
  465. list e.g.</div>
  466. </dd>
  467. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  468. <dd>
  469. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  470. <div class="block">Subclasses must implement this method to reduce
  471. the <code>arguments</code> that have been passed to the parse method.</div>
  472. </dd>
  473. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
  474. <dd>
  475. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  476. <div class="block">An implementation of <a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><code>Parser</code></a>'s abstract
  477. <a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-"><code>flatten</code></a> method.</div>
  478. </dd>
  479. </dl>
  480. <a name="I:G">
  481. <!-- -->
  482. </a>
  483. <h2 class="title">G</h2>
  484. <dl>
  485. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getArgList--">getArgList()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  486. <dd>
  487. <div class="block">Retrieve any left-over non-recognized options and arguments</div>
  488. </dd>
  489. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getArgName--">getArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  490. <dd>
  491. <div class="block">Returns the 'argName'.</div>
  492. </dd>
  493. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getArgName--">getArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  494. <dd>
  495. <div class="block">Gets the display name for the argument value.</div>
  496. </dd>
  497. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getArgs--">getArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  498. <dd>
  499. <div class="block">Retrieve any left-over non-recognized options and arguments</div>
  500. </dd>
  501. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getArgs--">getArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  502. <dd>
  503. <div class="block">Returns the number of argument values this Option can take.</div>
  504. </dd>
  505. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getDescPadding--">getDescPadding()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  506. <dd>
  507. <div class="block">Returns the 'descPadding'.</div>
  508. </dd>
  509. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getDescription--">getDescription()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  510. <dd>
  511. <div class="block">Retrieve the self-documenting description of this Option</div>
  512. </dd>
  513. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getId--">getId()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  514. <dd>
  515. <div class="block">Returns the id of this Option.</div>
  516. </dd>
  517. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLeftPadding--">getLeftPadding()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  518. <dd>
  519. <div class="block">Returns the 'leftPadding'.</div>
  520. </dd>
  521. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getLongOpt--">getLongOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  522. <dd>
  523. <div class="block">Retrieve the long name of this Option.</div>
  524. </dd>
  525. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLongOptPrefix--">getLongOptPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  526. <dd>
  527. <div class="block">Returns the 'longOptPrefix'.</div>
  528. </dd>
  529. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLongOptSeparator--">getLongOptSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  530. <dd>
  531. <div class="block">Returns the separator displayed between a long option and its value.</div>
  532. </dd>
  533. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AmbiguousOptionException.html#getMatchingOptions--">getMatchingOptions()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli">AmbiguousOptionException</a></dt>
  534. <dd>
  535. <div class="block">Returns the options matching the partial name.</div>
  536. </dd>
  537. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getMatchingOptions-java.lang.String-">getMatchingOptions(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  538. <dd>
  539. <div class="block">Returns the options with a long name starting with the name specified.</div>
  540. </dd>
  541. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#getMissingOptions--">getMissingOptions()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
  542. <dd>
  543. <div class="block">Returns the list of options or option groups missing in the command line parsed.</div>
  544. </dd>
  545. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getNames--">getNames()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  546. <dd>&nbsp;</dd>
  547. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getNewLine--">getNewLine()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  548. <dd>
  549. <div class="block">Returns the 'newLine'.</div>
  550. </dd>
  551. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getOpt--">getOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  552. <dd>
  553. <div class="block">Retrieve the name of this Option.</div>
  554. </dd>
  555. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
  556. <dd>
  557. <div class="block">Returns the option that was added to the group and triggered the exception.</div>
  558. </dd>
  559. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
  560. <dd>
  561. <div class="block">Return the option requiring an argument that wasn't provided
  562. on the command line.</div>
  563. </dd>
  564. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOption-java.lang.String-">getOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  565. <dd>
  566. <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>
  567. </dd>
  568. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
  569. <dd>
  570. <div class="block">Returns the unrecognized option.</div>
  571. </dd>
  572. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getOptionComparator--">getOptionComparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  573. <dd>
  574. <div class="block">Comparator used to sort the options when they output in help text.</div>
  575. </dd>
  576. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#getOptionGroup--">getOptionGroup()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
  577. <dd>
  578. <div class="block">Returns the option group where another option has been selected.</div>
  579. </dd>
  580. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOptionGroup-org.apache.commons.cli.Option-">getOptionGroup(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  581. <dd>
  582. <div class="block">Returns the OptionGroup the <code>opt</code> belongs to.</div>
  583. </dd>
  584. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionObject-java.lang.String-">getOptionObject(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  585. <dd>
  586. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  587. <div class="block"><span class="deprecationComment">due to System.err message. Instead use getParsedOptionValue(String)</span></div>
  588. </div>
  589. </dd>
  590. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionObject-char-">getOptionObject(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  591. <dd>
  592. <div class="block">Return the <code>Object</code> type of this <code>Option</code>.</div>
  593. </dd>
  594. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionProperties-java.lang.String-">getOptionProperties(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  595. <dd>
  596. <div class="block">Retrieve the map of values associated to the option.</div>
  597. </dd>
  598. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  599. <dd>
  600. <div class="block">Returns an array of the processed <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a>s.</div>
  601. </dd>
  602. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  603. <dd>&nbsp;</dd>
  604. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  605. <dd>
  606. <div class="block">Retrieve a read-only list of options in this set</div>
  607. </dd>
  608. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  609. <dd>
  610. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  611. &nbsp;</dd>
  612. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-java.lang.String-">getOptionValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  613. <dd>
  614. <div class="block">Retrieve the first argument, if any, of this option.</div>
  615. </dd>
  616. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-char-">getOptionValue(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  617. <dd>
  618. <div class="block">Retrieve the first argument, if any, of this option.</div>
  619. </dd>
  620. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-java.lang.String-java.lang.String-">getOptionValue(String, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  621. <dd>
  622. <div class="block">Retrieve the first argument, if any, of an option.</div>
  623. </dd>
  624. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-char-java.lang.String-">getOptionValue(char, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  625. <dd>
  626. <div class="block">Retrieve the argument, if any, of an option.</div>
  627. </dd>
  628. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValues-java.lang.String-">getOptionValues(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  629. <dd>
  630. <div class="block">Retrieves the array of values, if any, of an option.</div>
  631. </dd>
  632. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValues-char-">getOptionValues(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  633. <dd>
  634. <div class="block">Retrieves the array of values, if any, of an option.</div>
  635. </dd>
  636. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getOptPrefix--">getOptPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  637. <dd>
  638. <div class="block">Returns the 'optPrefix'.</div>
  639. </dd>
  640. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getParsedOptionValue-java.lang.String-">getParsedOptionValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  641. <dd>
  642. <div class="block">Return a version of this <code>Option</code> converted to a particular type.</div>
  643. </dd>
  644. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getRequiredOptions--">getRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  645. <dd>
  646. <div class="block">Returns the required options.</div>
  647. </dd>
  648. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#getRequiredOptions--">getRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  649. <dd>
  650. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  651. &nbsp;</dd>
  652. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getSelected--">getSelected()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  653. <dd>&nbsp;</dd>
  654. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getSyntaxPrefix--">getSyntaxPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  655. <dd>
  656. <div class="block">Returns the 'syntaxPrefix'.</div>
  657. </dd>
  658. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getType--">getType()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  659. <dd>
  660. <div class="block">Retrieve the type of this Option.</div>
  661. </dd>
  662. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue--">getValue()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  663. <dd>
  664. <div class="block">Returns the specified value of this Option or
  665. <code>null</code> if there is no value.</div>
  666. </dd>
  667. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue-int-">getValue(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  668. <dd>
  669. <div class="block">Returns the specified value of this Option or
  670. <code>null</code> if there is no value.</div>
  671. </dd>
  672. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue-java.lang.String-">getValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  673. <dd>
  674. <div class="block">Returns the value/first value of this Option or the
  675. <code>defaultValue</code> if there is no value.</div>
  676. </dd>
  677. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#getValueClass-char-">getValueClass(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  678. <dd>
  679. <div class="block">Retrieve the class that <code>ch</code> represents.</div>
  680. </dd>
  681. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValues--">getValues()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  682. <dd>
  683. <div class="block">Return the values of this Option as a String array
  684. or null if there are no values</div>
  685. </dd>
  686. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValueSeparator--">getValueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  687. <dd>
  688. <div class="block">Returns the value separator character.</div>
  689. </dd>
  690. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValuesList--">getValuesList()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  691. <dd>&nbsp;</dd>
  692. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getWidth--">getWidth()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  693. <dd>
  694. <div class="block">Returns the 'width'.</div>
  695. </dd>
  696. <dt><a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">GnuParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  697. <dd>
  698. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  699. <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
  700. </div>
  701. </dd>
  702. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/GnuParser.html#GnuParser--">GnuParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli">GnuParser</a></dt>
  703. <dd>
  704. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  705. &nbsp;</dd>
  706. </dl>
  707. <a name="I:H">
  708. <!-- -->
  709. </a>
  710. <h2 class="title">H</h2>
  711. <dl>
  712. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#handleConcatenatedOptions-java.lang.String-">handleConcatenatedOptions(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  713. <dd>
  714. <div class="block">Breaks <code>token</code> into its constituent parts
  715. using the following algorithm.</div>
  716. </dd>
  717. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArg--">hasArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  718. <dd>
  719. <div class="block">Indicates that the Option will require an argument.</div>
  720. </dd>
  721. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArg-boolean-">hasArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  722. <dd>
  723. <div class="block">Indicates if the Option has an argument or not.</div>
  724. </dd>
  725. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArg--">hasArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  726. <dd>
  727. <div class="block">Query to see if this Option requires an argument</div>
  728. </dd>
  729. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArg--">hasArg()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  730. <dd>
  731. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  732. <div class="block">The next Option created will require an argument value.</div>
  733. </dd>
  734. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArg-boolean-">hasArg(boolean)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  735. <dd>
  736. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  737. <div class="block">The next Option created will require an argument value if
  738. <code>hasArg</code> is true.</div>
  739. </dd>
  740. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArgName--">hasArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  741. <dd>
  742. <div class="block">Returns whether the display name for the argument value has been set.</div>
  743. </dd>
  744. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArgs--">hasArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  745. <dd>
  746. <div class="block">Indicates that the Option can have unlimited argument values.</div>
  747. </dd>
  748. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArgs--">hasArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  749. <dd>
  750. <div class="block">Query to see if this Option can take many values.</div>
  751. </dd>
  752. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArgs--">hasArgs()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  753. <dd>
  754. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  755. <div class="block">The next Option created can have unlimited argument values.</div>
  756. </dd>
  757. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArgs-int-">hasArgs(int)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  758. <dd>
  759. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  760. <div class="block">The next Option created can have <code>num</code> argument values.</div>
  761. </dd>
  762. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hashCode--">hashCode()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  763. <dd>&nbsp;</dd>
  764. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasLongOpt--">hasLongOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  765. <dd>
  766. <div class="block">Query to see if this Option has a long name</div>
  767. </dd>
  768. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasLongOption-java.lang.String-">hasLongOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  769. <dd>
  770. <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>
  771. </dd>
  772. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#hasOption-java.lang.String-">hasOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  773. <dd>
  774. <div class="block">Query to see if an option has been set.</div>
  775. </dd>
  776. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#hasOption-char-">hasOption(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  777. <dd>
  778. <div class="block">Query to see if an option has been set.</div>
  779. </dd>
  780. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasOption-java.lang.String-">hasOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  781. <dd>
  782. <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>
  783. </dd>
  784. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasOptionalArg--">hasOptionalArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  785. <dd>&nbsp;</dd>
  786. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArg--">hasOptionalArg()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  787. <dd>
  788. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  789. <div class="block">The next Option can have an optional argument.</div>
  790. </dd>
  791. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs--">hasOptionalArgs()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  792. <dd>
  793. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  794. <div class="block">The next Option can have an unlimited number of optional arguments.</div>
  795. </dd>
  796. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs-int-">hasOptionalArgs(int)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  797. <dd>
  798. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  799. <div class="block">The next Option can have the specified number of optional arguments.</div>
  800. </dd>
  801. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasShortOption-java.lang.String-">hasShortOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  802. <dd>
  803. <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>
  804. </dd>
  805. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasValueSeparator--">hasValueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  806. <dd>
  807. <div class="block">Return whether this Option has specified a value separator.</div>
  808. </dd>
  809. <dt><a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli"><span class="typeNameLink">HelpFormatter</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  810. <dd>
  811. <div class="block">A formatter of help messages for command line options.</div>
  812. </dd>
  813. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#HelpFormatter--">HelpFormatter()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  814. <dd>&nbsp;</dd>
  815. </dl>
  816. <a name="I:I">
  817. <!-- -->
  818. </a>
  819. <h2 class="title">I</h2>
  820. <dl>
  821. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#isRequired--">isRequired()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  822. <dd>
  823. <div class="block">Query to see if this Option is mandatory</div>
  824. </dd>
  825. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#isRequired--">isRequired()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  826. <dd>
  827. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  828. <div class="block">The next Option created will be required.</div>
  829. </dd>
  830. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#isRequired-boolean-">isRequired(boolean)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  831. <dd>
  832. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  833. <div class="block">The next Option created will be required if <code>required</code>
  834. is true.</div>
  835. </dd>
  836. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#isRequired--">isRequired()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  837. <dd>
  838. <div class="block">Returns whether this option group is required.</div>
  839. </dd>
  840. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#isValueCode-char-">isValueCode(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  841. <dd>
  842. <div class="block">Returns whether <code>ch</code> is a value code, i.e.</div>
  843. </dd>
  844. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#iterator--">iterator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
  845. <dd>
  846. <div class="block">Returns an iterator over the Option members of CommandLine.</div>
  847. </dd>
  848. </dl>
  849. <a name="I:L">
  850. <!-- -->
  851. </a>
  852. <h2 class="title">L</h2>
  853. <dl>
  854. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#longOpt-java.lang.String-">longOpt(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  855. <dd>
  856. <div class="block">Sets the long name of the Option.</div>
  857. </dd>
  858. </dl>
  859. <a name="I:M">
  860. <!-- -->
  861. </a>
  862. <h2 class="title">M</h2>
  863. <dl>
  864. <dt><a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">MissingArgumentException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  865. <dd>
  866. <div class="block">Thrown when an option requiring an argument
  867. is not provided with an argument.</div>
  868. </dd>
  869. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#MissingArgumentException-java.lang.String-">MissingArgumentException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
  870. <dd>
  871. <div class="block">Construct a new <code>MissingArgumentException</code>
  872. with the specified detail message.</div>
  873. </dd>
  874. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#MissingArgumentException-org.apache.commons.cli.Option-">MissingArgumentException(Option)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
  875. <dd>
  876. <div class="block">Construct a new <code>MissingArgumentException</code>
  877. with the specified detail message.</div>
  878. </dd>
  879. <dt><a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">MissingOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  880. <dd>
  881. <div class="block">Thrown when a required option has not been provided.</div>
  882. </dd>
  883. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#MissingOptionException-java.lang.String-">MissingOptionException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
  884. <dd>
  885. <div class="block">Construct a new <code>MissingSelectedException</code>
  886. with the specified detail message.</div>
  887. </dd>
  888. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#MissingOptionException-java.util.List-">MissingOptionException(List)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
  889. <dd>
  890. <div class="block">Constructs a new <code>MissingSelectedException</code> with the
  891. specified list of missing options.</div>
  892. </dd>
  893. </dl>
  894. <a name="I:N">
  895. <!-- -->
  896. </a>
  897. <h2 class="title">N</h2>
  898. <dl>
  899. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#NUMBER_VALUE">NUMBER_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  900. <dd>
  901. <div class="block">Number class</div>
  902. </dd>
  903. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#numberOfArgs-int-">numberOfArgs(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  904. <dd>
  905. <div class="block">Sets the number of argument values the Option can take.</div>
  906. </dd>
  907. </dl>
  908. <a name="I:O">
  909. <!-- -->
  910. </a>
  911. <h2 class="title">O</h2>
  912. <dl>
  913. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#OBJECT_VALUE">OBJECT_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  914. <dd>
  915. <div class="block">Object class</div>
  916. </dd>
  917. <dt><a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Option</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  918. <dd>
  919. <div class="block">Describes a single command-line option.</div>
  920. </dd>
  921. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-">Option(String, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  922. <dd>
  923. <div class="block">Creates an Option using the specified parameters.</div>
  924. </dd>
  925. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-boolean-java.lang.String-">Option(String, boolean, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  926. <dd>
  927. <div class="block">Creates an Option using the specified parameters.</div>
  928. </dd>
  929. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-boolean-java.lang.String-">Option(String, String, boolean, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  930. <dd>
  931. <div class="block">Creates an Option using the specified parameters.</div>
  932. </dd>
  933. <dt><a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Option.Builder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  934. <dd>
  935. <div class="block">A nested builder class to create <code>Option</code> instances
  936. using descriptive methods.</div>
  937. </dd>
  938. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#optionalArg-boolean-">optionalArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  939. <dd>
  940. <div class="block">Sets whether the Option can have an optional argument.</div>
  941. </dd>
  942. <dt><a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">OptionBuilder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  943. <dd>
  944. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  945. <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>
  946. </div>
  947. </dd>
  948. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#optionComparator">optionComparator</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  949. <dd>
  950. <div class="block">Comparator used to sort the options when they output in help text
  951. Defaults to case-insensitive alphabetical sorting by option key</div>
  952. </dd>
  953. <dt><a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">OptionGroup</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  954. <dd>
  955. <div class="block">A group of mutually exclusive options.</div>
  956. </dd>
  957. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#OptionGroup--">OptionGroup()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  958. <dd>&nbsp;</dd>
  959. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#options">options</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  960. <dd>
  961. <div class="block">The current options.</div>
  962. </dd>
  963. <dt><a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Options</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  964. <dd>
  965. <div class="block">Main entry-point into the library.</div>
  966. </dd>
  967. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#Options--">Options()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  968. <dd>&nbsp;</dd>
  969. <dt><a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a> - package org.apache.commons.cli</dt>
  970. <dd>
  971. <div class="block">Commons CLI 1.3</div>
  972. </dd>
  973. </dl>
  974. <a name="I:P">
  975. <!-- -->
  976. </a>
  977. <h2 class="title">P</h2>
  978. <dl>
  979. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLineParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in interface org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli">CommandLineParser</a></dt>
  980. <dd>
  981. <div class="block">Parse the arguments according to the specified options.</div>
  982. </dd>
  983. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLineParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in interface org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli">CommandLineParser</a></dt>
  984. <dd>
  985. <div class="block">Parse the arguments according to the specified options.</div>
  986. </dd>
  987. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  988. <dd>&nbsp;</dd>
  989. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-">parse(Options, String[], Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  990. <dd>
  991. <div class="block">Parse the arguments according to the specified options and properties.</div>
  992. </dd>
  993. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  994. <dd>&nbsp;</dd>
  995. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-boolean-">parse(Options, String[], Properties, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  996. <dd>
  997. <div class="block">Parse the arguments according to the specified options and properties.</div>
  998. </dd>
  999. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1000. <dd>
  1001. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1002. <div class="block">Parses the specified <code>arguments</code> based
  1003. on the specified <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
  1004. </dd>
  1005. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-">parse(Options, String[], Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1006. <dd>
  1007. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1008. <div class="block">Parse the arguments according to the specified options and properties.</div>
  1009. </dd>
  1010. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1011. <dd>
  1012. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1013. <div class="block">Parses the specified <code>arguments</code>
  1014. based on the specified <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
  1015. </dd>
  1016. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-boolean-">parse(Options, String[], Properties, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1017. <dd>
  1018. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1019. <div class="block">Parse the arguments according to the specified options and
  1020. properties.</div>
  1021. </dd>
  1022. <dt><a href="org/apache/commons/cli/ParseException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">ParseException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1023. <dd>
  1024. <div class="block">Base for Exceptions thrown during parsing of a command-line.</div>
  1025. </dd>
  1026. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/ParseException.html#ParseException-java.lang.String-">ParseException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/ParseException.html" title="class in org.apache.commons.cli">ParseException</a></dt>
  1027. <dd>
  1028. <div class="block">Construct a new <code>ParseException</code>
  1029. with the specified detail message.</div>
  1030. </dd>
  1031. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#parsePattern-java.lang.String-">parsePattern(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  1032. <dd>
  1033. <div class="block">Returns the <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> instance represented by <code>pattern</code>.</div>
  1034. </dd>
  1035. <dt><a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Parser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1036. <dd>
  1037. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  1038. <div class="block"><span class="deprecationComment">since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases</span></div>
  1039. </div>
  1040. </dd>
  1041. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#Parser--">Parser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1042. <dd>
  1043. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1044. &nbsp;</dd>
  1045. <dt><a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">PatternOptionBuilder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1046. <dd>
  1047. <div class="block">Allows Options to be created from a single String.</div>
  1048. </dd>
  1049. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#PatternOptionBuilder--">PatternOptionBuilder()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  1050. <dd>&nbsp;</dd>
  1051. <dt><a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">PosixParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1052. <dd>
  1053. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  1054. <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
  1055. </div>
  1056. </dd>
  1057. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#PosixParser--">PosixParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
  1058. <dd>
  1059. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1060. &nbsp;</dd>
  1061. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-">printHelp(String, Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1062. <dd>
  1063. <div class="block">Print the help for <code>options</code> with the specified
  1064. command line syntax.</div>
  1065. </dd>
  1066. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-boolean-">printHelp(String, Options, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1067. <dd>
  1068. <div class="block">Print the help for <code>options</code> with the specified
  1069. command line syntax.</div>
  1070. </dd>
  1071. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">printHelp(String, String, Options, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1072. <dd>
  1073. <div class="block">Print the help for <code>options</code> with the specified
  1074. command line syntax.</div>
  1075. </dd>
  1076. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">printHelp(String, String, Options, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1077. <dd>
  1078. <div class="block">Print the help for <code>options</code> with the specified
  1079. command line syntax.</div>
  1080. </dd>
  1081. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">printHelp(int, String, String, Options, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1082. <dd>
  1083. <div class="block">Print the help for <code>options</code> with the specified
  1084. command line syntax.</div>
  1085. </dd>
  1086. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">printHelp(int, String, String, Options, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1087. <dd>
  1088. <div class="block">Print the help for <code>options</code> with the specified
  1089. command line syntax.</div>
  1090. </dd>
  1091. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-">printHelp(PrintWriter, int, String, String, Options, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1092. <dd>
  1093. <div class="block">Print the help for <code>options</code> with the specified
  1094. command line syntax.</div>
  1095. </dd>
  1096. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-boolean-">printHelp(PrintWriter, int, String, String, Options, int, int, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1097. <dd>
  1098. <div class="block">Print the help for <code>options</code> with the specified
  1099. command line syntax.</div>
  1100. </dd>
  1101. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printOptions-java.io.PrintWriter-int-org.apache.commons.cli.Options-int-int-">printOptions(PrintWriter, int, Options, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1102. <dd>
  1103. <div class="block">Print the help for the specified Options to the specified writer,
  1104. using the specified width, left padding and description padding.</div>
  1105. </dd>
  1106. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printUsage-java.io.PrintWriter-int-java.lang.String-org.apache.commons.cli.Options-">printUsage(PrintWriter, int, String, Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1107. <dd>
  1108. <div class="block">Prints the usage statement for the specified application.</div>
  1109. </dd>
  1110. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printUsage-java.io.PrintWriter-int-java.lang.String-">printUsage(PrintWriter, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1111. <dd>
  1112. <div class="block">Print the cmdLineSyntax to the specified writer, using the
  1113. specified width.</div>
  1114. </dd>
  1115. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-java.lang.String-">printWrapped(PrintWriter, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1116. <dd>
  1117. <div class="block">Print the specified text to the specified PrintWriter.</div>
  1118. </dd>
  1119. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-int-java.lang.String-">printWrapped(PrintWriter, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1120. <dd>
  1121. <div class="block">Print the specified text to the specified PrintWriter.</div>
  1122. </dd>
  1123. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processArgs-org.apache.commons.cli.Option-java.util.ListIterator-">processArgs(Option, ListIterator&lt;String&gt;)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1124. <dd>
  1125. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1126. <div class="block">Process the argument values for the specified Option
  1127. <code>opt</code> using the values retrieved from the
  1128. specified iterator <code>iter</code>.</div>
  1129. </dd>
  1130. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processOption-java.lang.String-java.util.ListIterator-">processOption(String, ListIterator&lt;String&gt;)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1131. <dd>
  1132. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1133. <div class="block">Process the Option specified by <code>arg</code> using the values
  1134. retrieved from the specified iterator <code>iter</code>.</div>
  1135. </dd>
  1136. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processProperties-java.util.Properties-">processProperties(Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1137. <dd>
  1138. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1139. <div class="block">Sets the values of Options using the values in <code>properties</code>.</div>
  1140. </dd>
  1141. </dl>
  1142. <a name="I:R">
  1143. <!-- -->
  1144. </a>
  1145. <h2 class="title">R</h2>
  1146. <dl>
  1147. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#renderOptions-java.lang.StringBuffer-int-org.apache.commons.cli.Options-int-int-">renderOptions(StringBuffer, int, Options, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1148. <dd>
  1149. <div class="block">Render the specified Options and return the rendered Options
  1150. in a StringBuffer.</div>
  1151. </dd>
  1152. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#renderWrappedText-java.lang.StringBuffer-int-int-java.lang.String-">renderWrappedText(StringBuffer, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1153. <dd>
  1154. <div class="block">Render the specified text and return the rendered Options
  1155. in a StringBuffer.</div>
  1156. </dd>
  1157. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#required--">required()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  1158. <dd>
  1159. <div class="block">Marks this Option as required.</div>
  1160. </dd>
  1161. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#required-boolean-">required(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  1162. <dd>
  1163. <div class="block">Sets whether the Option is mandatory.</div>
  1164. </dd>
  1165. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#rtrim-java.lang.String-">rtrim(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1166. <dd>
  1167. <div class="block">Remove the trailing whitespace from the specified String.</div>
  1168. </dd>
  1169. </dl>
  1170. <a name="I:S">
  1171. <!-- -->
  1172. </a>
  1173. <h2 class="title">S</h2>
  1174. <dl>
  1175. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setArgName-java.lang.String-">setArgName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1176. <dd>
  1177. <div class="block">Sets the 'argName'.</div>
  1178. </dd>
  1179. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setArgName-java.lang.String-">setArgName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1180. <dd>
  1181. <div class="block">Sets the display name for the argument value.</div>
  1182. </dd>
  1183. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setArgs-int-">setArgs(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1184. <dd>
  1185. <div class="block">Sets the number of argument values this Option can take.</div>
  1186. </dd>
  1187. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setDescPadding-int-">setDescPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1188. <dd>
  1189. <div class="block">Sets the 'descPadding'.</div>
  1190. </dd>
  1191. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setDescription-java.lang.String-">setDescription(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1192. <dd>
  1193. <div class="block">Sets the self-documenting description of this Option</div>
  1194. </dd>
  1195. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLeftPadding-int-">setLeftPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1196. <dd>
  1197. <div class="block">Sets the 'leftPadding'.</div>
  1198. </dd>
  1199. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setLongOpt-java.lang.String-">setLongOpt(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1200. <dd>
  1201. <div class="block">Sets the long name of this Option.</div>
  1202. </dd>
  1203. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLongOptPrefix-java.lang.String-">setLongOptPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1204. <dd>
  1205. <div class="block">Sets the 'longOptPrefix'.</div>
  1206. </dd>
  1207. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLongOptSeparator-java.lang.String-">setLongOptSeparator(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1208. <dd>
  1209. <div class="block">Set the separator displayed between a long option and its value.</div>
  1210. </dd>
  1211. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setNewLine-java.lang.String-">setNewLine(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1212. <dd>
  1213. <div class="block">Sets the 'newLine'.</div>
  1214. </dd>
  1215. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setOptionalArg-boolean-">setOptionalArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1216. <dd>
  1217. <div class="block">Sets whether this Option can have an optional argument.</div>
  1218. </dd>
  1219. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setOptionComparator-java.util.Comparator-">setOptionComparator(Comparator&lt;Option&gt;)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1220. <dd>
  1221. <div class="block">Set the comparator used to sort the options when they output in help text.</div>
  1222. </dd>
  1223. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#setOptions-org.apache.commons.cli.Options-">setOptions(Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
  1224. <dd>
  1225. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1226. &nbsp;</dd>
  1227. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setOptPrefix-java.lang.String-">setOptPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1228. <dd>
  1229. <div class="block">Sets the 'optPrefix'.</div>
  1230. </dd>
  1231. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setRequired-boolean-">setRequired(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1232. <dd>
  1233. <div class="block">Sets whether this Option is mandatory.</div>
  1234. </dd>
  1235. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#setRequired-boolean-">setRequired(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  1236. <dd>&nbsp;</dd>
  1237. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#setSelected-org.apache.commons.cli.Option-">setSelected(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  1238. <dd>
  1239. <div class="block">Set the selected option of this group to <code>name</code>.</div>
  1240. </dd>
  1241. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setSyntaxPrefix-java.lang.String-">setSyntaxPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1242. <dd>
  1243. <div class="block">Sets the 'syntaxPrefix'.</div>
  1244. </dd>
  1245. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setType-java.lang.Object-">setType(Object)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1246. <dd>
  1247. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  1248. <div class="block"><span class="deprecationComment">since 1.3, use <a href="org/apache/commons/cli/Option.html#setType-java.lang.Class-"><code>Option.setType(Class)</code></a> instead</span></div>
  1249. </div>
  1250. </dd>
  1251. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setType-java.lang.Class-">setType(Class&lt;?&gt;)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1252. <dd>
  1253. <div class="block">Sets the type of this Option.</div>
  1254. </dd>
  1255. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setValueSeparator-char-">setValueSeparator(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1256. <dd>
  1257. <div class="block">Sets the value separator.</div>
  1258. </dd>
  1259. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setWidth-int-">setWidth(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
  1260. <dd>
  1261. <div class="block">Sets the 'width'.</div>
  1262. </dd>
  1263. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#skipParsing">skipParsing</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  1264. <dd>
  1265. <div class="block">Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line.</div>
  1266. </dd>
  1267. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#stopAtNonOption">stopAtNonOption</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
  1268. <dd>
  1269. <div class="block">Flag indicating how unrecognized tokens are handled.</div>
  1270. </dd>
  1271. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#STRING_VALUE">STRING_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  1272. <dd>
  1273. <div class="block">String class</div>
  1274. </dd>
  1275. </dl>
  1276. <a name="I:T">
  1277. <!-- -->
  1278. </a>
  1279. <h2 class="title">T</h2>
  1280. <dl>
  1281. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1282. <dd>
  1283. <div class="block">Dump state, suitable for debugging.</div>
  1284. </dd>
  1285. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
  1286. <dd>
  1287. <div class="block">Returns the stringified version of this OptionGroup.</div>
  1288. </dd>
  1289. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
  1290. <dd>
  1291. <div class="block">Dump state, suitable for debugging.</div>
  1292. </dd>
  1293. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#type-java.lang.Class-">type(Class&lt;?&gt;)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  1294. <dd>
  1295. <div class="block">Sets the type of the Option.</div>
  1296. </dd>
  1297. <dt><a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli"><span class="typeNameLink">TypeHandler</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1298. <dd>
  1299. <div class="block">This is a temporary implementation.</div>
  1300. </dd>
  1301. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#TypeHandler--">TypeHandler()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
  1302. <dd>&nbsp;</dd>
  1303. </dl>
  1304. <a name="I:U">
  1305. <!-- -->
  1306. </a>
  1307. <h2 class="title">U</h2>
  1308. <dl>
  1309. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#UNINITIALIZED">UNINITIALIZED</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1310. <dd>
  1311. <div class="block">constant that specifies the number of argument values has not been specified</div>
  1312. </dd>
  1313. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#UNLIMITED_VALUES">UNLIMITED_VALUES</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
  1314. <dd>
  1315. <div class="block">constant that specifies the number of argument values is infinite</div>
  1316. </dd>
  1317. <dt><a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">UnrecognizedOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
  1318. <dd>
  1319. <div class="block">Exception thrown during parsing signalling an unrecognized
  1320. option was seen.</div>
  1321. </dd>
  1322. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#UnrecognizedOptionException-java.lang.String-">UnrecognizedOptionException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
  1323. <dd>
  1324. <div class="block">Construct a new <code>UnrecognizedArgumentException</code>
  1325. with the specified detail message.</div>
  1326. </dd>
  1327. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#UnrecognizedOptionException-java.lang.String-java.lang.String-">UnrecognizedOptionException(String, String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
  1328. <dd>
  1329. <div class="block">Construct a new <code>UnrecognizedArgumentException</code>
  1330. with the specified option and detail message.</div>
  1331. </dd>
  1332. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#URL_VALUE">URL_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
  1333. <dd>
  1334. <div class="block">URL class</div>
  1335. </dd>
  1336. </dl>
  1337. <a name="I:V">
  1338. <!-- -->
  1339. </a>
  1340. <h2 class="title">V</h2>
  1341. <dl>
  1342. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#valueSeparator--">valueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  1343. <dd>
  1344. <div class="block">The Option will use '=' as a means to separate argument value.</div>
  1345. </dd>
  1346. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#valueSeparator-char-">valueSeparator(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
  1347. <dd>
  1348. <div class="block">The Option will use <code>sep</code> as a means to
  1349. separate argument values.</div>
  1350. </dd>
  1351. </dl>
  1352. <a name="I:W">
  1353. <!-- -->
  1354. </a>
  1355. <h2 class="title">W</h2>
  1356. <dl>
  1357. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withArgName-java.lang.String-">withArgName(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1358. <dd>
  1359. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1360. <div class="block">The next Option created will have the specified argument value name.</div>
  1361. </dd>
  1362. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withDescription-java.lang.String-">withDescription(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1363. <dd>
  1364. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1365. <div class="block">The next Option created will have the specified description</div>
  1366. </dd>
  1367. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withLongOpt-java.lang.String-">withLongOpt(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1368. <dd>
  1369. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1370. <div class="block">The next Option created will have the following long option value.</div>
  1371. </dd>
  1372. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Object-">withType(Object)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1373. <dd>
  1374. <div class="block"><span class="deprecatedLabel">Deprecated.</span>
  1375. <div class="block"><span class="deprecationComment">since 1.3, use <a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-"><code>OptionBuilder.withType(Class)</code></a> instead</span></div>
  1376. </div>
  1377. </dd>
  1378. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-">withType(Class&lt;?&gt;)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1379. <dd>
  1380. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1381. <div class="block">The next Option created will have a value that will be an instance
  1382. of <code>type</code>.</div>
  1383. </dd>
  1384. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withValueSeparator-char-">withValueSeparator(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1385. <dd>
  1386. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1387. <div class="block">The next Option created uses <code>sep</code> as a means to
  1388. separate argument values.</div>
  1389. </dd>
  1390. <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withValueSeparator--">withValueSeparator()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
  1391. <dd>
  1392. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  1393. <div class="block">The next Option created uses '<code>=</code>' as a means to
  1394. separate argument values.</div>
  1395. </dd>
  1396. </dl>
  1397. <a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:W">W</a>&nbsp;</div>
  1398. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  1399. <div class="bottomNav"><a name="navbar.bottom">
  1400. <!-- -->
  1401. </a>
  1402. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  1403. <a name="navbar.bottom.firstrow">
  1404. <!-- -->
  1405. </a>
  1406. <ul class="navList" title="Navigation">
  1407. <li><a href="org/apache/commons/cli/package-summary.html">Package</a></li>
  1408. <li>Class</li>
  1409. <li>Use</li>
  1410. <li><a href="org/apache/commons/cli/package-tree.html">Tree</a></li>
  1411. <li><a href="deprecated-list.html">Deprecated</a></li>
  1412. <li class="navBarCell1Rev">Index</li>
  1413. <li><a href="help-doc.html">Help</a></li>
  1414. </ul>
  1415. </div>
  1416. <div class="subNav">
  1417. <ul class="navList">
  1418. <li>Prev</li>
  1419. <li>Next</li>
  1420. </ul>
  1421. <ul class="navList">
  1422. <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
  1423. <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
  1424. </ul>
  1425. <ul class="navList" id="allclasses_navbar_bottom">
  1426. <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
  1427. </ul>
  1428. <div>
  1429. <script type="text/javascript"><!--
  1430. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  1431. if(window==top) {
  1432. allClassesLink.style.display = "block";
  1433. }
  1434. else {
  1435. allClassesLink.style.display = "none";
  1436. }
  1437. //-->
  1438. </script>
  1439. </div>
  1440. <a name="skip.navbar.bottom">
  1441. <!-- -->
  1442. </a></div>
  1443. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  1444. <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>
  1445. </body>
  1446. </html>