Modified: websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/HelpFormatter.html ============================================================================== --- websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/HelpFormatter.html (original) +++ websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/HelpFormatter.html Sat May 9 18:19:15 2015 @@ -66,17 +66,17 @@ <span class="sourceLineNo">058</span> * This produces the following output:<a name="line.58"></a> <span class="sourceLineNo">059</span> * <a name="line.59"></a> <span class="sourceLineNo">060</span> * <pre><a name="line.60"></a> -<span class="sourceLineNo">061</span> * usage: myapp -f <FILE> [-h] [-v]<a name="line.61"></a> +<span class="sourceLineNo">061</span> * usage: myapp -f &lt;FILE&gt; [-h] [-v]<a name="line.61"></a> <span class="sourceLineNo">062</span> * Do something useful with an input file<a name="line.62"></a> <span class="sourceLineNo">063</span> * <a name="line.63"></a> -<span class="sourceLineNo">064</span> * -f,--file &lt;FILE> The file to be processed<a name="line.64"></a> +<span class="sourceLineNo">064</span> * -f,--file &lt;FILE&gt; The file to be processed<a name="line.64"></a> <span class="sourceLineNo">065</span> * -h,--help<a name="line.65"></a> <span class="sourceLineNo">066</span> * -v,--version Print the version of the application<a name="line.66"></a> <span class="sourceLineNo">067</span> * <a name="line.67"></a> <span class="sourceLineNo">068</span> * Please report issues at http://example.com/issues<a name="line.68"></a> <span class="sourceLineNo">069</span> * </pre><a name="line.69"></a> <span class="sourceLineNo">070</span> * <a name="line.70"></a> -<span class="sourceLineNo">071</span> * @version $Id: HelpFormatter.java 1444961 2013-02-11 21:03:51Z tn $<a name="line.71"></a> +<span class="sourceLineNo">071</span> * @version $Id: HelpFormatter.java 1677407 2015-05-03 14:31:12Z britter $<a name="line.71"></a> <span class="sourceLineNo">072</span> */<a name="line.72"></a> <span class="sourceLineNo">073</span>public class HelpFormatter<a name="line.73"></a> <span class="sourceLineNo">074</span>{<a name="line.74"></a> @@ -100,1002 +100,1006 @@ <span class="sourceLineNo">092</span> /** default prefix for long Option */<a name="line.92"></a> <span class="sourceLineNo">093</span> public static final String DEFAULT_LONG_OPT_PREFIX = "--";<a name="line.93"></a> <span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> /** default separator displayed between a long Option and its value */<a name="line.95"></a> -<span class="sourceLineNo">096</span> public static final String DEFAULT_LONG_OPT_SEPARATOR = " ";<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /** default name for an argument */<a name="line.98"></a> -<span class="sourceLineNo">099</span> public static final String DEFAULT_ARG_NAME = "arg";<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> // -------------------------------------------------------------- Attributes<a name="line.101"></a> -<span class="sourceLineNo">102</span><a name="line.102"></a> -<span class="sourceLineNo">103</span> /**<a name="line.103"></a> -<span class="sourceLineNo">104</span> * number of characters per line<a name="line.104"></a> -<span class="sourceLineNo">105</span> *<a name="line.105"></a> -<span class="sourceLineNo">106</span> * @deprecated Scope will be made private for next major version<a name="line.106"></a> -<span class="sourceLineNo">107</span> * - use get/setWidth methods instead.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> @Deprecated<a name="line.109"></a> -<span class="sourceLineNo">110</span> public int defaultWidth = DEFAULT_WIDTH;<a name="line.110"></a> -<span class="sourceLineNo">111</span><a name="line.111"></a> -<span class="sourceLineNo">112</span> /**<a name="line.112"></a> -<span class="sourceLineNo">113</span> * amount of padding to the left of each line<a name="line.113"></a> -<span class="sourceLineNo">114</span> *<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @deprecated Scope will be made private for next major version<a name="line.115"></a> -<span class="sourceLineNo">116</span> * - use get/setLeftPadding methods instead.<a name="line.116"></a> -<span class="sourceLineNo">117</span> */<a name="line.117"></a> -<span class="sourceLineNo">118</span> @Deprecated<a name="line.118"></a> -<span class="sourceLineNo">119</span> public int defaultLeftPad = DEFAULT_LEFT_PAD;<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * the number of characters of padding to be prefixed<a name="line.122"></a> -<span class="sourceLineNo">123</span> * to each description line<a name="line.123"></a> -<span class="sourceLineNo">124</span> *<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @deprecated Scope will be made private for next major version<a name="line.125"></a> -<span class="sourceLineNo">126</span> * - use get/setDescPadding methods instead.<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> @Deprecated<a name="line.128"></a> -<span class="sourceLineNo">129</span> public int defaultDescPad = DEFAULT_DESC_PAD;<a name="line.129"></a> -<span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> /**<a name="line.131"></a> -<span class="sourceLineNo">132</span> * the string to display at the beginning of the usage statement<a name="line.132"></a> -<span class="sourceLineNo">133</span> *<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @deprecated Scope will be made private for next major version<a name="line.134"></a> -<span class="sourceLineNo">135</span> * - use get/setSyntaxPrefix methods instead.<a name="line.135"></a> -<span class="sourceLineNo">136</span> */<a name="line.136"></a> -<span class="sourceLineNo">137</span> @Deprecated<a name="line.137"></a> -<span class="sourceLineNo">138</span> public String defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX;<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> /**<a name="line.140"></a> -<span class="sourceLineNo">141</span> * the new line string<a name="line.141"></a> -<span class="sourceLineNo">142</span> *<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @deprecated Scope will be made private for next major version<a name="line.143"></a> -<span class="sourceLineNo">144</span> * - use get/setNewLine methods instead.<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> @Deprecated<a name="line.146"></a> -<span class="sourceLineNo">147</span> public String defaultNewLine = System.getProperty("line.separator");<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> /**<a name="line.149"></a> -<span class="sourceLineNo">150</span> * the shortOpt prefix<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @deprecated Scope will be made private for next major version<a name="line.152"></a> -<span class="sourceLineNo">153</span> * - use get/setOptPrefix methods instead.<a name="line.153"></a> -<span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> @Deprecated<a name="line.155"></a> -<span class="sourceLineNo">156</span> public String defaultOptPrefix = DEFAULT_OPT_PREFIX;<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> /**<a name="line.158"></a> -<span class="sourceLineNo">159</span> * the long Opt prefix<a name="line.159"></a> -<span class="sourceLineNo">160</span> *<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @deprecated Scope will be made private for next major version<a name="line.161"></a> -<span class="sourceLineNo">162</span> * - use get/setLongOptPrefix methods instead.<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> @Deprecated<a name="line.164"></a> -<span class="sourceLineNo">165</span> public String defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX;<a name="line.165"></a> -<span class="sourceLineNo">166</span><a name="line.166"></a> -<span class="sourceLineNo">167</span> /**<a name="line.167"></a> -<span class="sourceLineNo">168</span> * the name of the argument<a name="line.168"></a> -<span class="sourceLineNo">169</span> *<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @deprecated Scope will be made private for next major version<a name="line.170"></a> -<span class="sourceLineNo">171</span> * - use get/setArgName methods instead.<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> @Deprecated<a name="line.173"></a> -<span class="sourceLineNo">174</span> public String defaultArgName = DEFAULT_ARG_NAME;<a name="line.174"></a> -<span class="sourceLineNo">175</span><a name="line.175"></a> -<span class="sourceLineNo">176</span> /**<a name="line.176"></a> -<span class="sourceLineNo">177</span> * Comparator used to sort the options when they output in help text<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <a name="line.178"></a> -<span class="sourceLineNo">179</span> * Defaults to case-insensitive alphabetical sorting by option key<a name="line.179"></a> -<span class="sourceLineNo">180</span> */<a name="line.180"></a> -<span class="sourceLineNo">181</span> protected Comparator<Option> optionComparator = new OptionComparator();<a name="line.181"></a> -<span class="sourceLineNo">182</span><a name="line.182"></a> -<span class="sourceLineNo">183</span> /** The separator displayed between the long option and its value. */<a name="line.183"></a> -<span class="sourceLineNo">184</span> private String longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR;<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Sets the 'width'.<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @param width the new value of 'width'<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public void setWidth(int width)<a name="line.191"></a> -<span class="sourceLineNo">192</span> {<a name="line.192"></a> -<span class="sourceLineNo">193</span> this.defaultWidth = width;<a name="line.193"></a> -<span class="sourceLineNo">194</span> }<a name="line.194"></a> -<span class="sourceLineNo">195</span><a name="line.195"></a> -<span class="sourceLineNo">196</span> /**<a name="line.196"></a> -<span class="sourceLineNo">197</span> * Returns the 'width'.<a name="line.197"></a> -<span class="sourceLineNo">198</span> *<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return the 'width'<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> public int getWidth()<a name="line.201"></a> -<span class="sourceLineNo">202</span> {<a name="line.202"></a> -<span class="sourceLineNo">203</span> return defaultWidth;<a name="line.203"></a> -<span class="sourceLineNo">204</span> }<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /**<a name="line.206"></a> -<span class="sourceLineNo">207</span> * Sets the 'leftPadding'.<a name="line.207"></a> -<span class="sourceLineNo">208</span> *<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @param padding the new value of 'leftPadding'<a name="line.209"></a> -<span class="sourceLineNo">210</span> */<a name="line.210"></a> -<span class="sourceLineNo">211</span> public void setLeftPadding(int padding)<a name="line.211"></a> -<span class="sourceLineNo">212</span> {<a name="line.212"></a> -<span class="sourceLineNo">213</span> this.defaultLeftPad = padding;<a name="line.213"></a> -<span class="sourceLineNo">214</span> }<a name="line.214"></a> -<span class="sourceLineNo">215</span><a name="line.215"></a> -<span class="sourceLineNo">216</span> /**<a name="line.216"></a> -<span class="sourceLineNo">217</span> * Returns the 'leftPadding'.<a name="line.217"></a> -<span class="sourceLineNo">218</span> *<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @return the 'leftPadding'<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> public int getLeftPadding()<a name="line.221"></a> -<span class="sourceLineNo">222</span> {<a name="line.222"></a> -<span class="sourceLineNo">223</span> return defaultLeftPad;<a name="line.223"></a> -<span class="sourceLineNo">224</span> }<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Sets the 'descPadding'.<a name="line.227"></a> -<span class="sourceLineNo">228</span> *<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @param padding the new value of 'descPadding'<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> public void setDescPadding(int padding)<a name="line.231"></a> -<span class="sourceLineNo">232</span> {<a name="line.232"></a> -<span class="sourceLineNo">233</span> this.defaultDescPad = padding;<a name="line.233"></a> -<span class="sourceLineNo">234</span> }<a name="line.234"></a> -<span class="sourceLineNo">235</span><a name="line.235"></a> -<span class="sourceLineNo">236</span> /**<a name="line.236"></a> -<span class="sourceLineNo">237</span> * Returns the 'descPadding'.<a name="line.237"></a> -<span class="sourceLineNo">238</span> *<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @return the 'descPadding'<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> public int getDescPadding()<a name="line.241"></a> -<span class="sourceLineNo">242</span> {<a name="line.242"></a> -<span class="sourceLineNo">243</span> return defaultDescPad;<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Sets the 'syntaxPrefix'.<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @param prefix the new value of 'syntaxPrefix'<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> public void setSyntaxPrefix(String prefix)<a name="line.251"></a> -<span class="sourceLineNo">252</span> {<a name="line.252"></a> -<span class="sourceLineNo">253</span> this.defaultSyntaxPrefix = prefix;<a name="line.253"></a> -<span class="sourceLineNo">254</span> }<a name="line.254"></a> -<span class="sourceLineNo">255</span><a name="line.255"></a> -<span class="sourceLineNo">256</span> /**<a name="line.256"></a> -<span class="sourceLineNo">257</span> * Returns the 'syntaxPrefix'.<a name="line.257"></a> -<span class="sourceLineNo">258</span> *<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @return the 'syntaxPrefix'<a name="line.259"></a> -<span class="sourceLineNo">260</span> */<a name="line.260"></a> -<span class="sourceLineNo">261</span> public String getSyntaxPrefix()<a name="line.261"></a> -<span class="sourceLineNo">262</span> {<a name="line.262"></a> -<span class="sourceLineNo">263</span> return defaultSyntaxPrefix;<a name="line.263"></a> -<span class="sourceLineNo">264</span> }<a name="line.264"></a> -<span class="sourceLineNo">265</span><a name="line.265"></a> -<span class="sourceLineNo">266</span> /**<a name="line.266"></a> -<span class="sourceLineNo">267</span> * Sets the 'newLine'.<a name="line.267"></a> -<span class="sourceLineNo">268</span> *<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @param newline the new value of 'newLine'<a name="line.269"></a> -<span class="sourceLineNo">270</span> */<a name="line.270"></a> -<span class="sourceLineNo">271</span> public void setNewLine(String newline)<a name="line.271"></a> -<span class="sourceLineNo">272</span> {<a name="line.272"></a> -<span class="sourceLineNo">273</span> this.defaultNewLine = newline;<a name="line.273"></a> -<span class="sourceLineNo">274</span> }<a name="line.274"></a> -<span class="sourceLineNo">275</span><a name="line.275"></a> -<span class="sourceLineNo">276</span> /**<a name="line.276"></a> -<span class="sourceLineNo">277</span> * Returns the 'newLine'.<a name="line.277"></a> -<span class="sourceLineNo">278</span> *<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @return the 'newLine'<a name="line.279"></a> -<span class="sourceLineNo">280</span> */<a name="line.280"></a> -<span class="sourceLineNo">281</span> public String getNewLine()<a name="line.281"></a> -<span class="sourceLineNo">282</span> {<a name="line.282"></a> -<span class="sourceLineNo">283</span> return defaultNewLine;<a name="line.283"></a> -<span class="sourceLineNo">284</span> }<a name="line.284"></a> -<span class="sourceLineNo">285</span><a name="line.285"></a> -<span class="sourceLineNo">286</span> /**<a name="line.286"></a> -<span class="sourceLineNo">287</span> * Sets the 'optPrefix'.<a name="line.287"></a> -<span class="sourceLineNo">288</span> *<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @param prefix the new value of 'optPrefix'<a name="line.289"></a> -<span class="sourceLineNo">290</span> */<a name="line.290"></a> -<span class="sourceLineNo">291</span> public void setOptPrefix(String prefix)<a name="line.291"></a> -<span class="sourceLineNo">292</span> {<a name="line.292"></a> -<span class="sourceLineNo">293</span> this.defaultOptPrefix = prefix;<a name="line.293"></a> -<span class="sourceLineNo">294</span> }<a name="line.294"></a> -<span class="sourceLineNo">295</span><a name="line.295"></a> -<span class="sourceLineNo">296</span> /**<a name="line.296"></a> -<span class="sourceLineNo">297</span> * Returns the 'optPrefix'.<a name="line.297"></a> -<span class="sourceLineNo">298</span> *<a name="line.298"></a> -<span class="sourceLineNo">299</span> * @return the 'optPrefix'<a name="line.299"></a> -<span class="sourceLineNo">300</span> */<a name="line.300"></a> -<span class="sourceLineNo">301</span> public String getOptPrefix()<a name="line.301"></a> -<span class="sourceLineNo">302</span> {<a name="line.302"></a> -<span class="sourceLineNo">303</span> return defaultOptPrefix;<a name="line.303"></a> -<span class="sourceLineNo">304</span> }<a name="line.304"></a> -<span class="sourceLineNo">305</span><a name="line.305"></a> -<span class="sourceLineNo">306</span> /**<a name="line.306"></a> -<span class="sourceLineNo">307</span> * Sets the 'longOptPrefix'.<a name="line.307"></a> -<span class="sourceLineNo">308</span> *<a name="line.308"></a> -<span class="sourceLineNo">309</span> * @param prefix the new value of 'longOptPrefix'<a name="line.309"></a> -<span class="sourceLineNo">310</span> */<a name="line.310"></a> -<span class="sourceLineNo">311</span> public void setLongOptPrefix(String prefix)<a name="line.311"></a> -<span class="sourceLineNo">312</span> {<a name="line.312"></a> -<span class="sourceLineNo">313</span> this.defaultLongOptPrefix = prefix;<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span><a name="line.315"></a> -<span class="sourceLineNo">316</span> /**<a name="line.316"></a> -<span class="sourceLineNo">317</span> * Returns the 'longOptPrefix'.<a name="line.317"></a> -<span class="sourceLineNo">318</span> *<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @return the 'longOptPrefix'<a name="line.319"></a> -<span class="sourceLineNo">320</span> */<a name="line.320"></a> -<span class="sourceLineNo">321</span> public String getLongOptPrefix()<a name="line.321"></a> -<span class="sourceLineNo">322</span> {<a name="line.322"></a> -<span class="sourceLineNo">323</span> return defaultLongOptPrefix;<a name="line.323"></a> -<span class="sourceLineNo">324</span> }<a name="line.324"></a> -<span class="sourceLineNo">325</span><a name="line.325"></a> -<span class="sourceLineNo">326</span> /**<a name="line.326"></a> -<span class="sourceLineNo">327</span> * Set the separator displayed between a long option and its value.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * Ensure that the separator specified is supported by the parser used,<a name="line.328"></a> -<span class="sourceLineNo">329</span> * typically ' ' or '='.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * <a name="line.330"></a> -<span class="sourceLineNo">331</span> * @param longOptSeparator the separator, typically ' ' or '='.<a name="line.331"></a> -<span class="sourceLineNo">332</span> * @since 1.3<a name="line.332"></a> -<span class="sourceLineNo">333</span> */<a name="line.333"></a> -<span class="sourceLineNo">334</span> public void setLongOptSeparator(String longOptSeparator)<a name="line.334"></a> -<span class="sourceLineNo">335</span> {<a name="line.335"></a> -<span class="sourceLineNo">336</span> this.longOptSeparator = longOptSeparator;<a name="line.336"></a> -<span class="sourceLineNo">337</span> }<a name="line.337"></a> -<span class="sourceLineNo">338</span><a name="line.338"></a> -<span class="sourceLineNo">339</span> /**<a name="line.339"></a> -<span class="sourceLineNo">340</span> * Returns the separator displayed between a long option and its value.<a name="line.340"></a> -<span class="sourceLineNo">341</span> * <a name="line.341"></a> -<span class="sourceLineNo">342</span> * @return the separator<a name="line.342"></a> -<span class="sourceLineNo">343</span> * @since 1.3<a name="line.343"></a> -<span class="sourceLineNo">344</span> */<a name="line.344"></a> -<span class="sourceLineNo">345</span> public String getLongOptSeparator()<a name="line.345"></a> -<span class="sourceLineNo">346</span> {<a name="line.346"></a> -<span class="sourceLineNo">347</span> return longOptSeparator;<a name="line.347"></a> -<span class="sourceLineNo">348</span> }<a name="line.348"></a> -<span class="sourceLineNo">349</span><a name="line.349"></a> -<span class="sourceLineNo">350</span> /**<a name="line.350"></a> -<span class="sourceLineNo">351</span> * Sets the 'argName'.<a name="line.351"></a> -<span class="sourceLineNo">352</span> *<a name="line.352"></a> -<span class="sourceLineNo">353</span> * @param name the new value of 'argName'<a name="line.353"></a> -<span class="sourceLineNo">354</span> */<a name="line.354"></a> -<span class="sourceLineNo">355</span> public void setArgName(String name)<a name="line.355"></a> -<span class="sourceLineNo">356</span> {<a name="line.356"></a> -<span class="sourceLineNo">357</span> this.defaultArgName = name;<a name="line.357"></a> -<span class="sourceLineNo">358</span> }<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> /**<a name="line.360"></a> -<span class="sourceLineNo">361</span> * Returns the 'argName'.<a name="line.361"></a> -<span class="sourceLineNo">362</span> *<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @return the 'argName'<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> public String getArgName()<a name="line.365"></a> -<span class="sourceLineNo">366</span> {<a name="line.366"></a> -<span class="sourceLineNo">367</span> return defaultArgName;<a name="line.367"></a> -<span class="sourceLineNo">368</span> }<a name="line.368"></a> -<span class="sourceLineNo">369</span><a name="line.369"></a> -<span class="sourceLineNo">370</span> /**<a name="line.370"></a> -<span class="sourceLineNo">371</span> * Comparator used to sort the options when they output in help text.<a name="line.371"></a> -<span class="sourceLineNo">372</span> * Defaults to case-insensitive alphabetical sorting by option key.<a name="line.372"></a> -<span class="sourceLineNo">373</span> *<a name="line.373"></a> -<span class="sourceLineNo">374</span> * @return the {@link Comparator} currently in use to sort the options<a name="line.374"></a> -<span class="sourceLineNo">375</span> * @since 1.2<a name="line.375"></a> -<span class="sourceLineNo">376</span> */<a name="line.376"></a> -<span class="sourceLineNo">377</span> public Comparator<Option> getOptionComparator()<a name="line.377"></a> -<span class="sourceLineNo">378</span> {<a name="line.378"></a> -<span class="sourceLineNo">379</span> return optionComparator;<a name="line.379"></a> -<span class="sourceLineNo">380</span> }<a name="line.380"></a> -<span class="sourceLineNo">381</span><a name="line.381"></a> -<span class="sourceLineNo">382</span> /**<a name="line.382"></a> -<span class="sourceLineNo">383</span> * Set the comparator used to sort the options when they output in help text.<a name="line.383"></a> -<span class="sourceLineNo">384</span> * Passing in a null comparator will keep the options in the order they were declared.<a name="line.384"></a> -<span class="sourceLineNo">385</span> *<a name="line.385"></a> -<span class="sourceLineNo">386</span> * @param comparator the {@link Comparator} to use for sorting the options<a name="line.386"></a> -<span class="sourceLineNo">387</span> * @since 1.2<a name="line.387"></a> -<span class="sourceLineNo">388</span> */<a name="line.388"></a> -<span class="sourceLineNo">389</span> public void setOptionComparator(Comparator<Option> comparator)<a name="line.389"></a> -<span class="sourceLineNo">390</span> {<a name="line.390"></a> -<span class="sourceLineNo">391</span> this.optionComparator = comparator;<a name="line.391"></a> -<span class="sourceLineNo">392</span> }<a name="line.392"></a> -<span class="sourceLineNo">393</span><a name="line.393"></a> -<span class="sourceLineNo">394</span> /**<a name="line.394"></a> -<span class="sourceLineNo">395</span> * Print the help for <code>options</code> with the specified<a name="line.395"></a> -<span class="sourceLineNo">396</span> * command line syntax. This method prints help information to<a name="line.396"></a> -<span class="sourceLineNo">397</span> * System.out.<a name="line.397"></a> -<span class="sourceLineNo">398</span> *<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @param cmdLineSyntax the syntax for this application<a name="line.399"></a> -<span class="sourceLineNo">400</span> * @param options the Options instance<a name="line.400"></a> -<span class="sourceLineNo">401</span> */<a name="line.401"></a> -<span class="sourceLineNo">402</span> public void printHelp(String cmdLineSyntax, Options options)<a name="line.402"></a> -<span class="sourceLineNo">403</span> {<a name="line.403"></a> -<span class="sourceLineNo">404</span> printHelp(getWidth(), cmdLineSyntax, null, options, null, false);<a name="line.404"></a> -<span class="sourceLineNo">405</span> }<a name="line.405"></a> -<span class="sourceLineNo">406</span><a name="line.406"></a> -<span class="sourceLineNo">407</span> /**<a name="line.407"></a> -<span class="sourceLineNo">408</span> * Print the help for <code>options</code> with the specified<a name="line.408"></a> -<span class="sourceLineNo">409</span> * command line syntax. This method prints help information to <a name="line.409"></a> -<span class="sourceLineNo">410</span> * System.out.<a name="line.410"></a> -<span class="sourceLineNo">411</span> *<a name="line.411"></a> -<span class="sourceLineNo">412</span> * @param cmdLineSyntax the syntax for this application<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param options the Options instance<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @param autoUsage whether to print an automatically generated<a name="line.414"></a> -<span class="sourceLineNo">415</span> * usage statement<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> public void printHelp(String cmdLineSyntax, Options options, boolean autoUsage)<a name="line.417"></a> -<span class="sourceLineNo">418</span> {<a name="line.418"></a> -<span class="sourceLineNo">419</span> printHelp(getWidth(), cmdLineSyntax, null, options, null, autoUsage);<a name="line.419"></a> -<span class="sourceLineNo">420</span> }<a name="line.420"></a> -<span class="sourceLineNo">421</span><a name="line.421"></a> -<span class="sourceLineNo">422</span> /**<a name="line.422"></a> -<span class="sourceLineNo">423</span> * Print the help for <code>options</code> with the specified<a name="line.423"></a> -<span class="sourceLineNo">424</span> * command line syntax. This method prints help information to<a name="line.424"></a> -<span class="sourceLineNo">425</span> * System.out.<a name="line.425"></a> -<span class="sourceLineNo">426</span> *<a name="line.426"></a> -<span class="sourceLineNo">427</span> * @param cmdLineSyntax the syntax for this application<a name="line.427"></a> -<span class="sourceLineNo">428</span> * @param header the banner to display at the beginning of the help<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @param options the Options instance<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param footer the banner to display at the end of the help<a name="line.430"></a> -<span class="sourceLineNo">431</span> */<a name="line.431"></a> -<span class="sourceLineNo">432</span> public void printHelp(String cmdLineSyntax, String header, Options options, String footer)<a name="line.432"></a> -<span class="sourceLineNo">433</span> {<a name="line.433"></a> -<span class="sourceLineNo">434</span> printHelp(cmdLineSyntax, header, options, footer, false);<a name="line.434"></a> -<span class="sourceLineNo">435</span> }<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Print the help for <code>options</code> with the specified<a name="line.438"></a> -<span class="sourceLineNo">439</span> * command line syntax. This method prints help information to <a name="line.439"></a> -<span class="sourceLineNo">440</span> * System.out.<a name="line.440"></a> -<span class="sourceLineNo">441</span> *<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @param cmdLineSyntax the syntax for this application<a name="line.442"></a> -<span class="sourceLineNo">443</span> * @param header the banner to display at the beginning of the help<a name="line.443"></a> -<span class="sourceLineNo">444</span> * @param options the Options instance<a name="line.444"></a> -<span class="sourceLineNo">445</span> * @param footer the banner to display at the end of the help<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @param autoUsage whether to print an automatically generated<a name="line.446"></a> -<span class="sourceLineNo">447</span> * usage statement<a name="line.447"></a> -<span class="sourceLineNo">448</span> */<a name="line.448"></a> -<span class="sourceLineNo">449</span> public void printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage)<a name="line.449"></a> -<span class="sourceLineNo">450</span> {<a name="line.450"></a> -<span class="sourceLineNo">451</span> printHelp(getWidth(), cmdLineSyntax, header, options, footer, autoUsage);<a name="line.451"></a> -<span class="sourceLineNo">452</span> }<a name="line.452"></a> -<span class="sourceLineNo">453</span><a name="line.453"></a> -<span class="sourceLineNo">454</span> /**<a name="line.454"></a> -<span class="sourceLineNo">455</span> * Print the help for <code>options</code> with the specified<a name="line.455"></a> -<span class="sourceLineNo">456</span> * command line syntax. This method prints help information to<a name="line.456"></a> -<span class="sourceLineNo">457</span> * System.out.<a name="line.457"></a> -<span class="sourceLineNo">458</span> *<a name="line.458"></a> -<span class="sourceLineNo">459</span> * @param width the number of characters to be displayed on each line<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param cmdLineSyntax the syntax for this application<a name="line.460"></a> -<span class="sourceLineNo">461</span> * @param header the banner to display at the beginning of the help<a name="line.461"></a> -<span class="sourceLineNo">462</span> * @param options the Options instance<a name="line.462"></a> -<span class="sourceLineNo">463</span> * @param footer the banner to display at the end of the help<a name="line.463"></a> -<span class="sourceLineNo">464</span> */<a name="line.464"></a> -<span class="sourceLineNo">465</span> public void printHelp(int width, String cmdLineSyntax, String header, Options options, String footer)<a name="line.465"></a> -<span class="sourceLineNo">466</span> {<a name="line.466"></a> -<span class="sourceLineNo">467</span> printHelp(width, cmdLineSyntax, header, options, footer, false);<a name="line.467"></a> -<span class="sourceLineNo">468</span> }<a name="line.468"></a> -<span class="sourceLineNo">469</span><a name="line.469"></a> -<span class="sourceLineNo">470</span> /**<a name="line.470"></a> -<span class="sourceLineNo">471</span> * Print the help for <code>options</code> with the specified<a name="line.471"></a> -<span class="sourceLineNo">472</span> * command line syntax. This method prints help information to<a name="line.472"></a> -<span class="sourceLineNo">473</span> * System.out.<a name="line.473"></a> -<span class="sourceLineNo">474</span> *<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @param width the number of characters to be displayed on each line<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @param cmdLineSyntax the syntax for this application<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @param header the banner to display at the beginning of the help<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param options the Options instance<a name="line.478"></a> -<span class="sourceLineNo">479</span> * @param footer the banner to display at the end of the help<a name="line.479"></a> -<span class="sourceLineNo">480</span> * @param autoUsage whether to print an automatically generated <a name="line.480"></a> -<span class="sourceLineNo">481</span> * usage statement<a name="line.481"></a> -<span class="sourceLineNo">482</span> */<a name="line.482"></a> -<span class="sourceLineNo">483</span> public void printHelp(int width, String cmdLineSyntax, String header,<a name="line.483"></a> -<span class="sourceLineNo">484</span> Options options, String footer, boolean autoUsage)<a name="line.484"></a> -<span class="sourceLineNo">485</span> {<a name="line.485"></a> -<span class="sourceLineNo">486</span> PrintWriter pw = new PrintWriter(System.out);<a name="line.486"></a> -<span class="sourceLineNo">487</span><a name="line.487"></a> -<span class="sourceLineNo">488</span> printHelp(pw, width, cmdLineSyntax, header, options, getLeftPadding(), getDescPadding(), footer, autoUsage);<a name="line.488"></a> -<span class="sourceLineNo">489</span> pw.flush();<a name="line.489"></a> -<span class="sourceLineNo">490</span> }<a name="line.490"></a> +<span class="sourceLineNo">095</span> /** <a name="line.95"></a> +<span class="sourceLineNo">096</span> * default separator displayed between a long Option and its value<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <a name="line.97"></a> +<span class="sourceLineNo">098</span> * @since 1.3<a name="line.98"></a> +<span class="sourceLineNo">099</span> **/<a name="line.99"></a> +<span class="sourceLineNo">100</span> public static final String DEFAULT_LONG_OPT_SEPARATOR = " ";<a name="line.100"></a> +<span class="sourceLineNo">101</span><a name="line.101"></a> +<span class="sourceLineNo">102</span> /** default name for an argument */<a name="line.102"></a> +<span class="sourceLineNo">103</span> public static final String DEFAULT_ARG_NAME = "arg";<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> // -------------------------------------------------------------- Attributes<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /**<a name="line.107"></a> +<span class="sourceLineNo">108</span> * number of characters per line<a name="line.108"></a> +<span class="sourceLineNo">109</span> *<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @deprecated Scope will be made private for next major version<a name="line.110"></a> +<span class="sourceLineNo">111</span> * - use get/setWidth methods instead.<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> @Deprecated<a name="line.113"></a> +<span class="sourceLineNo">114</span> public int defaultWidth = DEFAULT_WIDTH;<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * amount of padding to the left of each line<a name="line.117"></a> +<span class="sourceLineNo">118</span> *<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @deprecated Scope will be made private for next major version<a name="line.119"></a> +<span class="sourceLineNo">120</span> * - use get/setLeftPadding methods instead.<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> @Deprecated<a name="line.122"></a> +<span class="sourceLineNo">123</span> public int defaultLeftPad = DEFAULT_LEFT_PAD;<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * the number of characters of padding to be prefixed<a name="line.126"></a> +<span class="sourceLineNo">127</span> * to each description line<a name="line.127"></a> +<span class="sourceLineNo">128</span> *<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @deprecated Scope will be made private for next major version<a name="line.129"></a> +<span class="sourceLineNo">130</span> * - use get/setDescPadding methods instead.<a name="line.130"></a> +<span class="sourceLineNo">131</span> */<a name="line.131"></a> +<span class="sourceLineNo">132</span> @Deprecated<a name="line.132"></a> +<span class="sourceLineNo">133</span> public int defaultDescPad = DEFAULT_DESC_PAD;<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * the string to display at the beginning of the usage statement<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @deprecated Scope will be made private for next major version<a name="line.138"></a> +<span class="sourceLineNo">139</span> * - use get/setSyntaxPrefix methods instead.<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> @Deprecated<a name="line.141"></a> +<span class="sourceLineNo">142</span> public String defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX;<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> /**<a name="line.144"></a> +<span class="sourceLineNo">145</span> * the new line string<a name="line.145"></a> +<span class="sourceLineNo">146</span> *<a name="line.146"></a> +<span class="sourceLineNo">147</span> * @deprecated Scope will be made private for next major version<a name="line.147"></a> +<span class="sourceLineNo">148</span> * - use get/setNewLine methods instead.<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> @Deprecated<a name="line.150"></a> +<span class="sourceLineNo">151</span> public String defaultNewLine = System.getProperty("line.separator");<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> /**<a name="line.153"></a> +<span class="sourceLineNo">154</span> * the shortOpt prefix<a name="line.154"></a> +<span class="sourceLineNo">155</span> *<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @deprecated Scope will be made private for next major version<a name="line.156"></a> +<span class="sourceLineNo">157</span> * - use get/setOptPrefix methods instead.<a name="line.157"></a> +<span class="sourceLineNo">158</span> */<a name="line.158"></a> +<span class="sourceLineNo">159</span> @Deprecated<a name="line.159"></a> +<span class="sourceLineNo">160</span> public String defaultOptPrefix = DEFAULT_OPT_PREFIX;<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * the long Opt prefix<a name="line.163"></a> +<span class="sourceLineNo">164</span> *<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @deprecated Scope will be made private for next major version<a name="line.165"></a> +<span class="sourceLineNo">166</span> * - use get/setLongOptPrefix methods instead.<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> @Deprecated<a name="line.168"></a> +<span class="sourceLineNo">169</span> public String defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX;<a name="line.169"></a> +<span class="sourceLineNo">170</span><a name="line.170"></a> +<span class="sourceLineNo">171</span> /**<a name="line.171"></a> +<span class="sourceLineNo">172</span> * the name of the argument<a name="line.172"></a> +<span class="sourceLineNo">173</span> *<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @deprecated Scope will be made private for next major version<a name="line.174"></a> +<span class="sourceLineNo">175</span> * - use get/setArgName methods instead.<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> @Deprecated<a name="line.177"></a> +<span class="sourceLineNo">178</span> public String defaultArgName = DEFAULT_ARG_NAME;<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> /**<a name="line.180"></a> +<span class="sourceLineNo">181</span> * Comparator used to sort the options when they output in help text<a name="line.181"></a> +<span class="sourceLineNo">182</span> * <a name="line.182"></a> +<span class="sourceLineNo">183</span> * Defaults to case-insensitive alphabetical sorting by option key<a name="line.183"></a> +<span class="sourceLineNo">184</span> */<a name="line.184"></a> +<span class="sourceLineNo">185</span> protected Comparator<Option> optionComparator = new OptionComparator();<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> /** The separator displayed between the long option and its value. */<a name="line.187"></a> +<span class="sourceLineNo">188</span> private String longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR;<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> /**<a name="line.190"></a> +<span class="sourceLineNo">191</span> * Sets the 'width'.<a name="line.191"></a> +<span class="sourceLineNo">192</span> *<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param width the new value of 'width'<a name="line.193"></a> +<span class="sourceLineNo">194</span> */<a name="line.194"></a> +<span class="sourceLineNo">195</span> public void setWidth(int width)<a name="line.195"></a> +<span class="sourceLineNo">196</span> {<a name="line.196"></a> +<span class="sourceLineNo">197</span> this.defaultWidth = width;<a name="line.197"></a> +<span class="sourceLineNo">198</span> }<a name="line.198"></a> +<span class="sourceLineNo">199</span><a name="line.199"></a> +<span class="sourceLineNo">200</span> /**<a name="line.200"></a> +<span class="sourceLineNo">201</span> * Returns the 'width'.<a name="line.201"></a> +<span class="sourceLineNo">202</span> *<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @return the 'width'<a name="line.203"></a> +<span class="sourceLineNo">204</span> */<a name="line.204"></a> +<span class="sourceLineNo">205</span> public int getWidth()<a name="line.205"></a> +<span class="sourceLineNo">206</span> {<a name="line.206"></a> +<span class="sourceLineNo">207</span> return defaultWidth;<a name="line.207"></a> +<span class="sourceLineNo">208</span> }<a name="line.208"></a> +<span class="sourceLineNo">209</span><a name="line.209"></a> +<span class="sourceLineNo">210</span> /**<a name="line.210"></a> +<span class="sourceLineNo">211</span> * Sets the 'leftPadding'.<a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param padding the new value of 'leftPadding'<a name="line.213"></a> +<span class="sourceLineNo">214</span> */<a name="line.214"></a> +<span class="sourceLineNo">215</span> public void setLeftPadding(int padding)<a name="line.215"></a> +<span class="sourceLineNo">216</span> {<a name="line.216"></a> +<span class="sourceLineNo">217</span> this.defaultLeftPad = padding;<a name="line.217"></a> +<span class="sourceLineNo">218</span> }<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Returns the 'leftPadding'.<a name="line.221"></a> +<span class="sourceLineNo">222</span> *<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @return the 'leftPadding'<a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> public int getLeftPadding()<a name="line.225"></a> +<span class="sourceLineNo">226</span> {<a name="line.226"></a> +<span class="sourceLineNo">227</span> return defaultLeftPad;<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Sets the 'descPadding'.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param padding the new value of 'descPadding'<a name="line.233"></a> +<span class="sourceLineNo">234</span> */<a name="line.234"></a> +<span class="sourceLineNo">235</span> public void setDescPadding(int padding)<a name="line.235"></a> +<span class="sourceLineNo">236</span> {<a name="line.236"></a> +<span class="sourceLineNo">237</span> this.defaultDescPad = padding;<a name="line.237"></a> +<span class="sourceLineNo">238</span> }<a name="line.238"></a> +<span class="sourceLineNo">239</span><a name="line.239"></a> +<span class="sourceLineNo">240</span> /**<a name="line.240"></a> +<span class="sourceLineNo">241</span> * Returns the 'descPadding'.<a name="line.241"></a> +<span class="sourceLineNo">242</span> *<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @return the 'descPadding'<a name="line.243"></a> +<span class="sourceLineNo">244</span> */<a name="line.244"></a> +<span class="sourceLineNo">245</span> public int getDescPadding()<a name="line.245"></a> +<span class="sourceLineNo">246</span> {<a name="line.246"></a> +<span class="sourceLineNo">247</span> return defaultDescPad;<a name="line.247"></a> +<span class="sourceLineNo">248</span> }<a name="line.248"></a> +<span class="sourceLineNo">249</span><a name="line.249"></a> +<span class="sourceLineNo">250</span> /**<a name="line.250"></a> +<span class="sourceLineNo">251</span> * Sets the 'syntaxPrefix'.<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @param prefix the new value of 'syntaxPrefix'<a name="line.253"></a> +<span class="sourceLineNo">254</span> */<a name="line.254"></a> +<span class="sourceLineNo">255</span> public void setSyntaxPrefix(String prefix)<a name="line.255"></a> +<span class="sourceLineNo">256</span> {<a name="line.256"></a> +<span class="sourceLineNo">257</span> this.defaultSyntaxPrefix = prefix;<a name="line.257"></a> +<span class="sourceLineNo">258</span> }<a name="line.258"></a> +<span class="sourceLineNo">259</span><a name="line.259"></a> +<span class="sourceLineNo">260</span> /**<a name="line.260"></a> +<span class="sourceLineNo">261</span> * Returns the 'syntaxPrefix'.<a name="line.261"></a> +<span class="sourceLineNo">262</span> *<a name="line.262"></a> +<span class="sourceLineNo">263</span> * @return the 'syntaxPrefix'<a name="line.263"></a> +<span class="sourceLineNo">264</span> */<a name="line.264"></a> +<span class="sourceLineNo">265</span> public String getSyntaxPrefix()<a name="line.265"></a> +<span class="sourceLineNo">266</span> {<a name="line.266"></a> +<span class="sourceLineNo">267</span> return defaultSyntaxPrefix;<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Sets the 'newLine'.<a name="line.271"></a> +<span class="sourceLineNo">272</span> *<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @param newline the new value of 'newLine'<a name="line.273"></a> +<span class="sourceLineNo">274</span> */<a name="line.274"></a> +<span class="sourceLineNo">275</span> public void setNewLine(String newline)<a name="line.275"></a> +<span class="sourceLineNo">276</span> {<a name="line.276"></a> +<span class="sourceLineNo">277</span> this.defaultNewLine = newline;<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span><a name="line.279"></a> +<span class="sourceLineNo">280</span> /**<a name="line.280"></a> +<span class="sourceLineNo">281</span> * Returns the 'newLine'.<a name="line.281"></a> +<span class="sourceLineNo">282</span> *<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @return the 'newLine'<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public String getNewLine()<a name="line.285"></a> +<span class="sourceLineNo">286</span> {<a name="line.286"></a> +<span class="sourceLineNo">287</span> return defaultNewLine;<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span><a name="line.289"></a> +<span class="sourceLineNo">290</span> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * Sets the 'optPrefix'.<a name="line.291"></a> +<span class="sourceLineNo">292</span> *<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @param prefix the new value of 'optPrefix'<a name="line.293"></a> +<span class="sourceLineNo">294</span> */<a name="line.294"></a> +<span class="sourceLineNo">295</span> public void setOptPrefix(String prefix)<a name="line.295"></a> +<span class="sourceLineNo">296</span> {<a name="line.296"></a> +<span class="sourceLineNo">297</span> this.defaultOptPrefix = prefix;<a name="line.297"></a> +<span class="sourceLineNo">298</span> }<a name="line.298"></a> +<span class="sourceLineNo">299</span><a name="line.299"></a> +<span class="sourceLineNo">300</span> /**<a name="line.300"></a> +<span class="sourceLineNo">301</span> * Returns the 'optPrefix'.<a name="line.301"></a> +<span class="sourceLineNo">302</span> *<a name="line.302"></a> +<span class="sourceLineNo">303</span> * @return the 'optPrefix'<a name="line.303"></a> +<span class="sourceLineNo">304</span> */<a name="line.304"></a> +<span class="sourceLineNo">305</span> public String getOptPrefix()<a name="line.305"></a> +<span class="sourceLineNo">306</span> {<a name="line.306"></a> +<span class="sourceLineNo">307</span> return defaultOptPrefix;<a name="line.307"></a> +<span class="sourceLineNo">308</span> }<a name="line.308"></a> +<span class="sourceLineNo">309</span><a name="line.309"></a> +<span class="sourceLineNo">310</span> /**<a name="line.310"></a> +<span class="sourceLineNo">311</span> * Sets the 'longOptPrefix'.<a name="line.311"></a> +<span class="sourceLineNo">312</span> *<a name="line.312"></a> +<span class="sourceLineNo">313</span> * @param prefix the new value of 'longOptPrefix'<a name="line.313"></a> +<span class="sourceLineNo">314</span> */<a name="line.314"></a> +<span class="sourceLineNo">315</span> public void setLongOptPrefix(String prefix)<a name="line.315"></a> +<span class="sourceLineNo">316</span> {<a name="line.316"></a> +<span class="sourceLineNo">317</span> this.defaultLongOptPrefix = prefix;<a name="line.317"></a> +<span class="sourceLineNo">318</span> }<a name="line.318"></a> +<span class="sourceLineNo">319</span><a name="line.319"></a> +<span class="sourceLineNo">320</span> /**<a name="line.320"></a> +<span class="sourceLineNo">321</span> * Returns the 'longOptPrefix'.<a name="line.321"></a> +<span class="sourceLineNo">322</span> *<a name="line.322"></a> +<span class="sourceLineNo">323</span> * @return the 'longOptPrefix'<a name="line.323"></a> +<span class="sourceLineNo">324</span> */<a name="line.324"></a> +<span class="sourceLineNo">325</span> public String getLongOptPrefix()<a name="line.325"></a> +<span class="sourceLineNo">326</span> {<a name="line.326"></a> +<span class="sourceLineNo">327</span> return defaultLongOptPrefix;<a name="line.327"></a> +<span class="sourceLineNo">328</span> }<a name="line.328"></a> +<span class="sourceLineNo">329</span><a name="line.329"></a> +<span class="sourceLineNo">330</span> /**<a name="line.330"></a> +<span class="sourceLineNo">331</span> * Set the separator displayed between a long option and its value.<a name="line.331"></a> +<span class="sourceLineNo">332</span> * Ensure that the separator specified is supported by the parser used,<a name="line.332"></a> +<span class="sourceLineNo">333</span> * typically ' ' or '='.<a name="line.333"></a> +<span class="sourceLineNo">334</span> * <a name="line.334"></a> +<span class="sourceLineNo">335</span> * @param longOptSeparator the separator, typically ' ' or '='.<a name="line.335"></a> +<span class="sourceLineNo">336</span> * @since 1.3<a name="line.336"></a> +<span class="sourceLineNo">337</span> */<a name="line.337"></a> +<span class="sourceLineNo">338</span> public void setLongOptSeparator(String longOptSeparator)<a name="line.338"></a> +<span class="sourceLineNo">339</span> {<a name="line.339"></a> +<span class="sourceLineNo">340</span> this.longOptSeparator = longOptSeparator;<a name="line.340"></a> +<span class="sourceLineNo">341</span> }<a name="line.341"></a> +<span class="sourceLineNo">342</span><a name="line.342"></a> +<span class="sourceLineNo">343</span> /**<a name="line.343"></a> +<span class="sourceLineNo">344</span> * Returns the separator displayed between a long option and its value.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * <a name="line.345"></a> +<span class="sourceLineNo">346</span> * @return the separator<a name="line.346"></a> +<span class="sourceLineNo">347</span> * @since 1.3<a name="line.347"></a> +<span class="sourceLineNo">348</span> */<a name="line.348"></a> +<span class="sourceLineNo">349</span> public String getLongOptSeparator()<a name="line.349"></a> +<span class="sourceLineNo">350</span> {<a name="line.350"></a> +<span class="sourceLineNo">351</span> return longOptSeparator;<a name="line.351"></a> +<span class="sourceLineNo">352</span> }<a name="line.352"></a> +<span class="sourceLineNo">353</span><a name="line.353"></a> +<span class="sourceLineNo">354</span> /**<a name="line.354"></a> +<span class="sourceLineNo">355</span> * Sets the 'argName'.<a name="line.355"></a> +<span class="sourceLineNo">356</span> *<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @param name the new value of 'argName'<a name="line.357"></a> +<span class="sourceLineNo">358</span> */<a name="line.358"></a> +<span class="sourceLineNo">359</span> public void setArgName(String name)<a name="line.359"></a> +<span class="sourceLineNo">360</span> {<a name="line.360"></a> +<span class="sourceLineNo">361</span> this.defaultArgName = name;<a name="line.361"></a> +<span class="sourceLineNo">362</span> }<a name="line.362"></a> +<span class="sourceLineNo">363</span><a name="line.363"></a> +<span class="sourceLineNo">364</span> /**<a name="line.364"></a> +<span class="sourceLineNo">365</span> * Returns the 'argName'.<a name="line.365"></a> +<span class="sourceLineNo">366</span> *<a name="line.366"></a> +<span class="sourceLineNo">367</span> * @return the 'argName'<a name="line.367"></a> +<span class="sourceLineNo">368</span> */<a name="line.368"></a> +<span class="sourceLineNo">369</span> public String getArgName()<a name="line.369"></a> +<span class="sourceLineNo">370</span> {<a name="line.370"></a> +<span class="sourceLineNo">371</span> return defaultArgName;<a name="line.371"></a> +<span class="sourceLineNo">372</span> }<a name="line.372"></a> +<span class="sourceLineNo">373</span><a name="line.373"></a> +<span class="sourceLineNo">374</span> /**<a name="line.374"></a> +<span class="sourceLineNo">375</span> * Comparator used to sort the options when they output in help text.<a name="line.375"></a> +<span class="sourceLineNo">376</span> * Defaults to case-insensitive alphabetical sorting by option key.<a name="line.376"></a> +<span class="sourceLineNo">377</span> *<a name="line.377"></a> +<span class="sourceLineNo">378</span> * @return the {@link Comparator} currently in use to sort the options<a name="line.378"></a> +<span class="sourceLineNo">379</span> * @since 1.2<a name="line.379"></a> +<span class="sourceLineNo">380</span> */<a name="line.380"></a> +<span class="sourceLineNo">381</span> public Comparator<Option> getOptionComparator()<a name="line.381"></a> +<span class="sourceLineNo">382</span> {<a name="line.382"></a> +<span class="sourceLineNo">383</span> return optionComparator;<a name="line.383"></a> +<span class="sourceLineNo">384</span> }<a name="line.384"></a> +<span class="sourceLineNo">385</span><a name="line.385"></a> +<span class="sourceLineNo">386</span> /**<a name="line.386"></a> +<span class="sourceLineNo">387</span> * Set the comparator used to sort the options when they output in help text.<a name="line.387"></a> +<span class="sourceLineNo">388</span> * Passing in a null comparator will keep the options in the order they were declared.<a name="line.388"></a> +<span class="sourceLineNo">389</span> *<a name="line.389"></a> +<span class="sourceLineNo">390</span> * @param comparator the {@link Comparator} to use for sorting the options<a name="line.390"></a> +<span class="sourceLineNo">391</span> * @since 1.2<a name="line.391"></a> +<span class="sourceLineNo">392</span> */<a name="line.392"></a> +<span class="sourceLineNo">393</span> public void setOptionComparator(Comparator<Option> comparator)<a name="line.393"></a> +<span class="sourceLineNo">394</span> {<a name="line.394"></a> +<span class="sourceLineNo">395</span> this.optionComparator = comparator;<a name="line.395"></a> +<span class="sourceLineNo">396</span> }<a name="line.396"></a> +<span class="sourceLineNo">397</span><a name="line.397"></a> +<span class="sourceLineNo">398</span> /**<a name="line.398"></a> +<span class="sourceLineNo">399</span> * Print the help for <code>options</code> with the specified<a name="line.399"></a> +<span class="sourceLineNo">400</span> * command line syntax. This method prints help information to<a name="line.400"></a> +<span class="sourceLineNo">401</span> * System.out.<a name="line.401"></a> +<span class="sourceLineNo">402</span> *<a name="line.402"></a> +<span class="sourceLineNo">403</span> * @param cmdLineSyntax the syntax for this application<a name="line.403"></a> +<span class="sourceLineNo">404</span> * @param options the Options instance<a name="line.404"></a> +<span class="sourceLineNo">405</span> */<a name="line.405"></a> +<span class="sourceLineNo">406</span> public void printHelp(String cmdLineSyntax, Options options)<a name="line.406"></a> +<span class="sourceLineNo">407</span> {<a name="line.407"></a> +<span class="sourceLineNo">408</span> printHelp(getWidth(), cmdLineSyntax, null, options, null, false);<a name="line.408"></a> +<span class="sourceLineNo">409</span> }<a name="line.409"></a> +<span class="sourceLineNo">410</span><a name="line.410"></a> +<span class="sourceLineNo">411</span> /**<a name="line.411"></a> +<span class="sourceLineNo">412</span> * Print the help for <code>options</code> with the specified<a name="line.412"></a> +<span class="sourceLineNo">413</span> * command line syntax. This method prints help information to <a name="line.413"></a> +<span class="sourceLineNo">414</span> * System.out.<a name="line.414"></a> +<span class="sourceLineNo">415</span> *<a name="line.415"></a> +<span class="sourceLineNo">416</span> * @param cmdLineSyntax the syntax for this application<a name="line.416"></a> +<span class="sourceLineNo">417</span> * @param options the Options instance<a name="line.417"></a> +<span class="sourceLineNo">418</span> * @param autoUsage whether to print an automatically generated<a name="line.418"></a> +<span class="sourceLineNo">419</span> * usage statement<a name="line.419"></a> +<span class="sourceLineNo">420</span> */<a name="line.420"></a> +<span class="sourceLineNo">421</span> public void printHelp(String cmdLineSyntax, Options options, boolean autoUsage)<a name="line.421"></a> +<span class="sourceLineNo">422</span> {<a name="line.422"></a> +<span class="sourceLineNo">423</span> printHelp(getWidth(), cmdLineSyntax, null, options, null, autoUsage);<a name="line.423"></a> +<span class="sourceLineNo">424</span> }<a name="line.424"></a> +<span class="sourceLineNo">425</span><a name="line.425"></a> +<span class="sourceLineNo">426</span> /**<a name="line.426"></a> +<span class="sourceLineNo">427</span> * Print the help for <code>options</code> with the specified<a name="line.427"></a> +<span class="sourceLineNo">428</span> * command line syntax. This method prints help information to<a name="line.428"></a> +<span class="sourceLineNo">429</span> * System.out.<a name="line.429"></a> +<span class="sourceLineNo">430</span> *<a name="line.430"></a> +<span class="sourceLineNo">431</span> * @param cmdLineSyntax the syntax for this application<a name="line.431"></a> +<span class="sourceLineNo">432</span> * @param header the banner to display at the beginning of the help<a name="line.432"></a> +<span class="sourceLineNo">433</span> * @param options the Options instance<a name="line.433"></a> +<span class="sourceLineNo">434</span> * @param footer the banner to display at the end of the help<a name="line.434"></a> +<span class="sourceLineNo">435</span> */<a name="line.435"></a> +<span class="sourceLineNo">436</span> public void printHelp(String cmdLineSyntax, String header, Options options, String footer)<a name="line.436"></a> +<span class="sourceLineNo">437</span> {<a name="line.437"></a> +<span class="sourceLineNo">438</span> printHelp(cmdLineSyntax, header, options, footer, false);<a name="line.438"></a> +<span class="sourceLineNo">439</span> }<a name="line.439"></a> +<span class="sourceLineNo">440</span><a name="line.440"></a> +<span class="sourceLineNo">441</span> /**<a name="line.441"></a> +<span class="sourceLineNo">442</span> * Print the help for <code>options</code> with the specified<a name="line.442"></a> +<span class="sourceLineNo">443</span> * command line syntax. This method prints help information to <a name="line.443"></a> +<span class="sourceLineNo">444</span> * System.out.<a name="line.444"></a> +<span class="sourceLineNo">445</span> *<a name="line.445"></a> +<span class="sourceLineNo">446</span> * @param cmdLineSyntax the syntax for this application<a name="line.446"></a> +<span class="sourceLineNo">447</span> * @param header the banner to display at the beginning of the help<a name="line.447"></a> +<span class="sourceLineNo">448</span> * @param options the Options instance<a name="line.448"></a> +<span class="sourceLineNo">449</span> * @param footer the banner to display at the end of the help<a name="line.449"></a> +<span class="sourceLineNo">450</span> * @param autoUsage whether to print an automatically generated<a name="line.450"></a> +<span class="sourceLineNo">451</span> * usage statement<a name="line.451"></a> +<span class="sourceLineNo">452</span> */<a name="line.452"></a> +<span class="sourceLineNo">453</span> public void printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage)<a name="line.453"></a> +<span class="sourceLineNo">454</span> {<a name="line.454"></a> +<span class="sourceLineNo">455</span> printHelp(getWidth(), cmdLineSyntax, header, options, footer, autoUsage);<a name="line.455"></a> +<span class="sourceLineNo">456</span> }<a name="line.456"></a> +<span class="sourceLineNo">457</span><a name="line.457"></a> +<span class="sourceLineNo">458</span> /**<a name="line.458"></a> +<span class="sourceLineNo">459</span> * Print the help for <code>options</code> with the specified<a name="line.459"></a> +<span class="sourceLineNo">460</span> * command line syntax. This method prints help information to<a name="line.460"></a> +<span class="sourceLineNo">461</span> * System.out.<a name="line.461"></a> +<span class="sourceLineNo">462</span> *<a name="line.462"></a> +<span class="sourceLineNo">463</span> * @param width the number of characters to be displayed on each line<a name="line.463"></a> +<span class="sourceLineNo">464</span> * @param cmdLineSyntax the syntax for this application<a name="line.464"></a> +<span class="sourceLineNo">465</span> * @param header the banner to display at the beginning of the help<a name="line.465"></a> +<span class="sourceLineNo">466</span> * @param options the Options instance<a name="line.466"></a> +<span class="sourceLineNo">467</span> * @param footer the banner to display at the end of the help<a name="line.467"></a> +<span class="sourceLineNo">468</span> */<a name="line.468"></a> +<span class="sourceLineNo">469</span> public void printHelp(int width, String cmdLineSyntax, String header, Options options, String footer)<a name="line.469"></a> +<span class="sourceLineNo">470</span> {<a name="line.470"></a> +<span class="sourceLineNo">471</span> printHelp(width, cmdLineSyntax, header, options, footer, false);<a name="line.471"></a> +<span class="sourceLineNo">472</span> }<a name="line.472"></a> +<span class="sourceLineNo">473</span><a name="line.473"></a> +<span class="sourceLineNo">474</span> /**<a name="line.474"></a> +<span class="sourceLineNo">475</span> * Print the help for <code>options</code> with the specified<a name="line.475"></a> +<span class="sourceLineNo">476</span> * command line syntax. This method prints help information to<a name="line.476"></a> +<span class="sourceLineNo">477</span> * System.out.<a name="line.477"></a> +<span class="sourceLineNo">478</span> *<a name="line.478"></a> +<span class="sourceLineNo">479</span> * @param width the number of characters to be displayed on each line<a name="line.479"></a> +<span class="sourceLineNo">480</span> * @param cmdLineSyntax the syntax for this application<a name="line.480"></a> +<span class="sourceLineNo">481</span> * @param header the banner to display at the beginning of the help<a name="line.481"></a> +<span class="sourceLineNo">482</span> * @param options the Options instance<a name="line.482"></a> +<span class="sourceLineNo">483</span> * @param footer the banner to display at the end of the help<a name="line.483"></a> +<span class="sourceLineNo">484</span> * @param autoUsage whether to print an automatically generated <a name="line.484"></a> +<span class="sourceLineNo">485</span> * usage statement<a name="line.485"></a> +<span class="sourceLineNo">486</span> */<a name="line.486"></a> +<span class="sourceLineNo">487</span> public void printHelp(int width, String cmdLineSyntax, String header,<a name="line.487"></a> +<span class="sourceLineNo">488</span> Options options, String footer, boolean autoUsage)<a name="line.488"></a> +<span class="sourceLineNo">489</span> {<a name="line.489"></a> +<span class="sourceLineNo">490</span> PrintWriter pw = new PrintWriter(System.out);<a name="line.490"></a> <span class="sourceLineNo">491</span><a name="line.491"></a> -<span class="sourceLineNo">492</span> /**<a name="line.492"></a> -<span class="sourceLineNo">493</span> * Print the help for <code>options</code> with the specified<a name="line.493"></a> -<span class="sourceLineNo">494</span> * command line syntax.<a name="line.494"></a> -<span class="sourceLineNo">495</span> *<a name="line.495"></a> -<span class="sourceLineNo">496</span> * @param pw the writer to which the help will be written<a name="line.496"></a> -<span class="sourceLineNo">497</span> * @param width the number of characters to be displayed on each line<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @param cmdLineSyntax the syntax for this application<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @param header the banner to display at the beginning of the help<a name="line.499"></a> -<span class="sourceLineNo">500</span> * @param options the Options instance<a name="line.500"></a> -<span class="sourceLineNo">501</span> * @param leftPad the number of characters of padding to be prefixed<a name="line.501"></a> -<span class="sourceLineNo">502</span> * to each line<a name="line.502"></a> -<span class="sourceLineNo">503</span> * @param descPad the number of characters of padding to be prefixed<a name="line.503"></a> -<span class="sourceLineNo">504</span> * to each description line<a name="line.504"></a> -<span class="sourceLineNo">505</span> * @param footer the banner to display at the end of the help<a name="line.505"></a> -<span class="sourceLineNo">506</span> *<a name="line.506"></a> -<span class="sourceLineNo">507</span> * @throws IllegalStateException if there is no room to print a line<a name="line.507"></a> -<span class="sourceLineNo">508</span> */<a name="line.508"></a> -<span class="sourceLineNo">509</span> public void printHelp(PrintWriter pw, int width, String cmdLineSyntax, <a name="line.509"></a> -<span class="sourceLineNo">510</span> String header, Options options, int leftPad, <a name="line.510"></a> -<span class="sourceLineNo">511</span> int descPad, String footer)<a name="line.511"></a> -<span class="sourceLineNo">512</span> {<a name="line.512"></a> -<span class="sourceLineNo">513</span> printHelp(pw, width, cmdLineSyntax, header, options, leftPad, descPad, footer, false);<a name="line.513"></a> -<span class="sourceLineNo">514</span> }<a name="line.514"></a> -<span class="sourceLineNo">515</span><a name="line.515"></a> -<span class="sourceLineNo">516</span><a name="line.516"></a> -<span class="sourceLineNo">517</span> /**<a name="line.517"></a> -<span class="sourceLineNo">518</span> * Print the help for <code>options</code> with the specified<a name="line.518"></a> -<span class="sourceLineNo">519</span> * command line syntax.<a name="line.519"></a> -<span class="sourceLineNo">520</span> *<a name="line.520"></a> -<span class="sourceLineNo">521</span> * @param pw the writer to which the help will be written<a name="line.521"></a> -<span class="sourceLineNo">522</span> * @param width the number of characters to be displayed on each line<a name="line.522"></a> -<span class="sourceLineNo">523</span> * @param cmdLineSyntax the syntax for this application<a name="line.523"></a> -<span class="sourceLineNo">524</span> * @param header the banner to display at the beginning of the help<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @param options the Options instance<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @param leftPad the number of characters of padding to be prefixed<a name="line.526"></a> -<span class="sourceLineNo">527</span> * to each line<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @param descPad the number of characters of padding to be prefixed<a name="line.528"></a> -<span class="sourceLineNo">529</span> * to each description line<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param footer the banner to display at the end of the help<a name="line.530"></a> -<span class="sourceLineNo">531</span> * @param autoUsage whether to print an automatically generated<a name="line.531"></a> -<span class="sourceLineNo">532</span> * usage statement<a name="line.532"></a> -<span class="sourceLineNo">533</span> *<a name="line.533"></a> -<span class="sourceLineNo">534</span> * @throws IllegalStateException if there is no room to print a line<a name="line.534"></a> -<span class="sourceLineNo">535</span> */<a name="line.535"></a> -<span class="sourceLineNo">536</span> public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,<a name="line.536"></a> -<span class="sourceLineNo">537</span> String header, Options options, int leftPad,<a name="line.537"></a> -<span class="sourceLineNo">538</span> int descPad, String footer, boolean autoUsage)<a name="line.538"></a> -<span class="sourceLineNo">539</span> {<a name="line.539"></a> -<span class="sourceLineNo">540</span> if ((cmdLineSyntax == null) || (cmdLineSyntax.length() == 0))<a name="line.540"></a> -<span class="sourceLineNo">541</span> {<a name="line.541"></a> -<span class="sourceLineNo">542</span> throw new IllegalArgumentException("cmdLineSyntax not provided");<a name="line.542"></a> -<span class="sourceLineNo">543</span> }<a name="line.543"></a> -<span class="sourceLineNo">544</span><a name="line.544"></a> -<span class="sourceLineNo">545</span> if (autoUsage)<a name="line.545"></a> -<span class="sourceLineNo">546</span> {<a name="line.546"></a> -<span class="sourceLineNo">547</span> printUsage(pw, width, cmdLineSyntax, options);<a name="line.547"></a> -<span class="sourceLineNo">548</span> }<a name="line.548"></a> -<span class="sourceLineNo">549</span> else<a name="line.549"></a> +<span class="sourceLineNo">492</span> printHelp(pw, width, cmdLineSyntax, header, options, getLeftPadding(), getDescPadding(), footer, autoUsage);<a name="line.492"></a> +<span class="sourceLineNo">493</span> pw.flush();<a name="line.493"></a> +<span class="sourceLineNo">494</span> }<a name="line.494"></a> +<span class="sourceLineNo">495</span><a name="line.495"></a> +<span class="sourceLineNo">496</span> /**<a name="line.496"></a> +<span class="sourceLineNo">497</span> * Print the help for <code>options</code> with the specified<a name="line.497"></a> +<span class="sourceLineNo">498</span> * command line syntax.<a name="line.498"></a> +<span class="sourceLineNo">499</span> *<a name="line.499"></a> +<span class="sourceLineNo">500</span> * @param pw the writer to which the help will be written<a name="line.500"></a> +<span class="sourceLineNo">501</span> * @param width the number of characters to be displayed on each line<a name="line.501"></a> +<span class="sourceLineNo">502</span> * @param cmdLineSyntax the syntax for this application<a name="line.502"></a> +<span class="sourceLineNo">503</span> * @param header the banner to display at the beginning of the help<a name="line.503"></a> +<span class="sourceLineNo">504</span> * @param options the Options instance<a name="line.504"></a> +<span class="sourceLineNo">505</span> * @param leftPad the number of characters of padding to be prefixed<a name="line.505"></a> +<span class="sourceLineNo">506</span> * to each line<a name="line.506"></a> +<span class="sourceLineNo">507</span> * @param descPad the number of characters of padding to be prefixed<a name="line.507"></a> +<span class="sourceLineNo">508</span> * to each description line<a name="line.508"></a> +<span class="sourceLineNo">509</span> * @param footer the banner to display at the end of the help<a name="line.509"></a> +<span class="sourceLineNo">510</span> *<a name="line.510"></a> +<span class="sourceLineNo">511</span> * @throws IllegalStateException if there is no room to print a line<a name="line.511"></a> +<span class="sourceLineNo">512</span> */<a name="line.512"></a> +<span class="sourceLineNo">513</span> public void printHelp(PrintWriter pw, int width, String cmdLineSyntax, <a name="line.513"></a> +<span class="sourceLineNo">514</span> String header, Options options, int leftPad, <a name="line.514"></a> +<span class="sourceLineNo">515</span> int descPad, String footer)<a name="line.515"></a> +<span class="sourceLineNo">516</span> {<a name="line.516"></a> +<span class="sourceLineNo">517</span> printHelp(pw, width, cmdLineSyntax, header, options, leftPad, descPad, footer, false);<a name="line.517"></a> +<span class="sourceLineNo">518</span> }<a name="line.518"></a> +<span class="sourceLineNo">519</span><a name="line.519"></a> +<span class="sourceLineNo">520</span><a name="line.520"></a> +<span class="sourceLineNo">521</span> /**<a name="line.521"></a> +<span class="sourceLineNo">522</span> * Print the help for <code>options</code> with the specified<a name="line.522"></a> +<span class="sourceLineNo">523</span> * command line syntax.<a name="line.523"></a> +<span class="sourceLineNo">524</span> *<a name="line.524"></a> +<span class="sourceLineNo">525</span> * @param pw the writer to which the help will be written<a name="line.525"></a> +<span class="sourceLineNo">526</span> * @param width the number of characters to be displayed on each line<a name="line.526"></a> +<span class="sourceLineNo">527</span> * @param cmdLineSyntax the syntax for this application<a name="line.527"></a> +<span class="sourceLineNo">528</span> * @param header the banner to display at the beginning of the help<a name="line.528"></a> +<span class="sourceLineNo">529</span> * @param options the Options instance<a name="line.529"></a> +<span class="sourceLineNo">530</span> * @param leftPad the number of characters of padding to be prefixed<a name="line.530"></a> +<span class="sourceLineNo">531</span> * to each line<a name="line.531"></a> +<span class="sourceLineNo">532</span> * @param descPad the number of characters of padding to be prefixed<a name="line.532"></a> +<span class="sourceLineNo">533</span> * to each description line<a name="line.533"></a> +<span class="sourceLineNo">534</span> * @param footer the banner to display at the end of the help<a name="line.534"></a> +<span class="sourceLineNo">535</span> * @param autoUsage whether to print an automatically generated<a name="line.535"></a> +<span class="sourceLineNo">536</span> * usage statement<a name="line.536"></a> +<span class="sourceLineNo">537</span> *<a name="line.537"></a> +<span class="sourceLineNo">538</span> * @throws IllegalStateException if there is no room to print a line<a name="line.538"></a> +<span class="sourceLineNo">539</span> */<a name="line.539"></a> +<span class="sourceLineNo">540</span> public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,<a name="line.540"></a> +<span class="sourceLineNo">541</span> String header, Options options, int leftPad,<a name="line.541"></a> +<span class="sourceLineNo">542</span> int descPad, String footer, boolean autoUsage)<a name="line.542"></a> +<span class="sourceLineNo">543</span> {<a name="line.543"></a> +<span class="sourceLineNo">544</span> if (cmdLineSyntax == null || cmdLineSyntax.length() == 0)<a name="line.544"></a> +<span class="sourceLineNo">545</span> {<a name="line.545"></a> +<span class="sourceLineNo">546</span> throw new IllegalArgumentException("cmdLineSyntax not provided");<a name="line.546"></a> +<span class="sourceLineNo">547</span> }<a name="line.547"></a> +<span class="sourceLineNo">548</span><a name="line.548"></a> +<span class="sourceLineNo">549</span> if (autoUsage)<a name="line.549"></a> <span class="sourceLineNo">550</span> {<a name="line.550"></a> -<span class="sourceLineNo">551</span> printUsage(pw, width, cmdLineSyntax);<a name="line.551"></a> +<span class="sourceLineNo">551</span> printUsage(pw, width, cmdLineSyntax, options);<a name="line.551"></a> <span class="sourceLineNo">552</span> }<a name="line.552"></a> -<span class="sourceLineNo">553</span><a name="line.553"></a> -<span class="sourceLineNo">554</span> if ((header != null) && (header.trim().length() > 0))<a name="line.554"></a> -<span class="sourceLineNo">555</span> {<a name="line.555"></a> -<span class="sourceLineNo">556</span> printWrapped(pw, width, header);<a name="line.556"></a> -<span class="sourceLineNo">557</span> }<a name="line.557"></a> -<span class="sourceLineNo">558</span><a name="line.558"></a> -<span class="sourceLineNo">559</span> printOptions(pw, width, options, leftPad, descPad);<a name="line.559"></a> -<span class="sourceLineNo">560</span><a name="line.560"></a> -<span class="sourceLineNo">561</span> if ((footer != null) && (footer.trim().length() > 0))<a name="line.561"></a> -<span class="sourceLineNo">562</span> {<a name="line.562"></a> -<span class="sourceLineNo">563</span> printWrapped(pw, width, footer);<a name="line.563"></a> -<span class="sourceLineNo">564</span> }<a name="line.564"></a> -<span class="sourceLineNo">565</span> }<a name="line.565"></a> -<span class="sourceLineNo">566</span><a name="line.566"></a> -<span class="sourceLineNo">567</span> /**<a name="line.567"></a> -<span class="sourceLineNo">568</span> * Prints the usage statement for the specified application.<a name="line.568"></a> -<span class="sourceLineNo">569</span> *<a name="line.569"></a> -<span class="sourceLineNo">570</span> * @param pw The PrintWriter to print the usage statement <a name="line.570"></a> -<span class="sourceLineNo">571</span> * @param width The number of characters to display per line<a name="line.571"></a> -<span class="sourceLineNo">572</span> * @param app The application name<a name="line.572"></a> -<span class="sourceLineNo">573</span> * @param options The command line Options<a name="line.573"></a> -<span class="sourceLineNo">574</span> */<a name="line.574"></a> -<span class="sourceLineNo">575</span> public void printUsage(PrintWriter pw, int width, String app, Options options)<a name="line.575"></a> -<span class="sourceLineNo">576</span> {<a name="line.576"></a> -<span class="sourceLineNo">577</span> // initialise the string buffer<a name="line.577"></a> -<span class="sourceLineNo">578</span> StringBuffer buff = new StringBuffer(getSyntaxPrefix()).append(app).append(" ");<a name="line.578"></a> -<span class="sourceLineNo">579</span><a name="line.579"></a> -<span class="sourceLineNo">580</span> // create a list for processed option groups<a name="line.580"></a> -<span class="sourceLineNo">581</span> Collection<OptionGroup> processedGroups = new ArrayList<OptionGroup>();<a name="line.581"></a> -<span class="sourceLineNo">582</span><a name="line.582"></a> -<span class="sourceLineNo">583</span> List<Option> optList = new ArrayList<Option>(options.getOptions());<a name="line.583"></a> -<span class="sourceLineNo">584</span> if (getOptionComparator() != null)<a name="line.584"></a> -<span class="sourceLineNo">585</span> {<a name="line.585"></a> -<span class="sourceLineNo">586</span> Collections.sort(optList, getOptionComparator());<a name="line.586"></a> -<span class="sourceLineNo">587</span> }<a name="line.587"></a> -<span class="sourceLineNo">588</span> // iterate over the options<a name="line.588"></a> -<span class="sourceLineNo">589</span> for (Iterator<Option> it = optList.iterator(); it.hasNext();)<a name="line.589"></a> -<span class="sourceLineNo">590</span> {<a name="line.590"></a> -<span class="sourceLineNo">591</span> // get the next Option<a name="line.591"></a> -<span class="sourceLineNo">592</span> Option option = it.next();<a name="line.592"></a> -<span class="sourceLineNo">593</span><a name="line.593"></a> -<span class="sourceLineNo">594</span> // check if the option is part of an OptionGroup<a name="line.594"></a> -<span class="sourceLineNo">595</span> OptionGroup group = options.getOptionGroup(option);<a name="line.595"></a> -<span class="sourceLineNo">596</span><a name="line.596"></a> -<span class="sourceLineNo">597</span> // if the option is part of a group <a name="line.597"></a> -<span class="sourceLineNo">598</span> if (group != null)<a name="line.598"></a>
[... 1020 lines stripped ...]
