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

1686 lines
89 KiB
Raw Blame History 

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

  2. <!-- NewPage -->

  3. <html lang="de">

  4. <head>

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

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

  7. <title>HelpFormatter (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="HelpFormatter (Apache Commons CLI 1.4 API)";

  16.         }

  17.     }

  18.     catch(err) {

  19.     }

  20. //-->

  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10};

  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};

  23. var altColor = "altColor";

  24. var rowColor = "rowColor";

  25. var tableTab = "tableTab";

  26. var activeTableTab = "activeTableTab";

  27. </script>

  28. <noscript>

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

  30. </noscript>

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

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

  33. <!--   -->

  34. </a>

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

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

  37. <!--   -->

  38. </a>

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

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

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

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

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

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

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

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

  47. </ul>

  48. </div>

  49. <div class="subNav">

  50. <ul class="navList">

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

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

  53. </ul>

  54. <ul class="navList">

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

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

  57. </ul>

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

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

  60. </ul>

  61. <div>

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

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

  64.   if(window==top) {

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

  66.   }

  67.   else {

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

  69.   }

  70.   //-->

  71. </script>

  72. </div>

  73. <div>

  74. <ul class="subNavList">

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

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

  77. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>

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

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

  80. </ul>

  81. <ul class="subNavList">

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

  83. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>

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

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

  86. </ul>

  87. </div>

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

  89. <!--   -->

  90. </a></div>

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

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

  93. <div class="header">

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

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

  96. </div>

  97. <div class="contentContainer">

  98. <ul class="inheritance">

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

  100. <li>

  101. <ul class="inheritance">

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

  103. </ul>

  104. </li>

  105. </ul>

  106. <div class="description">

  107. <ul class="blockList">

  108. <li class="blockList">

  109. <hr>

  110. <br>

  111. <pre>public class <span class="typeNameLabel">HelpFormatter</span>

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

  113. <div class="block">A formatter of help messages for command line options.

  114. 

  115.  <p>Example:</p>

  116.  

  117.  <pre>

  118.  Options options = new Options();

  119.  options.addOption(OptionBuilder.withLongOpt("file")

  120.                                 .withDescription("The file to be processed")

  121.                                 .hasArg()

  122.                                 .withArgName("FILE")

  123.                                 .isRequired()

  124.                                 .create('f'));

  125.  options.addOption(OptionBuilder.withLongOpt("version")

  126.                                 .withDescription("Print the version of the application")

  127.                                 .create('v'));

  128.  options.addOption(OptionBuilder.withLongOpt("help").create('h'));

  129.  

  130.  String header = "Do something useful with an input file\n\n";

  131.  String footer = "\nPlease report issues at http://example.com/issues";

  132.  

  133.  HelpFormatter formatter = new HelpFormatter();

  134.  formatter.printHelp("myapp", header, options, footer, true);

  135.  </pre>

  136.  

  137.  This produces the following output:

  138.  

  139.  <pre>

  140.  usage: myapp -f &lt;FILE&gt; [-h] [-v]

  141.  Do something useful with an input file

  142.  

  143.   -f,--file &lt;FILE&gt;   The file to be processed

  144.   -h,--help

  145.   -v,--version       Print the version of the application

  146.  

  147.  Please report issues at http://example.com/issues

  148.  </pre></div>

  149. <dl>

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

  151. <dd>$Id: HelpFormatter.java 1677407 2015-05-03 14:31:12Z britter $</dd>

  152. </dl>

  153. </li>

  154. </ul>

  155. </div>

  156. <div class="summary">

  157. <ul class="blockList">

  158. <li class="blockList">

  159. <!-- =========== FIELD SUMMARY =========== -->

  160. <ul class="blockList">

  161. <li class="blockList"><a name="field.summary">

  162. <!--   -->

  163. </a>

  164. <h3>Field Summary</h3>

  165. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">

  166. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>

  167. <tr>

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

  169. <th class="colLast" scope="col">Field and Description</th>

  170. </tr>

  171. <tr class="altColor">

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

  173. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_ARG_NAME">DEFAULT_ARG_NAME</a></span></code>

  174. <div class="block">default name for an argument</div>

  175. </td>

  176. </tr>

  177. <tr class="rowColor">

  178. <td class="colFirst"><code>static int</code></td>

  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_DESC_PAD">DEFAULT_DESC_PAD</a></span></code>

  180. <div class="block">number of space characters to be prefixed to each description line</div>

  181. </td>

  182. </tr>

  183. <tr class="altColor">

  184. <td class="colFirst"><code>static int</code></td>

  185. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_LEFT_PAD">DEFAULT_LEFT_PAD</a></span></code>

  186. <div class="block">default padding to the left of each line</div>

  187. </td>

  188. </tr>

  189. <tr class="rowColor">

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

  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_PREFIX">DEFAULT_LONG_OPT_PREFIX</a></span></code>

  192. <div class="block">default prefix for long Option</div>

  193. </td>

  194. </tr>

  195. <tr class="altColor">

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

  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_SEPARATOR">DEFAULT_LONG_OPT_SEPARATOR</a></span></code>

  198. <div class="block">default separator displayed between a long Option and its value</div>

  199. </td>

  200. </tr>

  201. <tr class="rowColor">

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

  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_OPT_PREFIX">DEFAULT_OPT_PREFIX</a></span></code>

  204. <div class="block">default prefix for shortOpts</div>

  205. </td>

  206. </tr>

  207. <tr class="altColor">

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

  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_SYNTAX_PREFIX">DEFAULT_SYNTAX_PREFIX</a></span></code>

  210. <div class="block">the string to display at the beginning of the usage statement</div>

  211. </td>

  212. </tr>

  213. <tr class="rowColor">

  214. <td class="colFirst"><code>static int</code></td>

  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#DEFAULT_WIDTH">DEFAULT_WIDTH</a></span></code>

  216. <div class="block">default number of characters per line</div>

  217. </td>

  218. </tr>

  219. <tr class="altColor">

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

  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultArgName">defaultArgName</a></span></code>

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

  223. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  224.  - use get/setArgName methods instead.</span></div>

  225. </div>

  226. </td>

  227. </tr>

  228. <tr class="rowColor">

  229. <td class="colFirst"><code>int</code></td>

  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultDescPad">defaultDescPad</a></span></code>

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

  232. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  233.  - use get/setDescPadding methods instead.</span></div>

  234. </div>

  235. </td>

  236. </tr>

  237. <tr class="altColor">

  238. <td class="colFirst"><code>int</code></td>

  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultLeftPad">defaultLeftPad</a></span></code>

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

  241. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  242.  - use get/setLeftPadding methods instead.</span></div>

  243. </div>

  244. </td>

  245. </tr>

  246. <tr class="rowColor">

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

  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultLongOptPrefix">defaultLongOptPrefix</a></span></code>

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

  250. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  251.  - use get/setLongOptPrefix methods instead.</span></div>

  252. </div>

  253. </td>

  254. </tr>

  255. <tr class="altColor">

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

  257. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultNewLine">defaultNewLine</a></span></code>

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

  259. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  260.  - use get/setNewLine methods instead.</span></div>

  261. </div>

  262. </td>

  263. </tr>

  264. <tr class="rowColor">

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

  266. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultOptPrefix">defaultOptPrefix</a></span></code>

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

  268. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  269.  - use get/setOptPrefix methods instead.</span></div>

  270. </div>

  271. </td>

  272. </tr>

  273. <tr class="altColor">

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

  275. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultSyntaxPrefix">defaultSyntaxPrefix</a></span></code>

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

  277. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  278.  - use get/setSyntaxPrefix methods instead.</span></div>

  279. </div>

  280. </td>

  281. </tr>

  282. <tr class="rowColor">

  283. <td class="colFirst"><code>int</code></td>

  284. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#defaultWidth">defaultWidth</a></span></code>

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

  286. <div class="block"><span class="deprecationComment">Scope will be made private for next major version

  287.  - use get/setWidth methods instead.</span></div>

  288. </div>

  289. </td>

  290. </tr>

  291. <tr class="altColor">

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

  293. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#optionComparator">optionComparator</a></span></code>

  294. <div class="block">Comparator used to sort the options when they output in help text

  295.  

  296.  Defaults to case-insensitive alphabetical sorting by option key</div>

  297. </td>

  298. </tr>

  299. </table>

  300. </li>

  301. </ul>

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

  303. <ul class="blockList">

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

  305. <!--   -->

  306. </a>

  307. <h3>Constructor Summary</h3>

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

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

  310. <tr>

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

  312. </tr>

  313. <tr class="altColor">

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

  315. </tr>

  316. </table>

  317. </li>

  318. </ul>

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

  320. <ul class="blockList">

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

  322. <!--   -->

  323. </a>

  324. <h3>Method Summary</h3>

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

  326. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>

  327. <tr>

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

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

  330. </tr>

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

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

  333. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#createPadding-int-">createPadding</a></span>(int&nbsp;len)</code>

  334. <div class="block">Return a String of padding of length <code>len</code>.</div>

  335. </td>

  336. </tr>

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

  338. <td class="colFirst"><code>protected int</code></td>

  339. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#findWrapPos-java.lang.String-int-int-">findWrapPos</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text,

  340.            int&nbsp;width,

  341.            int&nbsp;startPos)</code>

  342. <div class="block">Finds the next text wrap position after <code>startPos</code> for the

  343.  text in <code>text</code> with the column width <code>width</code>.</div>

  344. </td>

  345. </tr>

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

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

  348. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getArgName--">getArgName</a></span>()</code>

  349. <div class="block">Returns the 'argName'.</div>

  350. </td>

  351. </tr>

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

  353. <td class="colFirst"><code>int</code></td>

  354. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getDescPadding--">getDescPadding</a></span>()</code>

  355. <div class="block">Returns the 'descPadding'.</div>

  356. </td>

  357. </tr>

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

  359. <td class="colFirst"><code>int</code></td>

  360. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getLeftPadding--">getLeftPadding</a></span>()</code>

  361. <div class="block">Returns the 'leftPadding'.</div>

  362. </td>

  363. </tr>

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

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

  366. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getLongOptPrefix--">getLongOptPrefix</a></span>()</code>

  367. <div class="block">Returns the 'longOptPrefix'.</div>

  368. </td>

  369. </tr>

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

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

  372. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getLongOptSeparator--">getLongOptSeparator</a></span>()</code>

  373. <div class="block">Returns the separator displayed between a long option and its value.</div>

  374. </td>

  375. </tr>

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

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

  378. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getNewLine--">getNewLine</a></span>()</code>

  379. <div class="block">Returns the 'newLine'.</div>

  380. </td>

  381. </tr>

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

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

  384. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getOptionComparator--">getOptionComparator</a></span>()</code>

  385. <div class="block">Comparator used to sort the options when they output in help text.</div>

  386. </td>

  387. </tr>

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

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

  390. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getOptPrefix--">getOptPrefix</a></span>()</code>

  391. <div class="block">Returns the 'optPrefix'.</div>

  392. </td>

  393. </tr>

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

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

  396. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getSyntaxPrefix--">getSyntaxPrefix</a></span>()</code>

  397. <div class="block">Returns the 'syntaxPrefix'.</div>

  398. </td>

  399. </tr>

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

  401. <td class="colFirst"><code>int</code></td>

  402. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#getWidth--">getWidth</a></span>()</code>

  403. <div class="block">Returns the 'width'.</div>

  404. </td>

  405. </tr>

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

  407. <td class="colFirst"><code>void</code></td>

  408. <td class="colLast"><code><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</a></span>(int&nbsp;width,

  409.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  410.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  411.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  412.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</code>

  413. <div class="block">Print the help for <code>options</code> with the specified

  414.  command line syntax.</div>

  415. </td>

  416. </tr>

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

  418. <td class="colFirst"><code>void</code></td>

  419. <td class="colLast"><code><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</a></span>(int&nbsp;width,

  420.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  421.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  422.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  423.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  424.          boolean&nbsp;autoUsage)</code>

  425. <div class="block">Print the help for <code>options</code> with the specified

  426.  command line syntax.</div>

  427. </td>

  428. </tr>

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

  430. <td class="colFirst"><code>void</code></td>

  431. <td class="colLast"><code><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</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  432.          int&nbsp;width,

  433.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  434.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  435.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  436.          int&nbsp;leftPad,

  437.          int&nbsp;descPad,

  438.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</code>

  439. <div class="block">Print the help for <code>options</code> with the specified

  440.  command line syntax.</div>

  441. </td>

  442. </tr>

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

  444. <td class="colFirst"><code>void</code></td>

  445. <td class="colLast"><code><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</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  446.          int&nbsp;width,

  447.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  448.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  449.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  450.          int&nbsp;leftPad,

  451.          int&nbsp;descPad,

  452.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  453.          boolean&nbsp;autoUsage)</code>

  454. <div class="block">Print the help for <code>options</code> with the specified

  455.  command line syntax.</div>

  456. </td>

  457. </tr>

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

  459. <td class="colFirst"><code>void</code></td>

  460. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-">printHelp</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  461.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options)</code>

  462. <div class="block">Print the help for <code>options</code> with the specified

  463.  command line syntax.</div>

  464. </td>

  465. </tr>

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

  467. <td class="colFirst"><code>void</code></td>

  468. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-boolean-">printHelp</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  469.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  470.          boolean&nbsp;autoUsage)</code>

  471. <div class="block">Print the help for <code>options</code> with the specified

  472.  command line syntax.</div>

  473. </td>

  474. </tr>

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

  476. <td class="colFirst"><code>void</code></td>

  477. <td class="colLast"><code><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</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  478.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  479.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  480.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</code>

  481. <div class="block">Print the help for <code>options</code> with the specified

  482.  command line syntax.</div>

  483. </td>

  484. </tr>

  485. <tr id="i19" class="rowColor">

  486. <td class="colFirst"><code>void</code></td>

  487. <td class="colLast"><code><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</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  488.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  489.          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  490.          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  491.          boolean&nbsp;autoUsage)</code>

  492. <div class="block">Print the help for <code>options</code> with the specified

  493.  command line syntax.</div>

  494. </td>

  495. </tr>

  496. <tr id="i20" class="altColor">

  497. <td class="colFirst"><code>void</code></td>

  498. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printOptions-java.io.PrintWriter-int-org.apache.commons.cli.Options-int-int-">printOptions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  499.             int&nbsp;width,

  500.             <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  501.             int&nbsp;leftPad,

  502.             int&nbsp;descPad)</code>

  503. <div class="block">Print the help for the specified Options to the specified writer, 

  504.  using the specified width, left padding and description padding.</div>

  505. </td>

  506. </tr>

  507. <tr id="i21" class="rowColor">

  508. <td class="colFirst"><code>void</code></td>

  509. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printUsage-java.io.PrintWriter-int-java.lang.String-">printUsage</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  510.           int&nbsp;width,

  511.           <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax)</code>

  512. <div class="block">Print the cmdLineSyntax to the specified writer, using the

  513.  specified width.</div>

  514. </td>

  515. </tr>

  516. <tr id="i22" class="altColor">

  517. <td class="colFirst"><code>void</code></td>

  518. <td class="colLast"><code><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</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  519.           int&nbsp;width,

  520.           <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;app,

  521.           <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options)</code>

  522. <div class="block">Prints the usage statement for the specified application.</div>

  523. </td>

  524. </tr>

  525. <tr id="i23" class="rowColor">

  526. <td class="colFirst"><code>void</code></td>

  527. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-int-java.lang.String-">printWrapped</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  528.             int&nbsp;width,

  529.             int&nbsp;nextLineTabStop,

  530.             <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</code>

  531. <div class="block">Print the specified text to the specified PrintWriter.</div>

  532. </td>

  533. </tr>

  534. <tr id="i24" class="altColor">

  535. <td class="colFirst"><code>void</code></td>

  536. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-java.lang.String-">printWrapped</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  537.             int&nbsp;width,

  538.             <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</code>

  539. <div class="block">Print the specified text to the specified PrintWriter.</div>

  540. </td>

  541. </tr>

  542. <tr id="i25" class="rowColor">

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

  544. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#renderOptions-java.lang.StringBuffer-int-org.apache.commons.cli.Options-int-int-">renderOptions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;sb,

  545.              int&nbsp;width,

  546.              <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  547.              int&nbsp;leftPad,

  548.              int&nbsp;descPad)</code>

  549. <div class="block">Render the specified Options and return the rendered Options

  550.  in a StringBuffer.</div>

  551. </td>

  552. </tr>

  553. <tr id="i26" class="altColor">

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

  555. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#renderWrappedText-java.lang.StringBuffer-int-int-java.lang.String-">renderWrappedText</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;sb,

  556.                  int&nbsp;width,

  557.                  int&nbsp;nextLineTabStop,

  558.                  <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</code>

  559. <div class="block">Render the specified text and return the rendered Options

  560.  in a StringBuffer.</div>

  561. </td>

  562. </tr>

  563. <tr id="i27" class="rowColor">

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

  565. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#rtrim-java.lang.String-">rtrim</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;s)</code>

  566. <div class="block">Remove the trailing whitespace from the specified String.</div>

  567. </td>

  568. </tr>

  569. <tr id="i28" class="altColor">

  570. <td class="colFirst"><code>void</code></td>

  571. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setArgName-java.lang.String-">setArgName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>

  572. <div class="block">Sets the 'argName'.</div>

  573. </td>

  574. </tr>

  575. <tr id="i29" class="rowColor">

  576. <td class="colFirst"><code>void</code></td>

  577. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setDescPadding-int-">setDescPadding</a></span>(int&nbsp;padding)</code>

  578. <div class="block">Sets the 'descPadding'.</div>

  579. </td>

  580. </tr>

  581. <tr id="i30" class="altColor">

  582. <td class="colFirst"><code>void</code></td>

  583. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setLeftPadding-int-">setLeftPadding</a></span>(int&nbsp;padding)</code>

  584. <div class="block">Sets the 'leftPadding'.</div>

  585. </td>

  586. </tr>

  587. <tr id="i31" class="rowColor">

  588. <td class="colFirst"><code>void</code></td>

  589. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setLongOptPrefix-java.lang.String-">setLongOptPrefix</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</code>

  590. <div class="block">Sets the 'longOptPrefix'.</div>

  591. </td>

  592. </tr>

  593. <tr id="i32" class="altColor">

  594. <td class="colFirst"><code>void</code></td>

  595. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setLongOptSeparator-java.lang.String-">setLongOptSeparator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;longOptSeparator)</code>

  596. <div class="block">Set the separator displayed between a long option and its value.</div>

  597. </td>

  598. </tr>

  599. <tr id="i33" class="rowColor">

  600. <td class="colFirst"><code>void</code></td>

  601. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setNewLine-java.lang.String-">setNewLine</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newline)</code>

  602. <div class="block">Sets the 'newLine'.</div>

  603. </td>

  604. </tr>

  605. <tr id="i34" class="altColor">

  606. <td class="colFirst"><code>void</code></td>

  607. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setOptionComparator-java.util.Comparator-">setOptionComparator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>&gt;&nbsp;comparator)</code>

  608. <div class="block">Set the comparator used to sort the options when they output in help text.</div>

  609. </td>

  610. </tr>

  611. <tr id="i35" class="rowColor">

  612. <td class="colFirst"><code>void</code></td>

  613. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setOptPrefix-java.lang.String-">setOptPrefix</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</code>

  614. <div class="block">Sets the 'optPrefix'.</div>

  615. </td>

  616. </tr>

  617. <tr id="i36" class="altColor">

  618. <td class="colFirst"><code>void</code></td>

  619. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setSyntaxPrefix-java.lang.String-">setSyntaxPrefix</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</code>

  620. <div class="block">Sets the 'syntaxPrefix'.</div>

  621. </td>

  622. </tr>

  623. <tr id="i37" class="rowColor">

  624. <td class="colFirst"><code>void</code></td>

  625. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/HelpFormatter.html#setWidth-int-">setWidth</a></span>(int&nbsp;width)</code>

  626. <div class="block">Sets the 'width'.</div>

  627. </td>

  628. </tr>

  629. </table>

  630. <ul class="blockList">

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

  632. <!--   -->

  633. </a>

  634. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>

  635. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>

  636. </ul>

  637. </li>

  638. </ul>

  639. </li>

  640. </ul>

  641. </div>

  642. <div class="details">

  643. <ul class="blockList">

  644. <li class="blockList">

  645. <!-- ============ FIELD DETAIL =========== -->

  646. <ul class="blockList">

  647. <li class="blockList"><a name="field.detail">

  648. <!--   -->

  649. </a>

  650. <h3>Field Detail</h3>

  651. <a name="DEFAULT_WIDTH">

  652. <!--   -->

  653. </a>

  654. <ul class="blockList">

  655. <li class="blockList">

  656. <h4>DEFAULT_WIDTH</h4>

  657. <pre>public static final&nbsp;int DEFAULT_WIDTH</pre>

  658. <div class="block">default number of characters per line</div>

  659. <dl>

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

  661. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_WIDTH">Constant Field Values</a></dd>

  662. </dl>

  663. </li>

  664. </ul>

  665. <a name="DEFAULT_LEFT_PAD">

  666. <!--   -->

  667. </a>

  668. <ul class="blockList">

  669. <li class="blockList">

  670. <h4>DEFAULT_LEFT_PAD</h4>

  671. <pre>public static final&nbsp;int DEFAULT_LEFT_PAD</pre>

  672. <div class="block">default padding to the left of each line</div>

  673. <dl>

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

  675. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_LEFT_PAD">Constant Field Values</a></dd>

  676. </dl>

  677. </li>

  678. </ul>

  679. <a name="DEFAULT_DESC_PAD">

  680. <!--   -->

  681. </a>

  682. <ul class="blockList">

  683. <li class="blockList">

  684. <h4>DEFAULT_DESC_PAD</h4>

  685. <pre>public static final&nbsp;int DEFAULT_DESC_PAD</pre>

  686. <div class="block">number of space characters to be prefixed to each description line</div>

  687. <dl>

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

  689. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_DESC_PAD">Constant Field Values</a></dd>

  690. </dl>

  691. </li>

  692. </ul>

  693. <a name="DEFAULT_SYNTAX_PREFIX">

  694. <!--   -->

  695. </a>

  696. <ul class="blockList">

  697. <li class="blockList">

  698. <h4>DEFAULT_SYNTAX_PREFIX</h4>

  699. <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_SYNTAX_PREFIX</pre>

  700. <div class="block">the string to display at the beginning of the usage statement</div>

  701. <dl>

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

  703. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_SYNTAX_PREFIX">Constant Field Values</a></dd>

  704. </dl>

  705. </li>

  706. </ul>

  707. <a name="DEFAULT_OPT_PREFIX">

  708. <!--   -->

  709. </a>

  710. <ul class="blockList">

  711. <li class="blockList">

  712. <h4>DEFAULT_OPT_PREFIX</h4>

  713. <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_OPT_PREFIX</pre>

  714. <div class="block">default prefix for shortOpts</div>

  715. <dl>

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

  717. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_OPT_PREFIX">Constant Field Values</a></dd>

  718. </dl>

  719. </li>

  720. </ul>

  721. <a name="DEFAULT_LONG_OPT_PREFIX">

  722. <!--   -->

  723. </a>

  724. <ul class="blockList">

  725. <li class="blockList">

  726. <h4>DEFAULT_LONG_OPT_PREFIX</h4>

  727. <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_LONG_OPT_PREFIX</pre>

  728. <div class="block">default prefix for long Option</div>

  729. <dl>

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

  731. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_LONG_OPT_PREFIX">Constant Field Values</a></dd>

  732. </dl>

  733. </li>

  734. </ul>

  735. <a name="DEFAULT_LONG_OPT_SEPARATOR">

  736. <!--   -->

  737. </a>

  738. <ul class="blockList">

  739. <li class="blockList">

  740. <h4>DEFAULT_LONG_OPT_SEPARATOR</h4>

  741. <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_LONG_OPT_SEPARATOR</pre>

  742. <div class="block">default separator displayed between a long Option and its value</div>

  743. <dl>

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

  745. <dd>1.3</dd>

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

  747. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_LONG_OPT_SEPARATOR">Constant Field Values</a></dd>

  748. </dl>

  749. </li>

  750. </ul>

  751. <a name="DEFAULT_ARG_NAME">

  752. <!--   -->

  753. </a>

  754. <ul class="blockList">

  755. <li class="blockList">

  756. <h4>DEFAULT_ARG_NAME</h4>

  757. <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_ARG_NAME</pre>

  758. <div class="block">default name for an argument</div>

  759. <dl>

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

  761. <dd><a href="../../../../constant-values.html#org.apache.commons.cli.HelpFormatter.DEFAULT_ARG_NAME">Constant Field Values</a></dd>

  762. </dl>

  763. </li>

  764. </ul>

  765. <a name="defaultWidth">

  766. <!--   -->

  767. </a>

  768. <ul class="blockList">

  769. <li class="blockList">

  770. <h4>defaultWidth</h4>

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

  772. public&nbsp;int defaultWidth</pre>

  773. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  774.  - use get/setWidth methods instead.</span></div>

  775. <div class="block">number of characters per line</div>

  776. </li>

  777. </ul>

  778. <a name="defaultLeftPad">

  779. <!--   -->

  780. </a>

  781. <ul class="blockList">

  782. <li class="blockList">

  783. <h4>defaultLeftPad</h4>

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

  785. public&nbsp;int defaultLeftPad</pre>

  786. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  787.  - use get/setLeftPadding methods instead.</span></div>

  788. <div class="block">amount of padding to the left of each line</div>

  789. </li>

  790. </ul>

  791. <a name="defaultDescPad">

  792. <!--   -->

  793. </a>

  794. <ul class="blockList">

  795. <li class="blockList">

  796. <h4>defaultDescPad</h4>

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

  798. public&nbsp;int defaultDescPad</pre>

  799. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  800.  - use get/setDescPadding methods instead.</span></div>

  801. <div class="block">the number of characters of padding to be prefixed

  802.  to each description line</div>

  803. </li>

  804. </ul>

  805. <a name="defaultSyntaxPrefix">

  806. <!--   -->

  807. </a>

  808. <ul class="blockList">

  809. <li class="blockList">

  810. <h4>defaultSyntaxPrefix</h4>

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

  812. public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultSyntaxPrefix</pre>

  813. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  814.  - use get/setSyntaxPrefix methods instead.</span></div>

  815. <div class="block">the string to display at the beginning of the usage statement</div>

  816. </li>

  817. </ul>

  818. <a name="defaultNewLine">

  819. <!--   -->

  820. </a>

  821. <ul class="blockList">

  822. <li class="blockList">

  823. <h4>defaultNewLine</h4>

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

  825. public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultNewLine</pre>

  826. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  827.  - use get/setNewLine methods instead.</span></div>

  828. <div class="block">the new line string</div>

  829. </li>

  830. </ul>

  831. <a name="defaultOptPrefix">

  832. <!--   -->

  833. </a>

  834. <ul class="blockList">

  835. <li class="blockList">

  836. <h4>defaultOptPrefix</h4>

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

  838. public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultOptPrefix</pre>

  839. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  840.  - use get/setOptPrefix methods instead.</span></div>

  841. <div class="block">the shortOpt prefix</div>

  842. </li>

  843. </ul>

  844. <a name="defaultLongOptPrefix">

  845. <!--   -->

  846. </a>

  847. <ul class="blockList">

  848. <li class="blockList">

  849. <h4>defaultLongOptPrefix</h4>

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

  851. public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultLongOptPrefix</pre>

  852. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  853.  - use get/setLongOptPrefix methods instead.</span></div>

  854. <div class="block">the long Opt prefix</div>

  855. </li>

  856. </ul>

  857. <a name="defaultArgName">

  858. <!--   -->

  859. </a>

  860. <ul class="blockList">

  861. <li class="blockList">

  862. <h4>defaultArgName</h4>

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

  864. public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultArgName</pre>

  865. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Scope will be made private for next major version

  866.  - use get/setArgName methods instead.</span></div>

  867. <div class="block">the name of the argument</div>

  868. </li>

  869. </ul>

  870. <a name="optionComparator">

  871. <!--   -->

  872. </a>

  873. <ul class="blockListLast">

  874. <li class="blockList">

  875. <h4>optionComparator</h4>

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

  877. <div class="block">Comparator used to sort the options when they output in help text

  878.  

  879.  Defaults to case-insensitive alphabetical sorting by option key</div>

  880. </li>

  881. </ul>

  882. </li>

  883. </ul>

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

  885. <ul class="blockList">

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

  887. <!--   -->

  888. </a>

  889. <h3>Constructor Detail</h3>

  890. <a name="HelpFormatter--">

  891. <!--   -->

  892. </a>

  893. <ul class="blockListLast">

  894. <li class="blockList">

  895. <h4>HelpFormatter</h4>

  896. <pre>public&nbsp;HelpFormatter()</pre>

  897. </li>

  898. </ul>

  899. </li>

  900. </ul>

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

  902. <ul class="blockList">

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

  904. <!--   -->

  905. </a>

  906. <h3>Method Detail</h3>

  907. <a name="setWidth-int-">

  908. <!--   -->

  909. </a>

  910. <ul class="blockList">

  911. <li class="blockList">

  912. <h4>setWidth</h4>

  913. <pre>public&nbsp;void&nbsp;setWidth(int&nbsp;width)</pre>

  914. <div class="block">Sets the 'width'.</div>

  915. <dl>

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

  917. <dd><code>width</code> - the new value of 'width'</dd>

  918. </dl>

  919. </li>

  920. </ul>

  921. <a name="getWidth--">

  922. <!--   -->

  923. </a>

  924. <ul class="blockList">

  925. <li class="blockList">

  926. <h4>getWidth</h4>

  927. <pre>public&nbsp;int&nbsp;getWidth()</pre>

  928. <div class="block">Returns the 'width'.</div>

  929. <dl>

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

  931. <dd>the 'width'</dd>

  932. </dl>

  933. </li>

  934. </ul>

  935. <a name="setLeftPadding-int-">

  936. <!--   -->

  937. </a>

  938. <ul class="blockList">

  939. <li class="blockList">

  940. <h4>setLeftPadding</h4>

  941. <pre>public&nbsp;void&nbsp;setLeftPadding(int&nbsp;padding)</pre>

  942. <div class="block">Sets the 'leftPadding'.</div>

  943. <dl>

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

  945. <dd><code>padding</code> - the new value of 'leftPadding'</dd>

  946. </dl>

  947. </li>

  948. </ul>

  949. <a name="getLeftPadding--">

  950. <!--   -->

  951. </a>

  952. <ul class="blockList">

  953. <li class="blockList">

  954. <h4>getLeftPadding</h4>

  955. <pre>public&nbsp;int&nbsp;getLeftPadding()</pre>

  956. <div class="block">Returns the 'leftPadding'.</div>

  957. <dl>

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

  959. <dd>the 'leftPadding'</dd>

  960. </dl>

  961. </li>

  962. </ul>

  963. <a name="setDescPadding-int-">

  964. <!--   -->

  965. </a>

  966. <ul class="blockList">

  967. <li class="blockList">

  968. <h4>setDescPadding</h4>

  969. <pre>public&nbsp;void&nbsp;setDescPadding(int&nbsp;padding)</pre>

  970. <div class="block">Sets the 'descPadding'.</div>

  971. <dl>

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

  973. <dd><code>padding</code> - the new value of 'descPadding'</dd>

  974. </dl>

  975. </li>

  976. </ul>

  977. <a name="getDescPadding--">

  978. <!--   -->

  979. </a>

  980. <ul class="blockList">

  981. <li class="blockList">

  982. <h4>getDescPadding</h4>

  983. <pre>public&nbsp;int&nbsp;getDescPadding()</pre>

  984. <div class="block">Returns the 'descPadding'.</div>

  985. <dl>

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

  987. <dd>the 'descPadding'</dd>

  988. </dl>

  989. </li>

  990. </ul>

  991. <a name="setSyntaxPrefix-java.lang.String-">

  992. <!--   -->

  993. </a>

  994. <ul class="blockList">

  995. <li class="blockList">

  996. <h4>setSyntaxPrefix</h4>

  997. <pre>public&nbsp;void&nbsp;setSyntaxPrefix(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</pre>

  998. <div class="block">Sets the 'syntaxPrefix'.</div>

  999. <dl>

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

  1001. <dd><code>prefix</code> - the new value of 'syntaxPrefix'</dd>

  1002. </dl>

  1003. </li>

  1004. </ul>

  1005. <a name="getSyntaxPrefix--">

  1006. <!--   -->

  1007. </a>

  1008. <ul class="blockList">

  1009. <li class="blockList">

  1010. <h4>getSyntaxPrefix</h4>

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

  1012. <div class="block">Returns the 'syntaxPrefix'.</div>

  1013. <dl>

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

  1015. <dd>the 'syntaxPrefix'</dd>

  1016. </dl>

  1017. </li>

  1018. </ul>

  1019. <a name="setNewLine-java.lang.String-">

  1020. <!--   -->

  1021. </a>

  1022. <ul class="blockList">

  1023. <li class="blockList">

  1024. <h4>setNewLine</h4>

  1025. <pre>public&nbsp;void&nbsp;setNewLine(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;newline)</pre>

  1026. <div class="block">Sets the 'newLine'.</div>

  1027. <dl>

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

  1029. <dd><code>newline</code> - the new value of 'newLine'</dd>

  1030. </dl>

  1031. </li>

  1032. </ul>

  1033. <a name="getNewLine--">

  1034. <!--   -->

  1035. </a>

  1036. <ul class="blockList">

  1037. <li class="blockList">

  1038. <h4>getNewLine</h4>

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

  1040. <div class="block">Returns the 'newLine'.</div>

  1041. <dl>

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

  1043. <dd>the 'newLine'</dd>

  1044. </dl>

  1045. </li>

  1046. </ul>

  1047. <a name="setOptPrefix-java.lang.String-">

  1048. <!--   -->

  1049. </a>

  1050. <ul class="blockList">

  1051. <li class="blockList">

  1052. <h4>setOptPrefix</h4>

  1053. <pre>public&nbsp;void&nbsp;setOptPrefix(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</pre>

  1054. <div class="block">Sets the 'optPrefix'.</div>

  1055. <dl>

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

  1057. <dd><code>prefix</code> - the new value of 'optPrefix'</dd>

  1058. </dl>

  1059. </li>

  1060. </ul>

  1061. <a name="getOptPrefix--">

  1062. <!--   -->

  1063. </a>

  1064. <ul class="blockList">

  1065. <li class="blockList">

  1066. <h4>getOptPrefix</h4>

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

  1068. <div class="block">Returns the 'optPrefix'.</div>

  1069. <dl>

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

  1071. <dd>the 'optPrefix'</dd>

  1072. </dl>

  1073. </li>

  1074. </ul>

  1075. <a name="setLongOptPrefix-java.lang.String-">

  1076. <!--   -->

  1077. </a>

  1078. <ul class="blockList">

  1079. <li class="blockList">

  1080. <h4>setLongOptPrefix</h4>

  1081. <pre>public&nbsp;void&nbsp;setLongOptPrefix(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</pre>

  1082. <div class="block">Sets the 'longOptPrefix'.</div>

  1083. <dl>

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

  1085. <dd><code>prefix</code> - the new value of 'longOptPrefix'</dd>

  1086. </dl>

  1087. </li>

  1088. </ul>

  1089. <a name="getLongOptPrefix--">

  1090. <!--   -->

  1091. </a>

  1092. <ul class="blockList">

  1093. <li class="blockList">

  1094. <h4>getLongOptPrefix</h4>

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

  1096. <div class="block">Returns the 'longOptPrefix'.</div>

  1097. <dl>

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

  1099. <dd>the 'longOptPrefix'</dd>

  1100. </dl>

  1101. </li>

  1102. </ul>

  1103. <a name="setLongOptSeparator-java.lang.String-">

  1104. <!--   -->

  1105. </a>

  1106. <ul class="blockList">

  1107. <li class="blockList">

  1108. <h4>setLongOptSeparator</h4>

  1109. <pre>public&nbsp;void&nbsp;setLongOptSeparator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;longOptSeparator)</pre>

  1110. <div class="block">Set the separator displayed between a long option and its value.

  1111.  Ensure that the separator specified is supported by the parser used,

  1112.  typically ' ' or '='.</div>

  1113. <dl>

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

  1115. <dd><code>longOptSeparator</code> - the separator, typically ' ' or '='.</dd>

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

  1117. <dd>1.3</dd>

  1118. </dl>

  1119. </li>

  1120. </ul>

  1121. <a name="getLongOptSeparator--">

  1122. <!--   -->

  1123. </a>

  1124. <ul class="blockList">

  1125. <li class="blockList">

  1126. <h4>getLongOptSeparator</h4>

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

  1128. <div class="block">Returns the separator displayed between a long option and its value.</div>

  1129. <dl>

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

  1131. <dd>the separator</dd>

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

  1133. <dd>1.3</dd>

  1134. </dl>

  1135. </li>

  1136. </ul>

  1137. <a name="setArgName-java.lang.String-">

  1138. <!--   -->

  1139. </a>

  1140. <ul class="blockList">

  1141. <li class="blockList">

  1142. <h4>setArgName</h4>

  1143. <pre>public&nbsp;void&nbsp;setArgName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>

  1144. <div class="block">Sets the 'argName'.</div>

  1145. <dl>

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

  1147. <dd><code>name</code> - the new value of 'argName'</dd>

  1148. </dl>

  1149. </li>

  1150. </ul>

  1151. <a name="getArgName--">

  1152. <!--   -->

  1153. </a>

  1154. <ul class="blockList">

  1155. <li class="blockList">

  1156. <h4>getArgName</h4>

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

  1158. <div class="block">Returns the 'argName'.</div>

  1159. <dl>

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

  1161. <dd>the 'argName'</dd>

  1162. </dl>

  1163. </li>

  1164. </ul>

  1165. <a name="getOptionComparator--">

  1166. <!--   -->

  1167. </a>

  1168. <ul class="blockList">

  1169. <li class="blockList">

  1170. <h4>getOptionComparator</h4>

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

  1172. <div class="block">Comparator used to sort the options when they output in help text.

  1173.  Defaults to case-insensitive alphabetical sorting by option key.</div>

  1174. <dl>

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

  1176. <dd>the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> currently in use to sort the options</dd>

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

  1178. <dd>1.2</dd>

  1179. </dl>

  1180. </li>

  1181. </ul>

  1182. <a name="setOptionComparator-java.util.Comparator-">

  1183. <!--   -->

  1184. </a>

  1185. <ul class="blockList">

  1186. <li class="blockList">

  1187. <h4>setOptionComparator</h4>

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

  1189. <div class="block">Set the comparator used to sort the options when they output in help text.

  1190.  Passing in a null comparator will keep the options in the order they were declared.</div>

  1191. <dl>

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

  1193. <dd><code>comparator</code> - the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> to use for sorting the options</dd>

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

  1195. <dd>1.2</dd>

  1196. </dl>

  1197. </li>

  1198. </ul>

  1199. <a name="printHelp-java.lang.String-org.apache.commons.cli.Options-">

  1200. <!--   -->

  1201. </a>

  1202. <ul class="blockList">

  1203. <li class="blockList">

  1204. <h4>printHelp</h4>

  1205. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1206.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options)</pre>

  1207. <div class="block">Print the help for <code>options</code> with the specified

  1208.  command line syntax.  This method prints help information to

  1209.  System.out.</div>

  1210. <dl>

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

  1212. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1213. <dd><code>options</code> - the Options instance</dd>

  1214. </dl>

  1215. </li>

  1216. </ul>

  1217. <a name="printHelp-java.lang.String-org.apache.commons.cli.Options-boolean-">

  1218. <!--   -->

  1219. </a>

  1220. <ul class="blockList">

  1221. <li class="blockList">

  1222. <h4>printHelp</h4>

  1223. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1224.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1225.                       boolean&nbsp;autoUsage)</pre>

  1226. <div class="block">Print the help for <code>options</code> with the specified

  1227.  command line syntax.  This method prints help information to 

  1228.  System.out.</div>

  1229. <dl>

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

  1231. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1232. <dd><code>options</code> - the Options instance</dd>

  1233. <dd><code>autoUsage</code> - whether to print an automatically generated

  1234.  usage statement</dd>

  1235. </dl>

  1236. </li>

  1237. </ul>

  1238. <a name="printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">

  1239. <!--   -->

  1240. </a>

  1241. <ul class="blockList">

  1242. <li class="blockList">

  1243. <h4>printHelp</h4>

  1244. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1245.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1246.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1247.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</pre>

  1248. <div class="block">Print the help for <code>options</code> with the specified

  1249.  command line syntax.  This method prints help information to

  1250.  System.out.</div>

  1251. <dl>

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

  1253. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1254. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1255. <dd><code>options</code> - the Options instance</dd>

  1256. <dd><code>footer</code> - the banner to display at the end of the help</dd>

  1257. </dl>

  1258. </li>

  1259. </ul>

  1260. <a name="printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">

  1261. <!--   -->

  1262. </a>

  1263. <ul class="blockList">

  1264. <li class="blockList">

  1265. <h4>printHelp</h4>

  1266. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1267.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1268.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1269.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  1270.                       boolean&nbsp;autoUsage)</pre>

  1271. <div class="block">Print the help for <code>options</code> with the specified

  1272.  command line syntax.  This method prints help information to 

  1273.  System.out.</div>

  1274. <dl>

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

  1276. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1277. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1278. <dd><code>options</code> - the Options instance</dd>

  1279. <dd><code>footer</code> - the banner to display at the end of the help</dd>

  1280. <dd><code>autoUsage</code> - whether to print an automatically generated

  1281.  usage statement</dd>

  1282. </dl>

  1283. </li>

  1284. </ul>

  1285. <a name="printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">

  1286. <!--   -->

  1287. </a>

  1288. <ul class="blockList">

  1289. <li class="blockList">

  1290. <h4>printHelp</h4>

  1291. <pre>public&nbsp;void&nbsp;printHelp(int&nbsp;width,

  1292.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1293.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1294.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1295.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</pre>

  1296. <div class="block">Print the help for <code>options</code> with the specified

  1297.  command line syntax.  This method prints help information to

  1298.  System.out.</div>

  1299. <dl>

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

  1301. <dd><code>width</code> - the number of characters to be displayed on each line</dd>

  1302. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1303. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1304. <dd><code>options</code> - the Options instance</dd>

  1305. <dd><code>footer</code> - the banner to display at the end of the help</dd>

  1306. </dl>

  1307. </li>

  1308. </ul>

  1309. <a name="printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">

  1310. <!--   -->

  1311. </a>

  1312. <ul class="blockList">

  1313. <li class="blockList">

  1314. <h4>printHelp</h4>

  1315. <pre>public&nbsp;void&nbsp;printHelp(int&nbsp;width,

  1316.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1317.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1318.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1319.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  1320.                       boolean&nbsp;autoUsage)</pre>

  1321. <div class="block">Print the help for <code>options</code> with the specified

  1322.  command line syntax.  This method prints help information to

  1323.  System.out.</div>

  1324. <dl>

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

  1326. <dd><code>width</code> - the number of characters to be displayed on each line</dd>

  1327. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1328. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1329. <dd><code>options</code> - the Options instance</dd>

  1330. <dd><code>footer</code> - the banner to display at the end of the help</dd>

  1331. <dd><code>autoUsage</code> - whether to print an automatically generated 

  1332.  usage statement</dd>

  1333. </dl>

  1334. </li>

  1335. </ul>

  1336. <a name="printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-">

  1337. <!--   -->

  1338. </a>

  1339. <ul class="blockList">

  1340. <li class="blockList">

  1341. <h4>printHelp</h4>

  1342. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1343.                       int&nbsp;width,

  1344.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1345.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1346.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1347.                       int&nbsp;leftPad,

  1348.                       int&nbsp;descPad,

  1349.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer)</pre>

  1350. <div class="block">Print the help for <code>options</code> with the specified

  1351.  command line syntax.</div>

  1352. <dl>

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

  1354. <dd><code>pw</code> - the writer to which the help will be written</dd>

  1355. <dd><code>width</code> - the number of characters to be displayed on each line</dd>

  1356. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1357. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1358. <dd><code>options</code> - the Options instance</dd>

  1359. <dd><code>leftPad</code> - the number of characters of padding to be prefixed

  1360.  to each line</dd>

  1361. <dd><code>descPad</code> - the number of characters of padding to be prefixed

  1362.  to each description line</dd>

  1363. <dd><code>footer</code> - the banner to display at the end of the help</dd>

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

  1365. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if there is no room to print a line</dd>

  1366. </dl>

  1367. </li>

  1368. </ul>

  1369. <a name="printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-boolean-">

  1370. <!--   -->

  1371. </a>

  1372. <ul class="blockList">

  1373. <li class="blockList">

  1374. <h4>printHelp</h4>

  1375. <pre>public&nbsp;void&nbsp;printHelp(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1376.                       int&nbsp;width,

  1377.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax,

  1378.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;header,

  1379.                       <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1380.                       int&nbsp;leftPad,

  1381.                       int&nbsp;descPad,

  1382.                       <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;footer,

  1383.                       boolean&nbsp;autoUsage)</pre>

  1384. <div class="block">Print the help for <code>options</code> with the specified

  1385.  command line syntax.</div>

  1386. <dl>

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

  1388. <dd><code>pw</code> - the writer to which the help will be written</dd>

  1389. <dd><code>width</code> - the number of characters to be displayed on each line</dd>

  1390. <dd><code>cmdLineSyntax</code> - the syntax for this application</dd>

  1391. <dd><code>header</code> - the banner to display at the beginning of the help</dd>

  1392. <dd><code>options</code> - the Options instance</dd>

  1393. <dd><code>leftPad</code> - the number of characters of padding to be prefixed

  1394.  to each line</dd>

  1395. <dd><code>descPad</code> - the number of characters of padding to be prefixed

  1396.  to each description line</dd>

  1397. <dd><code>footer</code> - the banner to display at the end of the help</dd>

  1398. <dd><code>autoUsage</code> - whether to print an automatically generated

  1399.  usage statement</dd>

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

  1401. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if there is no room to print a line</dd>

  1402. </dl>

  1403. </li>

  1404. </ul>

  1405. <a name="printUsage-java.io.PrintWriter-int-java.lang.String-org.apache.commons.cli.Options-">

  1406. <!--   -->

  1407. </a>

  1408. <ul class="blockList">

  1409. <li class="blockList">

  1410. <h4>printUsage</h4>

  1411. <pre>public&nbsp;void&nbsp;printUsage(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1412.                        int&nbsp;width,

  1413.                        <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;app,

  1414.                        <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options)</pre>

  1415. <div class="block">Prints the usage statement for the specified application.</div>

  1416. <dl>

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

  1418. <dd><code>pw</code> - The PrintWriter to print the usage statement</dd>

  1419. <dd><code>width</code> - The number of characters to display per line</dd>

  1420. <dd><code>app</code> - The application name</dd>

  1421. <dd><code>options</code> - The command line Options</dd>

  1422. </dl>

  1423. </li>

  1424. </ul>

  1425. <a name="printUsage-java.io.PrintWriter-int-java.lang.String-">

  1426. <!--   -->

  1427. </a>

  1428. <ul class="blockList">

  1429. <li class="blockList">

  1430. <h4>printUsage</h4>

  1431. <pre>public&nbsp;void&nbsp;printUsage(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1432.                        int&nbsp;width,

  1433.                        <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cmdLineSyntax)</pre>

  1434. <div class="block">Print the cmdLineSyntax to the specified writer, using the

  1435.  specified width.</div>

  1436. <dl>

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

  1438. <dd><code>pw</code> - The printWriter to write the help to</dd>

  1439. <dd><code>width</code> - The number of characters per line for the usage statement.</dd>

  1440. <dd><code>cmdLineSyntax</code> - The usage statement.</dd>

  1441. </dl>

  1442. </li>

  1443. </ul>

  1444. <a name="printOptions-java.io.PrintWriter-int-org.apache.commons.cli.Options-int-int-">

  1445. <!--   -->

  1446. </a>

  1447. <ul class="blockList">

  1448. <li class="blockList">

  1449. <h4>printOptions</h4>

  1450. <pre>public&nbsp;void&nbsp;printOptions(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1451.                          int&nbsp;width,

  1452.                          <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1453.                          int&nbsp;leftPad,

  1454.                          int&nbsp;descPad)</pre>

  1455. <div class="block">Print the help for the specified Options to the specified writer, 

  1456.  using the specified width, left padding and description padding.</div>

  1457. <dl>

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

  1459. <dd><code>pw</code> - The printWriter to write the help to</dd>

  1460. <dd><code>width</code> - The number of characters to display per line</dd>

  1461. <dd><code>options</code> - The command line Options</dd>

  1462. <dd><code>leftPad</code> - the number of characters of padding to be prefixed

  1463.  to each line</dd>

  1464. <dd><code>descPad</code> - the number of characters of padding to be prefixed

  1465.  to each description line</dd>

  1466. </dl>

  1467. </li>

  1468. </ul>

  1469. <a name="printWrapped-java.io.PrintWriter-int-java.lang.String-">

  1470. <!--   -->

  1471. </a>

  1472. <ul class="blockList">

  1473. <li class="blockList">

  1474. <h4>printWrapped</h4>

  1475. <pre>public&nbsp;void&nbsp;printWrapped(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1476.                          int&nbsp;width,

  1477.                          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</pre>

  1478. <div class="block">Print the specified text to the specified PrintWriter.</div>

  1479. <dl>

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

  1481. <dd><code>pw</code> - The printWriter to write the help to</dd>

  1482. <dd><code>width</code> - The number of characters to display per line</dd>

  1483. <dd><code>text</code> - The text to be written to the PrintWriter</dd>

  1484. </dl>

  1485. </li>

  1486. </ul>

  1487. <a name="printWrapped-java.io.PrintWriter-int-int-java.lang.String-">

  1488. <!--   -->

  1489. </a>

  1490. <ul class="blockList">

  1491. <li class="blockList">

  1492. <h4>printWrapped</h4>

  1493. <pre>public&nbsp;void&nbsp;printWrapped(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw,

  1494.                          int&nbsp;width,

  1495.                          int&nbsp;nextLineTabStop,

  1496.                          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</pre>

  1497. <div class="block">Print the specified text to the specified PrintWriter.</div>

  1498. <dl>

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

  1500. <dd><code>pw</code> - The printWriter to write the help to</dd>

  1501. <dd><code>width</code> - The number of characters to display per line</dd>

  1502. <dd><code>nextLineTabStop</code> - The position on the next line for the first tab.</dd>

  1503. <dd><code>text</code> - The text to be written to the PrintWriter</dd>

  1504. </dl>

  1505. </li>

  1506. </ul>

  1507. <a name="renderOptions-java.lang.StringBuffer-int-org.apache.commons.cli.Options-int-int-">

  1508. <!--   -->

  1509. </a>

  1510. <ul class="blockList">

  1511. <li class="blockList">

  1512. <h4>renderOptions</h4>

  1513. <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;renderOptions(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;sb,

  1514.                                      int&nbsp;width,

  1515.                                      <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a>&nbsp;options,

  1516.                                      int&nbsp;leftPad,

  1517.                                      int&nbsp;descPad)</pre>

  1518. <div class="block">Render the specified Options and return the rendered Options

  1519.  in a StringBuffer.</div>

  1520. <dl>

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

  1522. <dd><code>sb</code> - The StringBuffer to place the rendered Options into.</dd>

  1523. <dd><code>width</code> - The number of characters to display per line</dd>

  1524. <dd><code>options</code> - The command line Options</dd>

  1525. <dd><code>leftPad</code> - the number of characters of padding to be prefixed

  1526.  to each line</dd>

  1527. <dd><code>descPad</code> - the number of characters of padding to be prefixed

  1528.  to each description line</dd>

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

  1530. <dd>the StringBuffer with the rendered Options contents.</dd>

  1531. </dl>

  1532. </li>

  1533. </ul>

  1534. <a name="renderWrappedText-java.lang.StringBuffer-int-int-java.lang.String-">

  1535. <!--   -->

  1536. </a>

  1537. <ul class="blockList">

  1538. <li class="blockList">

  1539. <h4>renderWrappedText</h4>

  1540. <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;renderWrappedText(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a>&nbsp;sb,

  1541.                                          int&nbsp;width,

  1542.                                          int&nbsp;nextLineTabStop,

  1543.                                          <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text)</pre>

  1544. <div class="block">Render the specified text and return the rendered Options

  1545.  in a StringBuffer.</div>

  1546. <dl>

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

  1548. <dd><code>sb</code> - The StringBuffer to place the rendered text into.</dd>

  1549. <dd><code>width</code> - The number of characters to display per line</dd>

  1550. <dd><code>nextLineTabStop</code> - The position on the next line for the first tab.</dd>

  1551. <dd><code>text</code> - The text to be rendered.</dd>

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

  1553. <dd>the StringBuffer with the rendered Options contents.</dd>

  1554. </dl>

  1555. </li>

  1556. </ul>

  1557. <a name="findWrapPos-java.lang.String-int-int-">

  1558. <!--   -->

  1559. </a>

  1560. <ul class="blockList">

  1561. <li class="blockList">

  1562. <h4>findWrapPos</h4>

  1563. <pre>protected&nbsp;int&nbsp;findWrapPos(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;text,

  1564.                           int&nbsp;width,

  1565.                           int&nbsp;startPos)</pre>

  1566. <div class="block">Finds the next text wrap position after <code>startPos</code> for the

  1567.  text in <code>text</code> with the column width <code>width</code>.

  1568.  The wrap point is the last position before startPos+width having a 

  1569.  whitespace character (space, \n, \r). If there is no whitespace character

  1570.  before startPos+width, it will return startPos+width.</div>

  1571. <dl>

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

  1573. <dd><code>text</code> - The text being searched for the wrap position</dd>

  1574. <dd><code>width</code> - width of the wrapped text</dd>

  1575. <dd><code>startPos</code> - position from which to start the lookup whitespace

  1576.  character</dd>

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

  1578. <dd>position on which the text must be wrapped or -1 if the wrap

  1579.  position is at the end of the text</dd>

  1580. </dl>

  1581. </li>

  1582. </ul>

  1583. <a name="createPadding-int-">

  1584. <!--   -->

  1585. </a>

  1586. <ul class="blockList">

  1587. <li class="blockList">

  1588. <h4>createPadding</h4>

  1589. <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;createPadding(int&nbsp;len)</pre>

  1590. <div class="block">Return a String of padding of length <code>len</code>.</div>

  1591. <dl>

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

  1593. <dd><code>len</code> - The length of the String of padding to create.</dd>

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

  1595. <dd>The String of padding</dd>

  1596. </dl>

  1597. </li>

  1598. </ul>

  1599. <a name="rtrim-java.lang.String-">

  1600. <!--   -->

  1601. </a>

  1602. <ul class="blockListLast">

  1603. <li class="blockList">

  1604. <h4>rtrim</h4>

  1605. <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rtrim(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;s)</pre>

  1606. <div class="block">Remove the trailing whitespace from the specified String.</div>

  1607. <dl>

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

  1609. <dd><code>s</code> - The String to remove the trailing padding from.</dd>

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

  1611. <dd>The String of without the trailing padding</dd>

  1612. </dl>

  1613. </li>

  1614. </ul>

  1615. </li>

  1616. </ul>

  1617. </li>

  1618. </ul>

  1619. </div>

  1620. </div>

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

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

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

  1624. <!--   -->

  1625. </a>

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

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

  1628. <!--   -->

  1629. </a>

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

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

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

  1633. <li><a href="class-use/HelpFormatter.html">Use</a></li>

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

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

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

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

  1638. </ul>

  1639. </div>

  1640. <div class="subNav">

  1641. <ul class="navList">

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

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

  1644. </ul>

  1645. <ul class="navList">

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

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

  1648. </ul>

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

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

  1651. </ul>

  1652. <div>

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

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

  1655.   if(window==top) {

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

  1657.   }

  1658.   else {

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

  1660.   }

  1661.   //-->

  1662. </script>

  1663. </div>

  1664. <div>

  1665. <ul class="subNavList">

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

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

  1668. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>

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

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

  1671. </ul>

  1672. <ul class="subNavList">

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

  1674. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>

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

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

  1677. </ul>

  1678. </div>

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

  1680. <!--   -->

  1681. </a></div>

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

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

  1684. </body>

  1685. </html>