Modified: websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html ============================================================================== --- websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html (original) +++ websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html Sat May 9 18:19:15 2015 @@ -66,17 +66,17 @@ <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * This produces the following output:</em> <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * </em> <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * usage: myapp -f <FILE> [-h] [-v]</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * usage: myapp -f &lt;FILE&gt; [-h] [-v]</em> <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Do something useful with an input file</em> <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * -f,--file &lt;FILE> The file to be processed</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * -f,--file &lt;FILE&gt; The file to be processed</em> <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * -h,--help</em> <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * -v,--version Print the version of the application</em> <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * </em> <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Please report issues at <a href="http://example.com/issue"; target="alexandria_uri">http://example.com/issue</a>s</em> <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * </pre></em> <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @version $Id: HelpFormatter.java 1444961 2013-02-11 21:03:51Z tn $</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @version $Id: HelpFormatter.java 1677407 2015-05-03 14:31:12Z britter $</em> <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/commons/cli/HelpFormatter.html">HelpFormatter</a> <a class="jxr_linenumber" name="L74" href="#L74">74</a> { @@ -100,1002 +100,1006 @@ <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/** default prefix for long Option */</em> <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_PREFIX = <span class="jxr_string">"--"</span>; <a class="jxr_linenumber" name="L94" href="#L94">94</a> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/** default separator displayed between a long Option and its value */</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_SEPARATOR = <span class="jxr_string">" "</span>; -<a class="jxr_linenumber" name="L97" href="#L97">97</a> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/** default name for an argument */</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ARG_NAME = <span class="jxr_string">"arg"</span>; -<a class="jxr_linenumber" name="L100" href="#L100">100</a> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">// -------------------------------------------------------------- Attributes</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * number of characters per line</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * - use get/setWidth methods instead.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Deprecated -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultWidth = DEFAULT_WIDTH; -<a class="jxr_linenumber" name="L111" href="#L111">111</a> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * amount of padding to the left of each line</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * - use get/setLeftPadding methods instead.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> @Deprecated -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultLeftPad = DEFAULT_LEFT_PAD; -<a class="jxr_linenumber" name="L120" href="#L120">120</a> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * the number of characters of padding to be prefixed</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * to each description line</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * - use get/setDescPadding methods instead.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> @Deprecated -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultDescPad = DEFAULT_DESC_PAD; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * the string to display at the beginning of the usage statement</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * - use get/setSyntaxPrefix methods instead.</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Deprecated -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> String defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX; -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * the new line string</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * - use get/setNewLine methods instead.</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> @Deprecated -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">public</strong> String defaultNewLine = System.getProperty(<span class="jxr_string">"line.separator"</span>); -<a class="jxr_linenumber" name="L148" href="#L148">148</a> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * the shortOpt prefix</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * - use get/setOptPrefix methods instead.</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> @Deprecated -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">public</strong> String defaultOptPrefix = DEFAULT_OPT_PREFIX; -<a class="jxr_linenumber" name="L157" href="#L157">157</a> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * the long Opt prefix</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * - use get/setLongOptPrefix methods instead.</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> @Deprecated -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> String defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX; -<a class="jxr_linenumber" name="L166" href="#L166">166</a> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * the name of the argument</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * - use get/setArgName methods instead.</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> @Deprecated -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">public</strong> String defaultArgName = DEFAULT_ARG_NAME; -<a class="jxr_linenumber" name="L175" href="#L175">175</a> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * Comparator used to sort the options when they output in help text</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical sorting by option key</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">protected</strong> Comparator<Option> optionComparator = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/cli/HelpFormatter.html">OptionComparator</a>(); -<a class="jxr_linenumber" name="L182" href="#L182">182</a> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment">/** The separator displayed between the long option and its value. */</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">private</strong> String longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR; -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Sets the 'width'.</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @param width the new value of 'width'</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWidth(<strong class="jxr_keyword">int</strong> width) -<a class="jxr_linenumber" name="L192" href="#L192">192</a> { -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">this</strong>.defaultWidth = width; -<a class="jxr_linenumber" name="L194" href="#L194">194</a> } -<a class="jxr_linenumber" name="L195" href="#L195">195</a> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * Returns the 'width'.</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @return the 'width'</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getWidth() -<a class="jxr_linenumber" name="L202" href="#L202">202</a> { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> defaultWidth; -<a class="jxr_linenumber" name="L204" href="#L204">204</a> } -<a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Sets the 'leftPadding'.</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @param padding the new value of 'leftPadding'</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLeftPadding(<strong class="jxr_keyword">int</strong> padding) -<a class="jxr_linenumber" name="L212" href="#L212">212</a> { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">this</strong>.defaultLeftPad = padding; -<a class="jxr_linenumber" name="L214" href="#L214">214</a> } -<a class="jxr_linenumber" name="L215" href="#L215">215</a> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Returns the 'leftPadding'.</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @return the 'leftPadding'</em> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getLeftPadding() -<a class="jxr_linenumber" name="L222" href="#L222">222</a> { -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">return</strong> defaultLeftPad; -<a class="jxr_linenumber" name="L224" href="#L224">224</a> } -<a class="jxr_linenumber" name="L225" href="#L225">225</a> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * Sets the 'descPadding'.</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @param padding the new value of 'descPadding'</em> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDescPadding(<strong class="jxr_keyword">int</strong> padding) -<a class="jxr_linenumber" name="L232" href="#L232">232</a> { -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">this</strong>.defaultDescPad = padding; -<a class="jxr_linenumber" name="L234" href="#L234">234</a> } -<a class="jxr_linenumber" name="L235" href="#L235">235</a> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * Returns the 'descPadding'.</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * @return the 'descPadding'</em> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getDescPadding() -<a class="jxr_linenumber" name="L242" href="#L242">242</a> { -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">return</strong> defaultDescPad; -<a class="jxr_linenumber" name="L244" href="#L244">244</a> } -<a class="jxr_linenumber" name="L245" href="#L245">245</a> -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * Sets the 'syntaxPrefix'.</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'syntaxPrefix'</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSyntaxPrefix(String prefix) -<a class="jxr_linenumber" name="L252" href="#L252">252</a> { -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">this</strong>.defaultSyntaxPrefix = prefix; -<a class="jxr_linenumber" name="L254" href="#L254">254</a> } -<a class="jxr_linenumber" name="L255" href="#L255">255</a> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * Returns the 'syntaxPrefix'.</em> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @return the 'syntaxPrefix'</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">public</strong> String getSyntaxPrefix() -<a class="jxr_linenumber" name="L262" href="#L262">262</a> { -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> defaultSyntaxPrefix; -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } -<a class="jxr_linenumber" name="L265" href="#L265">265</a> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Sets the 'newLine'.</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @param newline the new value of 'newLine'</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNewLine(String newline) -<a class="jxr_linenumber" name="L272" href="#L272">272</a> { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">this</strong>.defaultNewLine = newline; -<a class="jxr_linenumber" name="L274" href="#L274">274</a> } -<a class="jxr_linenumber" name="L275" href="#L275">275</a> -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * Returns the 'newLine'.</em> -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @return the 'newLine'</em> -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">public</strong> String getNewLine() -<a class="jxr_linenumber" name="L282" href="#L282">282</a> { -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">return</strong> defaultNewLine; -<a class="jxr_linenumber" name="L284" href="#L284">284</a> } -<a class="jxr_linenumber" name="L285" href="#L285">285</a> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * Sets the 'optPrefix'.</em> -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'optPrefix'</em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setOptPrefix(String prefix) -<a class="jxr_linenumber" name="L292" href="#L292">292</a> { -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">this</strong>.defaultOptPrefix = prefix; -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Returns the 'optPrefix'.</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @return the 'optPrefix'</em> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">public</strong> String getOptPrefix() -<a class="jxr_linenumber" name="L302" href="#L302">302</a> { -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">return</strong> defaultOptPrefix; -<a class="jxr_linenumber" name="L304" href="#L304">304</a> } -<a class="jxr_linenumber" name="L305" href="#L305">305</a> -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * Sets the 'longOptPrefix'.</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'longOptPrefix'</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLongOptPrefix(String prefix) -<a class="jxr_linenumber" name="L312" href="#L312">312</a> { -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">this</strong>.defaultLongOptPrefix = prefix; -<a class="jxr_linenumber" name="L314" href="#L314">314</a> } -<a class="jxr_linenumber" name="L315" href="#L315">315</a> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * Returns the 'longOptPrefix'.</em> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @return the 'longOptPrefix'</em> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">public</strong> String getLongOptPrefix() -<a class="jxr_linenumber" name="L322" href="#L322">322</a> { -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> defaultLongOptPrefix; -<a class="jxr_linenumber" name="L324" href="#L324">324</a> } -<a class="jxr_linenumber" name="L325" href="#L325">325</a> -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * Set the separator displayed between a long option and its value.</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * Ensure that the separator specified is supported by the parser used,</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * typically ' ' or '='.</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * @param longOptSeparator the separator, typically ' ' or '='.</em> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @since 1.3</em> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLongOptSeparator(String longOptSeparator) -<a class="jxr_linenumber" name="L335" href="#L335">335</a> { -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">this</strong>.longOptSeparator = longOptSeparator; -<a class="jxr_linenumber" name="L337" href="#L337">337</a> } -<a class="jxr_linenumber" name="L338" href="#L338">338</a> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * Returns the separator displayed between a long option and its value.</em> -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * @return the separator</em> -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * @since 1.3</em> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">public</strong> String getLongOptSeparator() -<a class="jxr_linenumber" name="L346" href="#L346">346</a> { -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">return</strong> longOptSeparator; -<a class="jxr_linenumber" name="L348" href="#L348">348</a> } -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * Sets the 'argName'.</em> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * @param name the new value of 'argName'</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setArgName(String name) -<a class="jxr_linenumber" name="L356" href="#L356">356</a> { -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">this</strong>.defaultArgName = name; -<a class="jxr_linenumber" name="L358" href="#L358">358</a> } -<a class="jxr_linenumber" name="L359" href="#L359">359</a> -<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * Returns the 'argName'.</em> -<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> * @return the 'argName'</em> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">public</strong> String getArgName() -<a class="jxr_linenumber" name="L366" href="#L366">366</a> { -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">return</strong> defaultArgName; -<a class="jxr_linenumber" name="L368" href="#L368">368</a> } -<a class="jxr_linenumber" name="L369" href="#L369">369</a> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * Comparator used to sort the options when they output in help text.</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical sorting by option key.</em> -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * @return the {@link Comparator} currently in use to sort the options</em> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * @since 1.2</em> -<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">public</strong> Comparator<Option> getOptionComparator() -<a class="jxr_linenumber" name="L378" href="#L378">378</a> { -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">return</strong> optionComparator; -<a class="jxr_linenumber" name="L380" href="#L380">380</a> } -<a class="jxr_linenumber" name="L381" href="#L381">381</a> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * Set the comparator used to sort the options when they output in help text.</em> -<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> * Passing in a null comparator will keep the options in the order they were declared.</em> -<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * @param comparator the {@link Comparator} to use for sorting the options</em> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * @since 1.2</em> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setOptionComparator(Comparator<Option> comparator) -<a class="jxr_linenumber" name="L390" href="#L390">390</a> { -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">this</strong>.optionComparator = comparator; -<a class="jxr_linenumber" name="L392" href="#L392">392</a> } -<a class="jxr_linenumber" name="L393" href="#L393">393</a> -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options) -<a class="jxr_linenumber" name="L403" href="#L403">403</a> { -<a class="jxr_linenumber" name="L404" href="#L404">404</a> printHelp(getWidth(), cmdLineSyntax, <strong class="jxr_keyword">null</strong>, options, <strong class="jxr_keyword">null</strong>, false); -<a class="jxr_linenumber" name="L405" href="#L405">405</a> } -<a class="jxr_linenumber" name="L406" href="#L406">406</a> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to </em> -<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * @param autoUsage whether to print an automatically generated</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * usage statement</em> -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, <strong class="jxr_keyword">boolean</strong> autoUsage) -<a class="jxr_linenumber" name="L418" href="#L418">418</a> { -<a class="jxr_linenumber" name="L419" href="#L419">419</a> printHelp(getWidth(), cmdLineSyntax, <strong class="jxr_keyword">null</strong>, options, <strong class="jxr_keyword">null</strong>, autoUsage); -<a class="jxr_linenumber" name="L420" href="#L420">420</a> } -<a class="jxr_linenumber" name="L421" href="#L421">421</a> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * @param header the banner to display at the beginning of the help</em> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * @param footer the banner to display at the end of the help</em> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, String header, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, String footer) -<a class="jxr_linenumber" name="L433" href="#L433">433</a> { -<a class="jxr_linenumber" name="L434" href="#L434">434</a> printHelp(cmdLineSyntax, header, options, footer, false); -<a class="jxr_linenumber" name="L435" href="#L435">435</a> } -<a class="jxr_linenumber" name="L436" href="#L436">436</a> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to </em> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * @param header the banner to display at the beginning of the help</em> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * @param footer the banner to display at the end of the help</em> -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> * @param autoUsage whether to print an automatically generated</em> -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> * usage statement</em> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, String header, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, String footer, <strong class="jxr_keyword">boolean</strong> autoUsage) -<a class="jxr_linenumber" name="L450" href="#L450">450</a> { -<a class="jxr_linenumber" name="L451" href="#L451">451</a> printHelp(getWidth(), cmdLineSyntax, header, options, footer, autoUsage); -<a class="jxr_linenumber" name="L452" href="#L452">452</a> } -<a class="jxr_linenumber" name="L453" href="#L453">453</a> -<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> -<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment"> * @param width the number of characters to be displayed on each line</em> -<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * @param header the banner to display at the beginning of the help</em> -<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * @param footer the banner to display at the end of the help</em> -<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(<strong class="jxr_keyword">int</strong> width, String cmdLineSyntax, String header, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, String footer) -<a class="jxr_linenumber" name="L466" href="#L466">466</a> { -<a class="jxr_linenumber" name="L467" href="#L467">467</a> printHelp(width, cmdLineSyntax, header, options, footer, false); -<a class="jxr_linenumber" name="L468" href="#L468">468</a> } -<a class="jxr_linenumber" name="L469" href="#L469">469</a> -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> -<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment"> * System.out.</em> -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment"> * @param width the number of characters to be displayed on each line</em> -<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> -<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * @param header the banner to display at the beginning of the help</em> -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> -<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> * @param footer the banner to display at the end of the help</em> -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * @param autoUsage whether to print an automatically generated </em> -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * usage statement</em> -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L483" href="#L483">483</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(<strong class="jxr_keyword">int</strong> width, String cmdLineSyntax, String header, -<a class="jxr_linenumber" name="L484" href="#L484">484</a> <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, String footer, <strong class="jxr_keyword">boolean</strong> autoUsage) -<a class="jxr_linenumber" name="L485" href="#L485">485</a> { -<a class="jxr_linenumber" name="L486" href="#L486">486</a> PrintWriter pw = <strong class="jxr_keyword">new</strong> PrintWriter(System.out); -<a class="jxr_linenumber" name="L487" href="#L487">487</a> -<a class="jxr_linenumber" name="L488" href="#L488">488</a> printHelp(pw, width, cmdLineSyntax, header, options, getLeftPadding(), getDescPadding(), footer, autoUsage); -<a class="jxr_linenumber" name="L489" href="#L489">489</a> pw.flush(); -<a class="jxr_linenumber" name="L490" href="#L490">490</a> } +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/** </em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * default separator displayed between a long Option and its value</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @since 1.3</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> **/</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_SEPARATOR = <span class="jxr_string">" "</span>; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/** default name for an argument */</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ARG_NAME = <span class="jxr_string">"arg"</span>; +<a class="jxr_linenumber" name="L104" href="#L104">104</a> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// -------------------------------------------------------------- Attributes</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * number of characters per line</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * - use get/setWidth methods instead.</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Deprecated +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultWidth = DEFAULT_WIDTH; +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * amount of padding to the left of each line</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * - use get/setLeftPadding methods instead.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Deprecated +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultLeftPad = DEFAULT_LEFT_PAD; +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * the number of characters of padding to be prefixed</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * to each description line</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * - use get/setDescPadding methods instead.</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Deprecated +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> defaultDescPad = DEFAULT_DESC_PAD; +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * the string to display at the beginning of the usage statement</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * - use get/setSyntaxPrefix methods instead.</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> @Deprecated +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> String defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * the new line string</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * - use get/setNewLine methods instead.</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Deprecated +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">public</strong> String defaultNewLine = System.getProperty(<span class="jxr_string">"line.separator"</span>); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * the shortOpt prefix</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * - use get/setOptPrefix methods instead.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> @Deprecated +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">public</strong> String defaultOptPrefix = DEFAULT_OPT_PREFIX; +<a class="jxr_linenumber" name="L161" href="#L161">161</a> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * the long Opt prefix</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * - use get/setLongOptPrefix methods instead.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Deprecated +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">public</strong> String defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX; +<a class="jxr_linenumber" name="L170" href="#L170">170</a> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * the name of the argument</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @deprecated Scope will be made private for next major version</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * - use get/setArgName methods instead.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> @Deprecated +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">public</strong> String defaultArgName = DEFAULT_ARG_NAME; +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * Comparator used to sort the options when they output in help text</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical sorting by option key</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">protected</strong> Comparator<Option> optionComparator = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/commons/cli/HelpFormatter.html">OptionComparator</a>(); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment">/** The separator displayed between the long option and its value. */</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">private</strong> String longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR; +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * Sets the 'width'.</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @param width the new value of 'width'</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWidth(<strong class="jxr_keyword">int</strong> width) +<a class="jxr_linenumber" name="L196" href="#L196">196</a> { +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">this</strong>.defaultWidth = width; +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * Returns the 'width'.</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @return the 'width'</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getWidth() +<a class="jxr_linenumber" name="L206" href="#L206">206</a> { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">return</strong> defaultWidth; +<a class="jxr_linenumber" name="L208" href="#L208">208</a> } +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * Sets the 'leftPadding'.</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @param padding the new value of 'leftPadding'</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLeftPadding(<strong class="jxr_keyword">int</strong> padding) +<a class="jxr_linenumber" name="L216" href="#L216">216</a> { +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">this</strong>.defaultLeftPad = padding; +<a class="jxr_linenumber" name="L218" href="#L218">218</a> } +<a class="jxr_linenumber" name="L219" href="#L219">219</a> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * Returns the 'leftPadding'.</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @return the 'leftPadding'</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getLeftPadding() +<a class="jxr_linenumber" name="L226" href="#L226">226</a> { +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">return</strong> defaultLeftPad; +<a class="jxr_linenumber" name="L228" href="#L228">228</a> } +<a class="jxr_linenumber" name="L229" href="#L229">229</a> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * Sets the 'descPadding'.</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param padding the new value of 'descPadding'</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDescPadding(<strong class="jxr_keyword">int</strong> padding) +<a class="jxr_linenumber" name="L236" href="#L236">236</a> { +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">this</strong>.defaultDescPad = padding; +<a class="jxr_linenumber" name="L238" href="#L238">238</a> } +<a class="jxr_linenumber" name="L239" href="#L239">239</a> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * Returns the 'descPadding'.</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @return the 'descPadding'</em> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getDescPadding() +<a class="jxr_linenumber" name="L246" href="#L246">246</a> { +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">return</strong> defaultDescPad; +<a class="jxr_linenumber" name="L248" href="#L248">248</a> } +<a class="jxr_linenumber" name="L249" href="#L249">249</a> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * Sets the 'syntaxPrefix'.</em> +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'syntaxPrefix'</em> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSyntaxPrefix(String prefix) +<a class="jxr_linenumber" name="L256" href="#L256">256</a> { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">this</strong>.defaultSyntaxPrefix = prefix; +<a class="jxr_linenumber" name="L258" href="#L258">258</a> } +<a class="jxr_linenumber" name="L259" href="#L259">259</a> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * Returns the 'syntaxPrefix'.</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @return the 'syntaxPrefix'</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">public</strong> String getSyntaxPrefix() +<a class="jxr_linenumber" name="L266" href="#L266">266</a> { +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">return</strong> defaultSyntaxPrefix; +<a class="jxr_linenumber" name="L268" href="#L268">268</a> } +<a class="jxr_linenumber" name="L269" href="#L269">269</a> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * Sets the 'newLine'.</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @param newline the new value of 'newLine'</em> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNewLine(String newline) +<a class="jxr_linenumber" name="L276" href="#L276">276</a> { +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">this</strong>.defaultNewLine = newline; +<a class="jxr_linenumber" name="L278" href="#L278">278</a> } +<a class="jxr_linenumber" name="L279" href="#L279">279</a> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * Returns the 'newLine'.</em> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * @return the 'newLine'</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">public</strong> String getNewLine() +<a class="jxr_linenumber" name="L286" href="#L286">286</a> { +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> defaultNewLine; +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * Sets the 'optPrefix'.</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'optPrefix'</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setOptPrefix(String prefix) +<a class="jxr_linenumber" name="L296" href="#L296">296</a> { +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">this</strong>.defaultOptPrefix = prefix; +<a class="jxr_linenumber" name="L298" href="#L298">298</a> } +<a class="jxr_linenumber" name="L299" href="#L299">299</a> +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * Returns the 'optPrefix'.</em> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @return the 'optPrefix'</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">public</strong> String getOptPrefix() +<a class="jxr_linenumber" name="L306" href="#L306">306</a> { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">return</strong> defaultOptPrefix; +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * Sets the 'longOptPrefix'.</em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * @param prefix the new value of 'longOptPrefix'</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLongOptPrefix(String prefix) +<a class="jxr_linenumber" name="L316" href="#L316">316</a> { +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">this</strong>.defaultLongOptPrefix = prefix; +<a class="jxr_linenumber" name="L318" href="#L318">318</a> } +<a class="jxr_linenumber" name="L319" href="#L319">319</a> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * Returns the 'longOptPrefix'.</em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @return the 'longOptPrefix'</em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">public</strong> String getLongOptPrefix() +<a class="jxr_linenumber" name="L326" href="#L326">326</a> { +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">return</strong> defaultLongOptPrefix; +<a class="jxr_linenumber" name="L328" href="#L328">328</a> } +<a class="jxr_linenumber" name="L329" href="#L329">329</a> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * Set the separator displayed between a long option and its value.</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * Ensure that the separator specified is supported by the parser used,</em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * typically ' ' or '='.</em> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @param longOptSeparator the separator, typically ' ' or '='.</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @since 1.3</em> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLongOptSeparator(String longOptSeparator) +<a class="jxr_linenumber" name="L339" href="#L339">339</a> { +<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">this</strong>.longOptSeparator = longOptSeparator; +<a class="jxr_linenumber" name="L341" href="#L341">341</a> } +<a class="jxr_linenumber" name="L342" href="#L342">342</a> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * Returns the separator displayed between a long option and its value.</em> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @return the separator</em> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @since 1.3</em> +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">public</strong> String getLongOptSeparator() +<a class="jxr_linenumber" name="L350" href="#L350">350</a> { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">return</strong> longOptSeparator; +<a class="jxr_linenumber" name="L352" href="#L352">352</a> } +<a class="jxr_linenumber" name="L353" href="#L353">353</a> +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * Sets the 'argName'.</em> +<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @param name the new value of 'argName'</em> +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setArgName(String name) +<a class="jxr_linenumber" name="L360" href="#L360">360</a> { +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">this</strong>.defaultArgName = name; +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } +<a class="jxr_linenumber" name="L363" href="#L363">363</a> +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * Returns the 'argName'.</em> +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * @return the 'argName'</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">public</strong> String getArgName() +<a class="jxr_linenumber" name="L370" href="#L370">370</a> { +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">return</strong> defaultArgName; +<a class="jxr_linenumber" name="L372" href="#L372">372</a> } +<a class="jxr_linenumber" name="L373" href="#L373">373</a> +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * Comparator used to sort the options when they output in help text.</em> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical sorting by option key.</em> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * @return the {@link Comparator} currently in use to sort the options</em> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * @since 1.2</em> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">public</strong> Comparator<Option> getOptionComparator() +<a class="jxr_linenumber" name="L382" href="#L382">382</a> { +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">return</strong> optionComparator; +<a class="jxr_linenumber" name="L384" href="#L384">384</a> } +<a class="jxr_linenumber" name="L385" href="#L385">385</a> +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * Set the comparator used to sort the options when they output in help text.</em> +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * Passing in a null comparator will keep the options in the order they were declared.</em> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * @param comparator the {@link Comparator} to use for sorting the options</em> +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @since 1.2</em> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setOptionComparator(Comparator<Option> comparator) +<a class="jxr_linenumber" name="L394" href="#L394">394</a> { +<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">this</strong>.optionComparator = comparator; +<a class="jxr_linenumber" name="L396" href="#L396">396</a> } +<a class="jxr_linenumber" name="L397" href="#L397">397</a> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * System.out.</em> +<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> +<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options) +<a class="jxr_linenumber" name="L407" href="#L407">407</a> { +<a class="jxr_linenumber" name="L408" href="#L408">408</a> printHelp(getWidth(), cmdLineSyntax, <strong class="jxr_keyword">null</strong>, options, <strong class="jxr_keyword">null</strong>, false); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> } +<a class="jxr_linenumber" name="L410" href="#L410">410</a> +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to </em> +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * System.out.</em> +<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em> +<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * @param options the Options instance</em> +<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * @param autoUsage whether to print an automatically generated</em> +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * usage statement</em> +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printHelp(String cmdLineSyntax, <a href="../../../../org/apache/commons/cli/Options.html">Options</a> options, <strong class="jxr_keyword">boolean</strong> autoUsage) +<a class="jxr_linenumber" name="L422" href="#L422">422</a> { +<a class="jxr_linenumber" name="L423" href="#L423">423</a> printHelp(getWidth(), cmdLineSyntax, <strong class="jxr_keyword">null</strong>, options, <strong class="jxr_keyword">null</strong>, autoUsage); +<a class="jxr_linenumber" name="L424" href="#L424">424</a> } +<a class="jxr_linenumber" name="L425" href="#L425">425</a> +<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * Print the help for <code>options</code> with the specified</em> +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * command line syntax. This method prints help information to</em> +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * System.out.</em> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * @param cmdLineSyntax the syntax for this application</em>
[... 1246 lines stripped ...]
