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
Thu Aug 15 00:03:23 2024
@@ -1,5 +1,5 @@
<!DOCTYPE HTML>
-<html lang="en">
+<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
@@ -35,980 +35,1067 @@
<span class="source-line-no">022</span><span id="line-22">import
java.io.PrintWriter;</span>
<span class="source-line-no">023</span><span id="line-23">import
java.io.Serializable;</span>
<span class="source-line-no">024</span><span id="line-24">import
java.io.StringReader;</span>
-<span class="source-line-no">025</span><span id="line-25">import
java.util.ArrayList;</span>
-<span class="source-line-no">026</span><span id="line-26">import
java.util.Arrays;</span>
-<span class="source-line-no">027</span><span id="line-27">import
java.util.Collection;</span>
-<span class="source-line-no">028</span><span id="line-28">import
java.util.Collections;</span>
-<span class="source-line-no">029</span><span id="line-29">import
java.util.Comparator;</span>
-<span class="source-line-no">030</span><span id="line-30">import
java.util.Iterator;</span>
-<span class="source-line-no">031</span><span id="line-31">import
java.util.List;</span>
-<span class="source-line-no">032</span><span id="line-32">import
java.util.Objects;</span>
-<span class="source-line-no">033</span><span id="line-33">import
java.util.function.Function;</span>
-<span class="source-line-no">034</span><span id="line-34">import
java.util.function.Supplier;</span>
-<span class="source-line-no">035</span><span id="line-35"></span>
-<span class="source-line-no">036</span><span id="line-36">/**</span>
-<span class="source-line-no">037</span><span id="line-37"> * A formatter of
help messages for command line options.</span>
-<span class="source-line-no">038</span><span id="line-38"> * <p></span>
-<span class="source-line-no">039</span><span id="line-39"> * Example:</span>
-<span class="source-line-no">040</span><span id="line-40"> * </p></span>
-<span class="source-line-no">041</span><span id="line-41"> * <pre></span>
-<span class="source-line-no">042</span><span id="line-42"> * Options options =
new Options();</span>
-<span class="source-line-no">043</span><span id="line-43"> *
options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file
to be processed").hasArg().withArgName("FILE").isRequired().create('f'));</span>
-<span class="source-line-no">044</span><span id="line-44"> *
options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print
the version of the application").create('v'));</span>
-<span class="source-line-no">045</span><span id="line-45"> *
options.addOption(OptionBuilder.withLongOpt("help").create('h'));</span>
-<span class="source-line-no">046</span><span id="line-46"> *</span>
-<span class="source-line-no">047</span><span id="line-47"> * String header =
"Do something useful with an input file\n\n";</span>
-<span class="source-line-no">048</span><span id="line-48"> * String footer =
"\nPlease report issues at https://example.com/issues";</span>
-<span class="source-line-no">049</span><span id="line-49"> *</span>
-<span class="source-line-no">050</span><span id="line-50"> * HelpFormatter
formatter = new HelpFormatter();</span>
-<span class="source-line-no">051</span><span id="line-51"> *
formatter.printHelp("myapp", header, options, footer, true);</span>
-<span class="source-line-no">052</span><span id="line-52"> *
</pre></span>
-<span class="source-line-no">053</span><span id="line-53"> * <p></span>
-<span class="source-line-no">054</span><span id="line-54"> * This produces the
following output:</span>
-<span class="source-line-no">055</span><span id="line-55"> * </p></span>
-<span class="source-line-no">056</span><span id="line-56"> * <pre></span>
-<span class="source-line-no">057</span><span id="line-57"> * usage: myapp -f
&lt;FILE&gt; [-h] [-v]</span>
-<span class="source-line-no">058</span><span id="line-58"> * Do something
useful with an input file</span>
-<span class="source-line-no">059</span><span id="line-59"> *</span>
-<span class="source-line-no">060</span><span id="line-60"> * -f,--file
&lt;FILE&gt; The file to be processed</span>
-<span class="source-line-no">061</span><span id="line-61"> * -h,--help</span>
-<span class="source-line-no">062</span><span id="line-62"> * -v,--version
Print the version of the application</span>
-<span class="source-line-no">063</span><span id="line-63"> *</span>
-<span class="source-line-no">064</span><span id="line-64"> * Please report
issues at https://example.com/issues</span>
-<span class="source-line-no">065</span><span id="line-65"> *
</pre></span>
-<span class="source-line-no">066</span><span id="line-66"> */</span>
-<span class="source-line-no">067</span><span id="line-67">public class
HelpFormatter {</span>
-<span class="source-line-no">068</span><span id="line-68"></span>
-<span class="source-line-no">069</span><span id="line-69"> /**</span>
-<span class="source-line-no">070</span><span id="line-70"> * Builds {@link
HelpFormatter}.</span>
-<span class="source-line-no">071</span><span id="line-71"> *</span>
-<span class="source-line-no">072</span><span id="line-72"> * @since
1.7.0</span>
-<span class="source-line-no">073</span><span id="line-73"> */</span>
-<span class="source-line-no">074</span><span id="line-74"> public static
final class Builder implements Supplier<HelpFormatter> {</span>
-<span class="source-line-no">075</span><span id="line-75"> // TODO All
other instance HelpFormatter instance variables.</span>
-<span class="source-line-no">076</span><span id="line-76"> // Make
HelpFormatter immutable for 2.0</span>
-<span class="source-line-no">077</span><span id="line-77"></span>
-<span class="source-line-no">078</span><span id="line-78"> /**</span>
-<span class="source-line-no">079</span><span id="line-79"> * A
function to convert a description (not null) and a deprecated Option (not null)
to help description</span>
-<span class="source-line-no">080</span><span id="line-80"> */</span>
-<span class="source-line-no">081</span><span id="line-81"> private
static final Function<Option, String> DEFAULT_DEPRECATED_FORMAT = o ->
"[Deprecated] " + getDescription(o);</span>
-<span class="source-line-no">082</span><span id="line-82"></span>
-<span class="source-line-no">083</span><span id="line-83"> /**</span>
-<span class="source-line-no">084</span><span id="line-84"> * Formatter
for deprecated options.</span>
-<span class="source-line-no">085</span><span id="line-85"> */</span>
-<span class="source-line-no">086</span><span id="line-86"> private
Function<Option, String> deprecatedFormatFunc =
DEFAULT_DEPRECATED_FORMAT;</span>
-<span class="source-line-no">087</span><span id="line-87"></span>
-<span class="source-line-no">088</span><span id="line-88"> /**</span>
-<span class="source-line-no">089</span><span id="line-89"> * The
output PrintWriter, defaults to wrapping {@link System#out}.</span>
-<span class="source-line-no">090</span><span id="line-90"> */</span>
-<span class="source-line-no">091</span><span id="line-91"> private
PrintWriter printStream = createDefaultPrintWriter();</span>
-<span class="source-line-no">092</span><span id="line-92"></span>
-<span class="source-line-no">093</span><span id="line-93">
@Override</span>
-<span class="source-line-no">094</span><span id="line-94"> public
HelpFormatter get() {</span>
-<span class="source-line-no">095</span><span id="line-95"> return
new HelpFormatter(deprecatedFormatFunc, printStream);</span>
-<span class="source-line-no">096</span><span id="line-96"> }</span>
-<span class="source-line-no">097</span><span id="line-97"></span>
-<span class="source-line-no">098</span><span id="line-98"> /**</span>
-<span class="source-line-no">099</span><span id="line-99"> * Sets the
output PrintWriter, defaults to wrapping {@link System#out}.</span>
-<span class="source-line-no">100</span><span id="line-100"> *</span>
-<span class="source-line-no">101</span><span id="line-101"> * @param
printWriter the output PrintWriter, not null.</span>
-<span class="source-line-no">102</span><span id="line-102"> * @return
{@code this} instance.</span>
-<span class="source-line-no">103</span><span id="line-103"> */</span>
-<span class="source-line-no">104</span><span id="line-104"> public
Builder setPrintWriter(final PrintWriter printWriter) {</span>
-<span class="source-line-no">105</span><span id="line-105">
this.printStream = Objects.requireNonNull(printWriter, "printWriter");</span>
-<span class="source-line-no">106</span><span id="line-106"> return
this;</span>
-<span class="source-line-no">107</span><span id="line-107"> }</span>
-<span class="source-line-no">108</span><span id="line-108"></span>
-<span class="source-line-no">109</span><span id="line-109"> /**</span>
-<span class="source-line-no">110</span><span id="line-110"> * Sets
whether to show deprecated options.</span>
-<span class="source-line-no">111</span><span id="line-111"> *</span>
-<span class="source-line-no">112</span><span id="line-112"> * @param
useDefaultFormat if {@code true} use the default format, otherwise clear the
formatter.</span>
-<span class="source-line-no">113</span><span id="line-113"> * @return
{@code this} instance.</span>
-<span class="source-line-no">114</span><span id="line-114"> */</span>
-<span class="source-line-no">115</span><span id="line-115"> public
Builder setShowDeprecated(final boolean useDefaultFormat) {</span>
-<span class="source-line-no">116</span><span id="line-116"> return
setShowDeprecated(useDefaultFormat ? DEFAULT_DEPRECATED_FORMAT : null);</span>
-<span class="source-line-no">117</span><span id="line-117"> }</span>
-<span class="source-line-no">118</span><span id="line-118"></span>
-<span class="source-line-no">119</span><span id="line-119"> /**</span>
-<span class="source-line-no">120</span><span id="line-120"> * Sets
whether to show deprecated options.</span>
-<span class="source-line-no">121</span><span id="line-121"> *</span>
-<span class="source-line-no">122</span><span id="line-122"> * @param
showDeprecatedFunc Specify the format for the deprecated options.</span>
-<span class="source-line-no">123</span><span id="line-123"> * @return
{@code this} instance.</span>
-<span class="source-line-no">124</span><span id="line-124"> * @since
1.8.0</span>
-<span class="source-line-no">125</span><span id="line-125"> */</span>
-<span class="source-line-no">126</span><span id="line-126"> public
Builder setShowDeprecated(final Function<Option, String>
showDeprecatedFunc) {</span>
-<span class="source-line-no">127</span><span id="line-127">
this.deprecatedFormatFunc = showDeprecatedFunc;</span>
-<span class="source-line-no">128</span><span id="line-128"> return
this;</span>
-<span class="source-line-no">129</span><span id="line-129"> }</span>
-<span class="source-line-no">130</span><span id="line-130"> }</span>
-<span class="source-line-no">131</span><span id="line-131"></span>
-<span class="source-line-no">132</span><span id="line-132"> /**</span>
-<span class="source-line-no">133</span><span id="line-133"> * This class
implements the {@code Comparator} interface for comparing Options.</span>
-<span class="source-line-no">134</span><span id="line-134"> */</span>
-<span class="source-line-no">135</span><span id="line-135"> private static
final class OptionComparator implements Comparator<Option>, Serializable
{</span>
-<span class="source-line-no">136</span><span id="line-136"></span>
-<span class="source-line-no">137</span><span id="line-137"> /** The
serial version UID. */</span>
-<span class="source-line-no">138</span><span id="line-138"> private
static final long serialVersionUID = 5305467873966684014L;</span>
-<span class="source-line-no">139</span><span id="line-139"></span>
-<span class="source-line-no">140</span><span id="line-140"> /**</span>
-<span class="source-line-no">141</span><span id="line-141"> * Compares
its two arguments for order. Returns a negative integer, zero, or a positive
integer as the first argument</span>
-<span class="source-line-no">142</span><span id="line-142"> * is less
than, equal to, or greater than the second.</span>
-<span class="source-line-no">143</span><span id="line-143"> *</span>
-<span class="source-line-no">144</span><span id="line-144"> * @param
opt1 The first Option to be compared.</span>
-<span class="source-line-no">145</span><span id="line-145"> * @param
opt2 The second Option to be compared.</span>
-<span class="source-line-no">146</span><span id="line-146"> * @return
a negative integer, zero, or a positive integer as the first argument is less
than, equal to, or greater than</span>
-<span class="source-line-no">147</span><span id="line-147"> *
the second.</span>
-<span class="source-line-no">148</span><span id="line-148"> */</span>
-<span class="source-line-no">149</span><span id="line-149">
@Override</span>
-<span class="source-line-no">150</span><span id="line-150"> public int
compare(final Option opt1, final Option opt2) {</span>
-<span class="source-line-no">151</span><span id="line-151"> return
opt1.getKey().compareToIgnoreCase(opt2.getKey());</span>
-<span class="source-line-no">152</span><span id="line-152"> }</span>
-<span class="source-line-no">153</span><span id="line-153"> }</span>
-<span class="source-line-no">154</span><span id="line-154"> /** Default
number of characters per line */</span>
-<span class="source-line-no">155</span><span id="line-155"> public static
final int DEFAULT_WIDTH = 74;</span>
-<span class="source-line-no">156</span><span id="line-156"></span>
-<span class="source-line-no">157</span><span id="line-157"> /** Default
padding to the left of each line */</span>
-<span class="source-line-no">158</span><span id="line-158"> public static
final int DEFAULT_LEFT_PAD = 1;</span>
-<span class="source-line-no">159</span><span id="line-159"></span>
-<span class="source-line-no">160</span><span id="line-160"> /** Number of
space characters to be prefixed to each description line */</span>
-<span class="source-line-no">161</span><span id="line-161"> public static
final int DEFAULT_DESC_PAD = 3;</span>
-<span class="source-line-no">162</span><span id="line-162"></span>
-<span class="source-line-no">163</span><span id="line-163"> /** The string
to display at the beginning of the usage statement */</span>
-<span class="source-line-no">164</span><span id="line-164"> public static
final String DEFAULT_SYNTAX_PREFIX = "usage: ";</span>
-<span class="source-line-no">165</span><span id="line-165"></span>
-<span class="source-line-no">166</span><span id="line-166"> /** Default
prefix for shortOpts */</span>
-<span class="source-line-no">167</span><span id="line-167"> public static
final String DEFAULT_OPT_PREFIX = "-";</span>
-<span class="source-line-no">168</span><span id="line-168"></span>
-<span class="source-line-no">169</span><span id="line-169"> /** Default
prefix for long Option */</span>
-<span class="source-line-no">170</span><span id="line-170"> public static
final String DEFAULT_LONG_OPT_PREFIX = "--";</span>
+<span class="source-line-no">025</span><span id="line-25">import
java.io.UncheckedIOException;</span>
+<span class="source-line-no">026</span><span id="line-26">import
java.util.ArrayList;</span>
+<span class="source-line-no">027</span><span id="line-27">import
java.util.Arrays;</span>
+<span class="source-line-no">028</span><span id="line-28">import
java.util.Collection;</span>
+<span class="source-line-no">029</span><span id="line-29">import
java.util.Collections;</span>
+<span class="source-line-no">030</span><span id="line-30">import
java.util.Comparator;</span>
+<span class="source-line-no">031</span><span id="line-31">import
java.util.Iterator;</span>
+<span class="source-line-no">032</span><span id="line-32">import
java.util.List;</span>
+<span class="source-line-no">033</span><span id="line-33">import
java.util.Objects;</span>
+<span class="source-line-no">034</span><span id="line-34">import
java.util.function.Function;</span>
+<span class="source-line-no">035</span><span id="line-35">import
java.util.function.Supplier;</span>
+<span class="source-line-no">036</span><span id="line-36"></span>
+<span class="source-line-no">037</span><span id="line-37">/**</span>
+<span class="source-line-no">038</span><span id="line-38"> * A formatter of
help messages for command line options.</span>
+<span class="source-line-no">039</span><span id="line-39"> * <p></span>
+<span class="source-line-no">040</span><span id="line-40"> * Example:</span>
+<span class="source-line-no">041</span><span id="line-41"> * </p></span>
+<span class="source-line-no">042</span><span id="line-42"> * <pre></span>
+<span class="source-line-no">043</span><span id="line-43"> * Options options =
new Options();</span>
+<span class="source-line-no">044</span><span id="line-44"> *
options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file
to be processed").hasArg().withArgName("FILE").isRequired().create('f'));</span>
+<span class="source-line-no">045</span><span id="line-45"> *
options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print
the version of the application").create('v'));</span>
+<span class="source-line-no">046</span><span id="line-46"> *
options.addOption(OptionBuilder.withLongOpt("help").create('h'));</span>
+<span class="source-line-no">047</span><span id="line-47"> *</span>
+<span class="source-line-no">048</span><span id="line-48"> * String header =
"Do something useful with an input file\n\n";</span>
+<span class="source-line-no">049</span><span id="line-49"> * String footer =
"\nPlease report issues at https://example.com/issues";</span>
+<span class="source-line-no">050</span><span id="line-50"> *</span>
+<span class="source-line-no">051</span><span id="line-51"> * HelpFormatter
formatter = new HelpFormatter();</span>
+<span class="source-line-no">052</span><span id="line-52"> *
formatter.printHelp("myapp", header, options, footer, true);</span>
+<span class="source-line-no">053</span><span id="line-53"> *
</pre></span>
+<span class="source-line-no">054</span><span id="line-54"> * <p></span>
+<span class="source-line-no">055</span><span id="line-55"> * This produces the
following output:</span>
+<span class="source-line-no">056</span><span id="line-56"> * </p></span>
+<span class="source-line-no">057</span><span id="line-57"> * <pre></span>
+<span class="source-line-no">058</span><span id="line-58"> * usage: myapp -f
&lt;FILE&gt; [-h] [-v]</span>
+<span class="source-line-no">059</span><span id="line-59"> * Do something
useful with an input file</span>
+<span class="source-line-no">060</span><span id="line-60"> *</span>
+<span class="source-line-no">061</span><span id="line-61"> * -f,--file
&lt;FILE&gt; The file to be processed</span>
+<span class="source-line-no">062</span><span id="line-62"> * -h,--help</span>
+<span class="source-line-no">063</span><span id="line-63"> * -v,--version
Print the version of the application</span>
+<span class="source-line-no">064</span><span id="line-64"> *</span>
+<span class="source-line-no">065</span><span id="line-65"> * Please report
issues at https://example.com/issues</span>
+<span class="source-line-no">066</span><span id="line-66"> *
</pre></span>
+<span class="source-line-no">067</span><span id="line-67"> */</span>
+<span class="source-line-no">068</span><span id="line-68">public class
HelpFormatter {</span>
+<span class="source-line-no">069</span><span id="line-69"></span>
+<span class="source-line-no">070</span><span id="line-70"> /**</span>
+<span class="source-line-no">071</span><span id="line-71"> * Builds {@link
HelpFormatter}.</span>
+<span class="source-line-no">072</span><span id="line-72"> *</span>
+<span class="source-line-no">073</span><span id="line-73"> * @since
1.7.0</span>
+<span class="source-line-no">074</span><span id="line-74"> */</span>
+<span class="source-line-no">075</span><span id="line-75"> public static
class Builder implements Supplier<HelpFormatter> {</span>
+<span class="source-line-no">076</span><span id="line-76"> // TODO All
other instance HelpFormatter instance variables.</span>
+<span class="source-line-no">077</span><span id="line-77"> // Make
HelpFormatter immutable for 2.0</span>
+<span class="source-line-no">078</span><span id="line-78"></span>
+<span class="source-line-no">079</span><span id="line-79"> /**</span>
+<span class="source-line-no">080</span><span id="line-80"> * A
function to convert a description (not null) and a deprecated Option (not null)
to help description</span>
+<span class="source-line-no">081</span><span id="line-81"> */</span>
+<span class="source-line-no">082</span><span id="line-82"> private
static final Function<Option, String> DEFAULT_DEPRECATED_FORMAT = o ->
"[Deprecated] " + getDescription(o);</span>
+<span class="source-line-no">083</span><span id="line-83"></span>
+<span class="source-line-no">084</span><span id="line-84"> /**</span>
+<span class="source-line-no">085</span><span id="line-85"> * Formatter
for deprecated options.</span>
+<span class="source-line-no">086</span><span id="line-86"> */</span>
+<span class="source-line-no">087</span><span id="line-87"> private
Function<Option, String> deprecatedFormatFunction =
DEFAULT_DEPRECATED_FORMAT;</span>
+<span class="source-line-no">088</span><span id="line-88"></span>
+<span class="source-line-no">089</span><span id="line-89"> /**</span>
+<span class="source-line-no">090</span><span id="line-90"> * The
output PrintWriter, defaults to wrapping {@link System#out}.</span>
+<span class="source-line-no">091</span><span id="line-91"> */</span>
+<span class="source-line-no">092</span><span id="line-92"> private
PrintWriter printStream = createDefaultPrintWriter();</span>
+<span class="source-line-no">093</span><span id="line-93"></span>
+<span class="source-line-no">094</span><span id="line-94"> /** The flag
to determine if the since values should be dispalyed */</span>
+<span class="source-line-no">095</span><span id="line-95"> private
boolean showSince;</span>
+<span class="source-line-no">096</span><span id="line-96"></span>
+<span class="source-line-no">097</span><span id="line-97">
@Override</span>
+<span class="source-line-no">098</span><span id="line-98"> public
HelpFormatter get() {</span>
+<span class="source-line-no">099</span><span id="line-99"> return
new HelpFormatter(deprecatedFormatFunction, printStream, showSince);</span>
+<span class="source-line-no">100</span><span id="line-100"> }</span>
+<span class="source-line-no">101</span><span id="line-101"></span>
+<span class="source-line-no">102</span><span id="line-102"> /**</span>
+<span class="source-line-no">103</span><span id="line-103"> * Sets the
output PrintWriter, defaults to wrapping {@link System#out}.</span>
+<span class="source-line-no">104</span><span id="line-104"> *</span>
+<span class="source-line-no">105</span><span id="line-105"> * @param
printWriter the output PrintWriter, not null.</span>
+<span class="source-line-no">106</span><span id="line-106"> * @return
{@code this} instance.</span>
+<span class="source-line-no">107</span><span id="line-107"> */</span>
+<span class="source-line-no">108</span><span id="line-108"> public
Builder setPrintWriter(final PrintWriter printWriter) {</span>
+<span class="source-line-no">109</span><span id="line-109">
this.printStream = Objects.requireNonNull(printWriter, "printWriter");</span>
+<span class="source-line-no">110</span><span id="line-110"> return
this;</span>
+<span class="source-line-no">111</span><span id="line-111"> }</span>
+<span class="source-line-no">112</span><span id="line-112"></span>
+<span class="source-line-no">113</span><span id="line-113"> /**</span>
+<span class="source-line-no">114</span><span id="line-114"> * Sets
whether to show deprecated options.</span>
+<span class="source-line-no">115</span><span id="line-115"> *</span>
+<span class="source-line-no">116</span><span id="line-116"> * @param
useDefaultFormat if {@code true} use the default format, otherwise clear the
formatter.</span>
+<span class="source-line-no">117</span><span id="line-117"> * @return
{@code this} instance.</span>
+<span class="source-line-no">118</span><span id="line-118"> */</span>
+<span class="source-line-no">119</span><span id="line-119"> public
Builder setShowDeprecated(final boolean useDefaultFormat) {</span>
+<span class="source-line-no">120</span><span id="line-120"> return
setShowDeprecated(useDefaultFormat ? DEFAULT_DEPRECATED_FORMAT : null);</span>
+<span class="source-line-no">121</span><span id="line-121"> }</span>
+<span class="source-line-no">122</span><span id="line-122"></span>
+<span class="source-line-no">123</span><span id="line-123"> /**</span>
+<span class="source-line-no">124</span><span id="line-124"> * Sets
whether to show deprecated options.</span>
+<span class="source-line-no">125</span><span id="line-125"> *</span>
+<span class="source-line-no">126</span><span id="line-126"> * @param
deprecatedFormatFunction Specify the format for the deprecated options.</span>
+<span class="source-line-no">127</span><span id="line-127"> * @return
{@code this} instance.</span>
+<span class="source-line-no">128</span><span id="line-128"> * @since
1.8.0</span>
+<span class="source-line-no">129</span><span id="line-129"> */</span>
+<span class="source-line-no">130</span><span id="line-130"> public
Builder setShowDeprecated(final Function<Option, String>
deprecatedFormatFunction) {</span>
+<span class="source-line-no">131</span><span id="line-131">
this.deprecatedFormatFunction = deprecatedFormatFunction;</span>
+<span class="source-line-no">132</span><span id="line-132"> return
this;</span>
+<span class="source-line-no">133</span><span id="line-133"> }</span>
+<span class="source-line-no">134</span><span id="line-134"></span>
+<span class="source-line-no">135</span><span id="line-135"> /**</span>
+<span class="source-line-no">136</span><span id="line-136"> * Sets
whether to show the date the option was first added.</span>
+<span class="source-line-no">137</span><span id="line-137"> * @param
showSince if @{code true} the date the options was first added will be
shown.</span>
+<span class="source-line-no">138</span><span id="line-138"> * @return
this builder.</span>
+<span class="source-line-no">139</span><span id="line-139"> * @since
1.9.0</span>
+<span class="source-line-no">140</span><span id="line-140"> */</span>
+<span class="source-line-no">141</span><span id="line-141"> public
Builder setShowSince(final boolean showSince) {</span>
+<span class="source-line-no">142</span><span id="line-142">
this.showSince = showSince;</span>
+<span class="source-line-no">143</span><span id="line-143"> return
this;</span>
+<span class="source-line-no">144</span><span id="line-144"> }</span>
+<span class="source-line-no">145</span><span id="line-145"> }</span>
+<span class="source-line-no">146</span><span id="line-146"></span>
+<span class="source-line-no">147</span><span id="line-147"> /**</span>
+<span class="source-line-no">148</span><span id="line-148"> * This class
implements the {@code Comparator} interface for comparing Options.</span>
+<span class="source-line-no">149</span><span id="line-149"> */</span>
+<span class="source-line-no">150</span><span id="line-150"> private static
final class OptionComparator implements Comparator<Option>, Serializable
{</span>
+<span class="source-line-no">151</span><span id="line-151"></span>
+<span class="source-line-no">152</span><span id="line-152"> /** The
serial version UID. */</span>
+<span class="source-line-no">153</span><span id="line-153"> private
static final long serialVersionUID = 5305467873966684014L;</span>
+<span class="source-line-no">154</span><span id="line-154"></span>
+<span class="source-line-no">155</span><span id="line-155"> /**</span>
+<span class="source-line-no">156</span><span id="line-156"> * Compares
its two arguments for order. Returns a negative integer, zero, or a positive
integer as the first argument</span>
+<span class="source-line-no">157</span><span id="line-157"> * is less
than, equal to, or greater than the second.</span>
+<span class="source-line-no">158</span><span id="line-158"> *</span>
+<span class="source-line-no">159</span><span id="line-159"> * @param
opt1 The first Option to be compared.</span>
+<span class="source-line-no">160</span><span id="line-160"> * @param
opt2 The second Option to be compared.</span>
+<span class="source-line-no">161</span><span id="line-161"> * @return
a negative integer, zero, or a positive integer as the first argument is less
than, equal to, or greater than</span>
+<span class="source-line-no">162</span><span id="line-162"> *
the second.</span>
+<span class="source-line-no">163</span><span id="line-163"> */</span>
+<span class="source-line-no">164</span><span id="line-164">
@Override</span>
+<span class="source-line-no">165</span><span id="line-165"> public int
compare(final Option opt1, final Option opt2) {</span>
+<span class="source-line-no">166</span><span id="line-166"> return
opt1.getKey().compareToIgnoreCase(opt2.getKey());</span>
+<span class="source-line-no">167</span><span id="line-167"> }</span>
+<span class="source-line-no">168</span><span id="line-168"> }</span>
+<span class="source-line-no">169</span><span id="line-169"> /** "Options"
text for options header */</span>
+<span class="source-line-no">170</span><span id="line-170"> private static
final String HEADER_OPTIONS = "Options";</span>
<span class="source-line-no">171</span><span id="line-171"></span>
-<span class="source-line-no">172</span><span id="line-172"> /**</span>
-<span class="source-line-no">173</span><span id="line-173"> * Default
separator displayed between a long Option and its value</span>
-<span class="source-line-no">174</span><span id="line-174"> *</span>
-<span class="source-line-no">175</span><span id="line-175"> * @since
1.3</span>
-<span class="source-line-no">176</span><span id="line-176"> */</span>
-<span class="source-line-no">177</span><span id="line-177"> public static
final String DEFAULT_LONG_OPT_SEPARATOR = " ";</span>
-<span class="source-line-no">178</span><span id="line-178"></span>
-<span class="source-line-no">179</span><span id="line-179"> /** Default
name for an argument */</span>
-<span class="source-line-no">180</span><span id="line-180"> public static
final String DEFAULT_ARG_NAME = "arg";</span>
-<span class="source-line-no">181</span><span id="line-181"></span>
-<span class="source-line-no">182</span><span id="line-182"> /**</span>
-<span class="source-line-no">183</span><span id="line-183"> * Creates a
new builder.</span>
-<span class="source-line-no">184</span><span id="line-184"> *</span>
-<span class="source-line-no">185</span><span id="line-185"> * @return a
new builder.</span>
-<span class="source-line-no">186</span><span id="line-186"> * @since
1.7.0</span>
-<span class="source-line-no">187</span><span id="line-187"> */</span>
-<span class="source-line-no">188</span><span id="line-188"> public static
Builder builder() {</span>
-<span class="source-line-no">189</span><span id="line-189"> return new
Builder();</span>
-<span class="source-line-no">190</span><span id="line-190"> }</span>
-<span class="source-line-no">191</span><span id="line-191"></span>
-<span class="source-line-no">192</span><span id="line-192"> private static
PrintWriter createDefaultPrintWriter() {</span>
-<span class="source-line-no">193</span><span id="line-193"> return new
PrintWriter(System.out);</span>
-<span class="source-line-no">194</span><span id="line-194"> }</span>
+<span class="source-line-no">172</span><span id="line-172"> /** "Since"
text for options header */</span>
+<span class="source-line-no">173</span><span id="line-173"> private static
final String HEADER_SINCE = "Since";</span>
+<span class="source-line-no">174</span><span id="line-174"></span>
+<span class="source-line-no">175</span><span id="line-175"> /**
"Description" test for options header */</span>
+<span class="source-line-no">176</span><span id="line-176"> private static
final String HEADER_DESCRIPTION = "Description";</span>
+<span class="source-line-no">177</span><span id="line-177"></span>
+<span class="source-line-no">178</span><span id="line-178"> /** Default
number of characters per line */</span>
+<span class="source-line-no">179</span><span id="line-179"> public static
final int DEFAULT_WIDTH = 74;</span>
+<span class="source-line-no">180</span><span id="line-180"></span>
+<span class="source-line-no">181</span><span id="line-181"> /** Default
padding to the left of each line */</span>
+<span class="source-line-no">182</span><span id="line-182"> public static
final int DEFAULT_LEFT_PAD = 1;</span>
+<span class="source-line-no">183</span><span id="line-183"></span>
+<span class="source-line-no">184</span><span id="line-184"> /** Number of
space characters to be prefixed to each description line */</span>
+<span class="source-line-no">185</span><span id="line-185"> public static
final int DEFAULT_DESC_PAD = 3;</span>
+<span class="source-line-no">186</span><span id="line-186"></span>
+<span class="source-line-no">187</span><span id="line-187"> /** The string
to display at the beginning of the usage statement */</span>
+<span class="source-line-no">188</span><span id="line-188"> public static
final String DEFAULT_SYNTAX_PREFIX = "usage: ";</span>
+<span class="source-line-no">189</span><span id="line-189"></span>
+<span class="source-line-no">190</span><span id="line-190"> /** Default
prefix for shortOpts */</span>
+<span class="source-line-no">191</span><span id="line-191"> public static
final String DEFAULT_OPT_PREFIX = "-";</span>
+<span class="source-line-no">192</span><span id="line-192"></span>
+<span class="source-line-no">193</span><span id="line-193"> /** Default
prefix for long Option */</span>
+<span class="source-line-no">194</span><span id="line-194"> public static
final String DEFAULT_LONG_OPT_PREFIX = "--";</span>
<span class="source-line-no">195</span><span id="line-195"></span>
<span class="source-line-no">196</span><span id="line-196"> /**</span>
-<span class="source-line-no">197</span><span id="line-197"> * Gets the
option description or an empty string if the description is {@code null}.</span>
-<span class="source-line-no">198</span><span id="line-198"> * @param
option The option to get the description from.</span>
-<span class="source-line-no">199</span><span id="line-199"> * @return the
option description or an empty string if the description is {@code null}.</span>
-<span class="source-line-no">200</span><span id="line-200"> * @since
1.8.0</span>
-<span class="source-line-no">201</span><span id="line-201"> */</span>
-<span class="source-line-no">202</span><span id="line-202"> public static
String getDescription(final Option option) {</span>
-<span class="source-line-no">203</span><span id="line-203"> final
String desc = option.getDescription();</span>
-<span class="source-line-no">204</span><span id="line-204"> return desc
== null ? "" : desc;</span>
-<span class="source-line-no">205</span><span id="line-205"> }</span>
-<span class="source-line-no">206</span><span id="line-206"></span>
-<span class="source-line-no">207</span><span id="line-207"> /**</span>
-<span class="source-line-no">208</span><span id="line-208"> * Number of
characters per line</span>
-<span class="source-line-no">209</span><span id="line-209"> *</span>
-<span class="source-line-no">210</span><span id="line-210"> * @deprecated
Scope will be made private for next major version - use get/setWidth methods
instead.</span>
+<span class="source-line-no">197</span><span id="line-197"> * Default
separator displayed between a long Option and its value</span>
+<span class="source-line-no">198</span><span id="line-198"> *</span>
+<span class="source-line-no">199</span><span id="line-199"> * @since
1.3</span>
+<span class="source-line-no">200</span><span id="line-200"> */</span>
+<span class="source-line-no">201</span><span id="line-201"> public static
final String DEFAULT_LONG_OPT_SEPARATOR = " ";</span>
+<span class="source-line-no">202</span><span id="line-202"></span>
+<span class="source-line-no">203</span><span id="line-203"> /** Default
name for an argument */</span>
+<span class="source-line-no">204</span><span id="line-204"> public static
final String DEFAULT_ARG_NAME = "arg";</span>
+<span class="source-line-no">205</span><span id="line-205"></span>
+<span class="source-line-no">206</span><span id="line-206"> /**</span>
+<span class="source-line-no">207</span><span id="line-207"> * Creates a
new builder.</span>
+<span class="source-line-no">208</span><span id="line-208"> *</span>
+<span class="source-line-no">209</span><span id="line-209"> * @return a
new builder.</span>
+<span class="source-line-no">210</span><span id="line-210"> * @since
1.7.0</span>
<span class="source-line-no">211</span><span id="line-211"> */</span>
-<span class="source-line-no">212</span><span id="line-212">
@Deprecated</span>
-<span class="source-line-no">213</span><span id="line-213"> public int
defaultWidth = DEFAULT_WIDTH;</span>
-<span class="source-line-no">214</span><span id="line-214"></span>
-<span class="source-line-no">215</span><span id="line-215"> /**</span>
-<span class="source-line-no">216</span><span id="line-216"> * Amount of
padding to the left of each line</span>
-<span class="source-line-no">217</span><span id="line-217"> *</span>
-<span class="source-line-no">218</span><span id="line-218"> * @deprecated
Scope will be made private for next major version - use get/setLeftPadding
methods instead.</span>
-<span class="source-line-no">219</span><span id="line-219"> */</span>
-<span class="source-line-no">220</span><span id="line-220">
@Deprecated</span>
-<span class="source-line-no">221</span><span id="line-221"> public int
defaultLeftPad = DEFAULT_LEFT_PAD;</span>
-<span class="source-line-no">222</span><span id="line-222"></span>
-<span class="source-line-no">223</span><span id="line-223"> /**</span>
-<span class="source-line-no">224</span><span id="line-224"> * The number
of characters of padding to be prefixed to each description line</span>
-<span class="source-line-no">225</span><span id="line-225"> *</span>
-<span class="source-line-no">226</span><span id="line-226"> * @deprecated
Scope will be made private for next major version - use get/setDescPadding
methods instead.</span>
-<span class="source-line-no">227</span><span id="line-227"> */</span>
-<span class="source-line-no">228</span><span id="line-228">
@Deprecated</span>
-<span class="source-line-no">229</span><span id="line-229"> public int
defaultDescPad = DEFAULT_DESC_PAD;</span>
+<span class="source-line-no">212</span><span id="line-212"> public static
Builder builder() {</span>
+<span class="source-line-no">213</span><span id="line-213"> return new
Builder();</span>
+<span class="source-line-no">214</span><span id="line-214"> }</span>
+<span class="source-line-no">215</span><span id="line-215"></span>
+<span class="source-line-no">216</span><span id="line-216"> private static
PrintWriter createDefaultPrintWriter() {</span>
+<span class="source-line-no">217</span><span id="line-217"> return new
PrintWriter(System.out);</span>
+<span class="source-line-no">218</span><span id="line-218"> }</span>
+<span class="source-line-no">219</span><span id="line-219"></span>
+<span class="source-line-no">220</span><span id="line-220"> /**</span>
+<span class="source-line-no">221</span><span id="line-221"> * Gets the
option description or an empty string if the description is {@code null}.</span>
+<span class="source-line-no">222</span><span id="line-222"> * @param
option The option to get the description from.</span>
+<span class="source-line-no">223</span><span id="line-223"> * @return the
option description or an empty string if the description is {@code null}.</span>
+<span class="source-line-no">224</span><span id="line-224"> * @since
1.8.0</span>
+<span class="source-line-no">225</span><span id="line-225"> */</span>
+<span class="source-line-no">226</span><span id="line-226"> public static
String getDescription(final Option option) {</span>
+<span class="source-line-no">227</span><span id="line-227"> final
String desc = option.getDescription();</span>
+<span class="source-line-no">228</span><span id="line-228"> return desc
== null ? "" : desc;</span>
+<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> /**</span>
-<span class="source-line-no">232</span><span id="line-232"> * The string
to display at the beginning of the usage statement</span>
+<span class="source-line-no">232</span><span id="line-232"> * Number of
characters per line</span>
<span class="source-line-no">233</span><span id="line-233"> *</span>
-<span class="source-line-no">234</span><span id="line-234"> * @deprecated
Scope will be made private for next major version - use get/setSyntaxPrefix
methods instead.</span>
+<span class="source-line-no">234</span><span id="line-234"> * @deprecated
Scope will be made private for next major version - use get/setWidth methods
instead.</span>
<span class="source-line-no">235</span><span id="line-235"> */</span>
<span class="source-line-no">236</span><span id="line-236">
@Deprecated</span>
-<span class="source-line-no">237</span><span id="line-237"> public String
defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX;</span>
+<span class="source-line-no">237</span><span id="line-237"> public int
defaultWidth = DEFAULT_WIDTH;</span>
<span class="source-line-no">238</span><span id="line-238"></span>
<span class="source-line-no">239</span><span id="line-239"> /**</span>
-<span class="source-line-no">240</span><span id="line-240"> * The new line
string</span>
+<span class="source-line-no">240</span><span id="line-240"> * Amount of
padding to the left of each line</span>
<span class="source-line-no">241</span><span id="line-241"> *</span>
-<span class="source-line-no">242</span><span id="line-242"> * @deprecated
Scope will be made private for next major version - use get/setNewLine methods
instead.</span>
+<span class="source-line-no">242</span><span id="line-242"> * @deprecated
Scope will be made private for next major version - use get/setLeftPadding
methods instead.</span>
<span class="source-line-no">243</span><span id="line-243"> */</span>
<span class="source-line-no">244</span><span id="line-244">
@Deprecated</span>
-<span class="source-line-no">245</span><span id="line-245"> public String
defaultNewLine = System.lineSeparator();</span>
+<span class="source-line-no">245</span><span id="line-245"> public int
defaultLeftPad = DEFAULT_LEFT_PAD;</span>
<span class="source-line-no">246</span><span id="line-246"></span>
<span class="source-line-no">247</span><span id="line-247"> /**</span>
-<span class="source-line-no">248</span><span id="line-248"> * The shortOpt
prefix</span>
+<span class="source-line-no">248</span><span id="line-248"> * The number
of characters of padding to be prefixed to each description line</span>
<span class="source-line-no">249</span><span id="line-249"> *</span>
-<span class="source-line-no">250</span><span id="line-250"> * @deprecated
Scope will be made private for next major version - use get/setOptPrefix
methods instead.</span>
+<span class="source-line-no">250</span><span id="line-250"> * @deprecated
Scope will be made private for next major version - use get/setDescPadding
methods instead.</span>
<span class="source-line-no">251</span><span id="line-251"> */</span>
<span class="source-line-no">252</span><span id="line-252">
@Deprecated</span>
-<span class="source-line-no">253</span><span id="line-253"> public String
defaultOptPrefix = DEFAULT_OPT_PREFIX;</span>
+<span class="source-line-no">253</span><span id="line-253"> public int
defaultDescPad = DEFAULT_DESC_PAD;</span>
<span class="source-line-no">254</span><span id="line-254"></span>
<span class="source-line-no">255</span><span id="line-255"> /**</span>
-<span class="source-line-no">256</span><span id="line-256"> * The long Opt
prefix</span>
+<span class="source-line-no">256</span><span id="line-256"> * The string
to display at the beginning of the usage statement</span>
<span class="source-line-no">257</span><span id="line-257"> *</span>
-<span class="source-line-no">258</span><span id="line-258"> * @deprecated
Scope will be made private for next major version - use get/setLongOptPrefix
methods instead.</span>
+<span class="source-line-no">258</span><span id="line-258"> * @deprecated
Scope will be made private for next major version - use get/setSyntaxPrefix
methods instead.</span>
<span class="source-line-no">259</span><span id="line-259"> */</span>
<span class="source-line-no">260</span><span id="line-260">
@Deprecated</span>
-<span class="source-line-no">261</span><span id="line-261"> public String
defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX;</span>
+<span class="source-line-no">261</span><span id="line-261"> public String
defaultSyntaxPrefix = DEFAULT_SYNTAX_PREFIX;</span>
<span class="source-line-no">262</span><span id="line-262"></span>
<span class="source-line-no">263</span><span id="line-263"> /**</span>
-<span class="source-line-no">264</span><span id="line-264"> * The name of
the argument</span>
+<span class="source-line-no">264</span><span id="line-264"> * The new line
string</span>
<span class="source-line-no">265</span><span id="line-265"> *</span>
-<span class="source-line-no">266</span><span id="line-266"> * @deprecated
Scope will be made private for next major version - use get/setArgName methods
instead.</span>
+<span class="source-line-no">266</span><span id="line-266"> * @deprecated
Scope will be made private for next major version - use get/setNewLine methods
instead.</span>
<span class="source-line-no">267</span><span id="line-267"> */</span>
<span class="source-line-no">268</span><span id="line-268">
@Deprecated</span>
-<span class="source-line-no">269</span><span id="line-269"> public String
defaultArgName = DEFAULT_ARG_NAME;</span>
+<span class="source-line-no">269</span><span id="line-269"> public String
defaultNewLine = System.lineSeparator();</span>
<span class="source-line-no">270</span><span id="line-270"></span>
<span class="source-line-no">271</span><span id="line-271"> /**</span>
-<span class="source-line-no">272</span><span id="line-272"> * Comparator
used to sort the options when they output in help text</span>
+<span class="source-line-no">272</span><span id="line-272"> * The shortOpt
prefix</span>
<span class="source-line-no">273</span><span id="line-273"> *</span>
-<span class="source-line-no">274</span><span id="line-274"> * Defaults to
case-insensitive alphabetical sorting by option key</span>
+<span class="source-line-no">274</span><span id="line-274"> * @deprecated
Scope will be made private for next major version - use get/setOptPrefix
methods instead.</span>
<span class="source-line-no">275</span><span id="line-275"> */</span>
-<span class="source-line-no">276</span><span id="line-276"> protected
Comparator<Option> optionComparator = new OptionComparator();</span>
-<span class="source-line-no">277</span><span id="line-277"></span>
-<span class="source-line-no">278</span><span id="line-278"> /**</span>
-<span class="source-line-no">279</span><span id="line-279"> * Function to
format the description for a deprecated option.</span>
-<span class="source-line-no">280</span><span id="line-280"> */</span>
-<span class="source-line-no">281</span><span id="line-281"> private final
Function<Option, String> deprecatedFormatFunc;</span>
-<span class="source-line-no">282</span><span id="line-282"></span>
-<span class="source-line-no">283</span><span id="line-283"> /**</span>
-<span class="source-line-no">284</span><span id="line-284"> * Where to
print help.</span>
-<span class="source-line-no">285</span><span id="line-285"> */</span>
-<span class="source-line-no">286</span><span id="line-286"> private final
PrintWriter printWriter;</span>
-<span class="source-line-no">287</span><span id="line-287"></span>
-<span class="source-line-no">288</span><span id="line-288"> /**</span>
-<span class="source-line-no">289</span><span id="line-289"> * The
separator displayed between the long option and its value.</span>
-<span class="source-line-no">290</span><span id="line-290"> */</span>
-<span class="source-line-no">291</span><span id="line-291"> private String
longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR;</span>
-<span class="source-line-no">292</span><span id="line-292"></span>
-<span class="source-line-no">293</span><span id="line-293"> /**</span>
-<span class="source-line-no">294</span><span id="line-294"> * Constructs a
new instance.</span>
-<span class="source-line-no">295</span><span id="line-295"> */</span>
-<span class="source-line-no">296</span><span id="line-296"> public
HelpFormatter() {</span>
-<span class="source-line-no">297</span><span id="line-297"> this(null,
createDefaultPrintWriter());</span>
-<span class="source-line-no">298</span><span id="line-298"> }</span>
-<span class="source-line-no">299</span><span id="line-299"></span>
-<span class="source-line-no">300</span><span id="line-300"> /**</span>
-<span class="source-line-no">301</span><span id="line-301"> * Constructs a
new instance.</span>
-<span class="source-line-no">302</span><span id="line-302"> * @param
printStream TODO</span>
-<span class="source-line-no">303</span><span id="line-303"> */</span>
-<span class="source-line-no">304</span><span id="line-304"> private
HelpFormatter(final Function<Option, String> deprecatedFormatFunc, final
PrintWriter printStream) {</span>
-<span class="source-line-no">305</span><span id="line-305"> // TODO All
other instance HelpFormatter instance variables.</span>
-<span class="source-line-no">306</span><span id="line-306"> // Make
HelpFormatter immutable for 2.0</span>
-<span class="source-line-no">307</span><span id="line-307">
this.deprecatedFormatFunc = deprecatedFormatFunc;</span>
-<span class="source-line-no">308</span><span id="line-308">
this.printWriter = printStream;</span>
-<span class="source-line-no">309</span><span id="line-309"> }</span>
-<span class="source-line-no">310</span><span id="line-310"></span>
-<span class="source-line-no">311</span><span id="line-311"> /**</span>
-<span class="source-line-no">312</span><span id="line-312"> * Appends the
usage clause for an Option to a StringBuffer.</span>
-<span class="source-line-no">313</span><span id="line-313"> *</span>
-<span class="source-line-no">314</span><span id="line-314"> * @param buff
the StringBuffer to append to</span>
-<span class="source-line-no">315</span><span id="line-315"> * @param
option the Option to append</span>
-<span class="source-line-no">316</span><span id="line-316"> * @param
required whether the Option is required or not</span>
+<span class="source-line-no">276</span><span id="line-276">
@Deprecated</span>
+<span class="source-line-no">277</span><span id="line-277"> public String
defaultOptPrefix = DEFAULT_OPT_PREFIX;</span>
+<span class="source-line-no">278</span><span id="line-278"></span>
+<span class="source-line-no">279</span><span id="line-279"> /**</span>
+<span class="source-line-no">280</span><span id="line-280"> * The long Opt
prefix</span>
+<span class="source-line-no">281</span><span id="line-281"> *</span>
+<span class="source-line-no">282</span><span id="line-282"> * @deprecated
Scope will be made private for next major version - use get/setLongOptPrefix
methods instead.</span>
+<span class="source-line-no">283</span><span id="line-283"> */</span>
+<span class="source-line-no">284</span><span id="line-284">
@Deprecated</span>
+<span class="source-line-no">285</span><span id="line-285"> public String
defaultLongOptPrefix = DEFAULT_LONG_OPT_PREFIX;</span>
+<span class="source-line-no">286</span><span id="line-286"></span>
+<span class="source-line-no">287</span><span id="line-287"> /**</span>
+<span class="source-line-no">288</span><span id="line-288"> * The name of
the argument</span>
+<span class="source-line-no">289</span><span id="line-289"> *</span>
+<span class="source-line-no">290</span><span id="line-290"> * @deprecated
Scope will be made private for next major version - use get/setArgName methods
instead.</span>
+<span class="source-line-no">291</span><span id="line-291"> */</span>
+<span class="source-line-no">292</span><span id="line-292">
@Deprecated</span>
+<span class="source-line-no">293</span><span id="line-293"> public String
defaultArgName = DEFAULT_ARG_NAME;</span>
+<span class="source-line-no">294</span><span id="line-294"></span>
+<span class="source-line-no">295</span><span id="line-295"> /**</span>
+<span class="source-line-no">296</span><span id="line-296"> * Comparator
used to sort the options when they output in help text</span>
+<span class="source-line-no">297</span><span id="line-297"> *</span>
+<span class="source-line-no">298</span><span id="line-298"> * Defaults to
case-insensitive alphabetical sorting by option key</span>
+<span class="source-line-no">299</span><span id="line-299"> */</span>
+<span class="source-line-no">300</span><span id="line-300"> protected
Comparator<Option> optionComparator = new OptionComparator();</span>
+<span class="source-line-no">301</span><span id="line-301"></span>
+<span class="source-line-no">302</span><span id="line-302"> /**</span>
+<span class="source-line-no">303</span><span id="line-303"> * Function to
format the description for a deprecated option.</span>
+<span class="source-line-no">304</span><span id="line-304"> */</span>
+<span class="source-line-no">305</span><span id="line-305"> private final
Function<Option, String> deprecatedFormatFunction;</span>
+<span class="source-line-no">306</span><span id="line-306"></span>
+<span class="source-line-no">307</span><span id="line-307"> /**</span>
+<span class="source-line-no">308</span><span id="line-308"> * Where to
print help.</span>
+<span class="source-line-no">309</span><span id="line-309"> */</span>
+<span class="source-line-no">310</span><span id="line-310"> private final
PrintWriter printWriter;</span>
+<span class="source-line-no">311</span><span id="line-311"></span>
+<span class="source-line-no">312</span><span id="line-312"> /** Flag to
determine if since field should be displayed */</span>
+<span class="source-line-no">313</span><span id="line-313"> private final
boolean showSince;</span>
+<span class="source-line-no">314</span><span id="line-314"></span>
+<span class="source-line-no">315</span><span id="line-315"> /**</span>
+<span class="source-line-no">316</span><span id="line-316"> * The
separator displayed between the long option and its value.</span>
<span class="source-line-no">317</span><span id="line-317"> */</span>
-<span class="source-line-no">318</span><span id="line-318"> private void
appendOption(final StringBuffer buff, final Option option, final boolean
required) {</span>
-<span class="source-line-no">319</span><span id="line-319"> if
(!required) {</span>
-<span class="source-line-no">320</span><span id="line-320">
buff.append("[");</span>
-<span class="source-line-no">321</span><span id="line-321"> }</span>
-<span class="source-line-no">322</span><span id="line-322"> if
(option.getOpt() != null) {</span>
-<span class="source-line-no">323</span><span id="line-323">
buff.append("-").append(option.getOpt());</span>
-<span class="source-line-no">324</span><span id="line-324"> } else
{</span>
-<span class="source-line-no">325</span><span id="line-325">
buff.append("--").append(option.getLongOpt());</span>
-<span class="source-line-no">326</span><span id="line-326"> }</span>
-<span class="source-line-no">327</span><span id="line-327"> // if the
Option has a value and a non blank argname</span>
-<span class="source-line-no">328</span><span id="line-328"> if
(option.hasArg() && (option.getArgName() == null ||
!option.getArgName().isEmpty())) {</span>
-<span class="source-line-no">329</span><span id="line-329">
buff.append(option.getOpt() == null ? longOptSeparator : " ");</span>
-<span class="source-line-no">330</span><span id="line-330">
buff.append("<").append(option.getArgName() != null ? option.getArgName() :
getArgName()).append(">");</span>
-<span class="source-line-no">331</span><span id="line-331"> }</span>
-<span class="source-line-no">332</span><span id="line-332"> // if the
Option is not a required option</span>
-<span class="source-line-no">333</span><span id="line-333"> if
(!required) {</span>
-<span class="source-line-no">334</span><span id="line-334">
buff.append("]");</span>
-<span class="source-line-no">335</span><span id="line-335"> }</span>
-<span class="source-line-no">336</span><span id="line-336"> }</span>
-<span class="source-line-no">337</span><span id="line-337"></span>
-<span class="source-line-no">338</span><span id="line-338"> /**</span>
-<span class="source-line-no">339</span><span id="line-339"> * Appends the
usage clause for an OptionGroup to a StringBuffer. The clause is wrapped in
square brackets if the group</span>
-<span class="source-line-no">340</span><span id="line-340"> * is required.
The display of the options is handled by appendOption</span>
+<span class="source-line-no">318</span><span id="line-318"> private String
longOptSeparator = DEFAULT_LONG_OPT_SEPARATOR;</span>
+<span class="source-line-no">319</span><span id="line-319"></span>
+<span class="source-line-no">320</span><span id="line-320"> /**</span>
+<span class="source-line-no">321</span><span id="line-321"> * Constructs a
new instance.</span>
+<span class="source-line-no">322</span><span id="line-322"> */</span>
+<span class="source-line-no">323</span><span id="line-323"> public
HelpFormatter() {</span>
+<span class="source-line-no">324</span><span id="line-324"> this(null,
createDefaultPrintWriter(), false);</span>
+<span class="source-line-no">325</span><span id="line-325"> }</span>
+<span class="source-line-no">326</span><span id="line-326"></span>
+<span class="source-line-no">327</span><span id="line-327"> /**</span>
+<span class="source-line-no">328</span><span id="line-328"> * Constructs a
new instance.</span>
+<span class="source-line-no">329</span><span id="line-329"> * @param
printWriter TODO</span>
+<span class="source-line-no">330</span><span id="line-330"> */</span>
+<span class="source-line-no">331</span><span id="line-331"> private
HelpFormatter(final Function<Option, String> deprecatedFormatFunction,
final PrintWriter printWriter, final boolean showSince) {</span>
+<span class="source-line-no">332</span><span id="line-332"> // TODO All
other instance HelpFormatter instance variables.</span>
+<span class="source-line-no">333</span><span id="line-333"> // Make
HelpFormatter immutable for 2.0</span>
+<span class="source-line-no">334</span><span id="line-334">
this.deprecatedFormatFunction = deprecatedFormatFunction;</span>
+<span class="source-line-no">335</span><span id="line-335">
this.printWriter = printWriter;</span>
+<span class="source-line-no">336</span><span id="line-336">
this.showSince = showSince;</span>
+<span class="source-line-no">337</span><span id="line-337"> }</span>
+<span class="source-line-no">338</span><span id="line-338"></span>
+<span class="source-line-no">339</span><span id="line-339"> /**</span>
+<span class="source-line-no">340</span><span id="line-340"> * Appends the
usage clause for an Option to a StringBuffer.</span>
<span class="source-line-no">341</span><span id="line-341"> *</span>
<span class="source-line-no">342</span><span id="line-342"> * @param buff
the StringBuffer to append to</span>
-<span class="source-line-no">343</span><span id="line-343"> * @param group
the group to append</span>
-<span class="source-line-no">344</span><span id="line-344"> * @see
#appendOption(StringBuffer,Option,boolean)</span>
+<span class="source-line-no">343</span><span id="line-343"> * @param
option the Option to append</span>
+<span class="source-line-no">344</span><span id="line-344"> * @param
required whether the Option is required or not</span>
<span class="source-line-no">345</span><span id="line-345"> */</span>
-<span class="source-line-no">346</span><span id="line-346"> private void
appendOptionGroup(final StringBuffer buff, final OptionGroup group) {</span>
-<span class="source-line-no">347</span><span id="line-347"> if
(!group.isRequired()) {</span>
+<span class="source-line-no">346</span><span id="line-346"> private void
appendOption(final StringBuilder buff, final Option option, final boolean
required) {</span>
+<span class="source-line-no">347</span><span id="line-347"> if
(!required) {</span>
<span class="source-line-no">348</span><span id="line-348">
buff.append("[");</span>
<span class="source-line-no">349</span><span id="line-349"> }</span>
-<span class="source-line-no">350</span><span id="line-350"></span>
-<span class="source-line-no">351</span><span id="line-351"> final
List<Option> optList = new ArrayList<>(group.getOptions());</span>
-<span class="source-line-no">352</span><span id="line-352"> if
(getOptionComparator() != null) {</span>
-<span class="source-line-no">353</span><span id="line-353">
Collections.sort(optList, getOptionComparator());</span>
+<span class="source-line-no">350</span><span id="line-350"> if
(option.getOpt() != null) {</span>
+<span class="source-line-no">351</span><span id="line-351">
buff.append("-").append(option.getOpt());</span>
+<span class="source-line-no">352</span><span id="line-352"> } else
{</span>
+<span class="source-line-no">353</span><span id="line-353">
buff.append("--").append(option.getLongOpt());</span>
<span class="source-line-no">354</span><span id="line-354"> }</span>
-<span class="source-line-no">355</span><span id="line-355"> // for each
option in the OptionGroup</span>
-<span class="source-line-no">356</span><span id="line-356"> for (final
Iterator<Option> it = optList.iterator(); it.hasNext();) {</span>
-<span class="source-line-no">357</span><span id="line-357"> //
whether the option is required or not is handled at group level</span>
-<span class="source-line-no">358</span><span id="line-358">
appendOption(buff, it.next(), true);</span>
-<span class="source-line-no">359</span><span id="line-359"></span>
-<span class="source-line-no">360</span><span id="line-360"> if
(it.hasNext()) {</span>
-<span class="source-line-no">361</span><span id="line-361">
buff.append(" | ");</span>
-<span class="source-line-no">362</span><span id="line-362"> }</span>
+<span class="source-line-no">355</span><span id="line-355"> // if the
Option has a value and a non blank argname</span>
+<span class="source-line-no">356</span><span id="line-356"> if
(option.hasArg() && (option.getArgName() == null ||
!option.getArgName().isEmpty())) {</span>
+<span class="source-line-no">357</span><span id="line-357">
buff.append(option.getOpt() == null ? longOptSeparator : " ");</span>
+<span class="source-line-no">358</span><span id="line-358">
buff.append("<").append(option.getArgName() != null ? option.getArgName() :
getArgName()).append(">");</span>
+<span class="source-line-no">359</span><span id="line-359"> }</span>
+<span class="source-line-no">360</span><span id="line-360"> // if the
Option is not a required option</span>
+<span class="source-line-no">361</span><span id="line-361"> if
(!required) {</span>
+<span class="source-line-no">362</span><span id="line-362">
buff.append("]");</span>
<span class="source-line-no">363</span><span id="line-363"> }</span>
-<span class="source-line-no">364</span><span id="line-364"></span>
-<span class="source-line-no">365</span><span id="line-365"> if
(!group.isRequired()) {</span>
-<span class="source-line-no">366</span><span id="line-366">
buff.append("]");</span>
-<span class="source-line-no">367</span><span id="line-367"> }</span>
-<span class="source-line-no">368</span><span id="line-368"> }</span>
-<span class="source-line-no">369</span><span id="line-369"></span>
-<span class="source-line-no">370</span><span id="line-370"> /**</span>
-<span class="source-line-no">371</span><span id="line-371"> * Creates a
String of padding of length {@code len}.</span>
-<span class="source-line-no">372</span><span id="line-372"> *</span>
-<span class="source-line-no">373</span><span id="line-373"> * @param len
The length of the String of padding to create.</span>
-<span class="source-line-no">374</span><span id="line-374"> *</span>
-<span class="source-line-no">375</span><span id="line-375"> * @return The
String of padding</span>
-<span class="source-line-no">376</span><span id="line-376"> */</span>
-<span class="source-line-no">377</span><span id="line-377"> protected
String createPadding(final int len) {</span>
-<span class="source-line-no">378</span><span id="line-378"> final
char[] padding = new char[len];</span>
-<span class="source-line-no">379</span><span id="line-379">
Arrays.fill(padding, ' ');</span>
-<span class="source-line-no">380</span><span id="line-380"> return new
String(padding);</span>
-<span class="source-line-no">381</span><span id="line-381"> }</span>
-<span class="source-line-no">382</span><span id="line-382"></span>
-<span class="source-line-no">383</span><span id="line-383"> /**</span>
-<span class="source-line-no">384</span><span id="line-384"> * Finds the
next text wrap position after {@code startPos} for the text in {@code text}
with the column width</span>
-<span class="source-line-no">385</span><span id="line-385"> * {@code
width}. The wrap point is the last position before startPos+width having a
whitespace character (space,</span>
-<span class="source-line-no">386</span><span id="line-386"> * \n, \r). If
there is no whitespace character before startPos+width, it will return
startPos+width.</span>
-<span class="source-line-no">387</span><span id="line-387"> *</span>
-<span class="source-line-no">388</span><span id="line-388"> * @param text
The text being searched for the wrap position</span>
-<span class="source-line-no">389</span><span id="line-389"> * @param width
width of the wrapped text</span>
-<span class="source-line-no">390</span><span id="line-390"> * @param
startPos position from which to start the lookup whitespace character</span>
-<span class="source-line-no">391</span><span id="line-391"> * @return
position on which the text must be wrapped or -1 if the wrap position is at the
end of the text</span>
-<span class="source-line-no">392</span><span id="line-392"> */</span>
-<span class="source-line-no">393</span><span id="line-393"> protected int
findWrapPos(final String text, final int width, final int startPos) {</span>
-<span class="source-line-no">394</span><span id="line-394"> // the line
ends before the max wrap pos or a new line char found</span>
-<span class="source-line-no">395</span><span id="line-395"> int pos =
text.indexOf(Char.LF, startPos);</span>
-<span class="source-line-no">396</span><span id="line-396"> if (pos !=
-1 && pos <= width) {</span>
-<span class="source-line-no">397</span><span id="line-397"> return
pos + 1;</span>
-<span class="source-line-no">398</span><span id="line-398"> }</span>
-<span class="source-line-no">399</span><span id="line-399"> pos =
text.indexOf(Char.TAB, startPos);</span>
-<span class="source-line-no">400</span><span id="line-400"> if (pos !=
-1 && pos <= width) {</span>
-<span class="source-line-no">401</span><span id="line-401"> return
pos + 1;</span>
-<span class="source-line-no">402</span><span id="line-402"> }</span>
-<span class="source-line-no">403</span><span id="line-403"> if
(startPos + width >= text.length()) {</span>
-<span class="source-line-no">404</span><span id="line-404"> return
-1;</span>
-<span class="source-line-no">405</span><span id="line-405"> }</span>
-<span class="source-line-no">406</span><span id="line-406"> // look for
the last whitespace character before startPos+width</span>
-<span class="source-line-no">407</span><span id="line-407"> for (pos =
startPos + width; pos >= startPos; --pos) {</span>
-<span class="source-line-no">408</span><span id="line-408"> final
char c = text.charAt(pos);</span>
-<span class="source-line-no">409</span><span id="line-409"> if (c
== Char.SP || c == Char.LF || c == Char.CR) {</span>
-<span class="source-line-no">410</span><span id="line-410">
break;</span>
-<span class="source-line-no">411</span><span id="line-411"> }</span>
-<span class="source-line-no">412</span><span id="line-412"> }</span>
-<span class="source-line-no">413</span><span id="line-413"> // if we
found it - just return</span>
-<span class="source-line-no">414</span><span id="line-414"> if (pos
> startPos) {</span>
-<span class="source-line-no">415</span><span id="line-415"> return
pos;</span>
-<span class="source-line-no">416</span><span id="line-416"> }</span>
-<span class="source-line-no">417</span><span id="line-417"> // if we
didn't find one, simply chop at startPos+width</span>
-<span class="source-line-no">418</span><span id="line-418"> pos =
startPos + width;</span>
-<span class="source-line-no">419</span><span id="line-419"></span>
-<span class="source-line-no">420</span><span id="line-420"> return pos
== text.length() ? -1 : pos;</span>
-<span class="source-line-no">421</span><span id="line-421"> }</span>
-<span class="source-line-no">422</span><span id="line-422"></span>
-<span class="source-line-no">423</span><span id="line-423"> /**</span>
-<span class="source-line-no">424</span><span id="line-424"> * Gets the
'argName'.</span>
-<span class="source-line-no">425</span><span id="line-425"> *</span>
-<span class="source-line-no">426</span><span id="line-426"> * @return the
'argName'</span>
-<span class="source-line-no">427</span><span id="line-427"> */</span>
-<span class="source-line-no">428</span><span id="line-428"> public String
getArgName() {</span>
-<span class="source-line-no">429</span><span id="line-429"> return
defaultArgName;</span>
-<span class="source-line-no">430</span><span id="line-430"> }</span>
-<span class="source-line-no">431</span><span id="line-431"></span>
-<span class="source-line-no">432</span><span id="line-432"> /**</span>
-<span class="source-line-no">433</span><span id="line-433"> * Gets the
'descPadding'.</span>
-<span class="source-line-no">434</span><span id="line-434"> *</span>
-<span class="source-line-no">435</span><span id="line-435"> * @return the
'descPadding'</span>
-<span class="source-line-no">436</span><span id="line-436"> */</span>
-<span class="source-line-no">437</span><span id="line-437"> public int
getDescPadding() {</span>
-<span class="source-line-no">438</span><span id="line-438"> return
defaultDescPad;</span>
-<span class="source-line-no">439</span><span id="line-439"> }</span>
-<span class="source-line-no">440</span><span id="line-440"></span>
-<span class="source-line-no">441</span><span id="line-441"> /**</span>
-<span class="source-line-no">442</span><span id="line-442"> * Gets the
'leftPadding'.</span>
-<span class="source-line-no">443</span><span id="line-443"> *</span>
-<span class="source-line-no">444</span><span id="line-444"> * @return the
'leftPadding'</span>
-<span class="source-line-no">445</span><span id="line-445"> */</span>
-<span class="source-line-no">446</span><span id="line-446"> public int
getLeftPadding() {</span>
-<span class="source-line-no">447</span><span id="line-447"> return
defaultLeftPad;</span>
-<span class="source-line-no">448</span><span id="line-448"> }</span>
-<span class="source-line-no">449</span><span id="line-449"></span>
-<span class="source-line-no">450</span><span id="line-450"> /**</span>
-<span class="source-line-no">451</span><span id="line-451"> * Gets the
'longOptPrefix'.</span>
-<span class="source-line-no">452</span><span id="line-452"> *</span>
-<span class="source-line-no">453</span><span id="line-453"> * @return the
'longOptPrefix'</span>
-<span class="source-line-no">454</span><span id="line-454"> */</span>
-<span class="source-line-no">455</span><span id="line-455"> public String
getLongOptPrefix() {</span>
-<span class="source-line-no">456</span><span id="line-456"> return
defaultLongOptPrefix;</span>
-<span class="source-line-no">457</span><span id="line-457"> }</span>
-<span class="source-line-no">458</span><span id="line-458"></span>
-<span class="source-line-no">459</span><span id="line-459"> /**</span>
-<span class="source-line-no">460</span><span id="line-460"> * Gets the
separator displayed between a long option and its value.</span>
-<span class="source-line-no">461</span><span id="line-461"> *</span>
-<span class="source-line-no">462</span><span id="line-462"> * @return the
separator</span>
-<span class="source-line-no">463</span><span id="line-463"> * @since
1.3</span>
-<span class="source-line-no">464</span><span id="line-464"> */</span>
-<span class="source-line-no">465</span><span id="line-465"> public String
getLongOptSeparator() {</span>
-<span class="source-line-no">466</span><span id="line-466"> return
longOptSeparator;</span>
-<span class="source-line-no">467</span><span id="line-467"> }</span>
-<span class="source-line-no">468</span><span id="line-468"></span>
-<span class="source-line-no">469</span><span id="line-469"> /**</span>
-<span class="source-line-no">470</span><span id="line-470"> * Gets the
'newLine'.</span>
-<span class="source-line-no">471</span><span id="line-471"> *</span>
-<span class="source-line-no">472</span><span id="line-472"> * @return the
'newLine'</span>
-<span class="source-line-no">473</span><span id="line-473"> */</span>
-<span class="source-line-no">474</span><span id="line-474"> public String
getNewLine() {</span>
-<span class="source-line-no">475</span><span id="line-475"> return
defaultNewLine;</span>
-<span class="source-line-no">476</span><span id="line-476"> }</span>
-<span class="source-line-no">477</span><span id="line-477"></span>
-<span class="source-line-no">478</span><span id="line-478"> /**</span>
-<span class="source-line-no">479</span><span id="line-479"> * Comparator
used to sort the options when they output in help text. Defaults to
case-insensitive alphabetical sorting</span>
-<span class="source-line-no">480</span><span id="line-480"> * by option
key.</span>
-<span class="source-line-no">481</span><span id="line-481"> *</span>
-<span class="source-line-no">482</span><span id="line-482"> * @return the
{@link Comparator} currently in use to sort the options</span>
-<span class="source-line-no">483</span><span id="line-483"> * @since
1.2</span>
-<span class="source-line-no">484</span><span id="line-484"> */</span>
-<span class="source-line-no">485</span><span id="line-485"> public
Comparator<Option> getOptionComparator() {</span>
-<span class="source-line-no">486</span><span id="line-486"> return
optionComparator;</span>
-<span class="source-line-no">487</span><span id="line-487"> }</span>
-<span class="source-line-no">488</span><span id="line-488"></span>
-<span class="source-line-no">489</span><span id="line-489"> /**</span>
-<span class="source-line-no">490</span><span id="line-490"> * Gets the
'optPrefix'.</span>
-<span class="source-line-no">491</span><span id="line-491"> *</span>
-<span class="source-line-no">492</span><span id="line-492"> * @return the
'optPrefix'</span>
-<span class="source-line-no">493</span><span id="line-493"> */</span>
-<span class="source-line-no">494</span><span id="line-494"> public String
getOptPrefix() {</span>
-<span class="source-line-no">495</span><span id="line-495"> return
defaultOptPrefix;</span>
-<span class="source-line-no">496</span><span id="line-496"> }</span>
-<span class="source-line-no">497</span><span id="line-497"></span>
-<span class="source-line-no">498</span><span id="line-498"> /**</span>
-<span class="source-line-no">499</span><span id="line-499"> * Gets the
'syntaxPrefix'.</span>
-<span class="source-line-no">500</span><span id="line-500"> *</span>
-<span class="source-line-no">501</span><span id="line-501"> * @return the
'syntaxPrefix'</span>
-<span class="source-line-no">502</span><span id="line-502"> */</span>
-<span class="source-line-no">503</span><span id="line-503"> public String
getSyntaxPrefix() {</span>
-<span class="source-line-no">504</span><span id="line-504"> return
defaultSyntaxPrefix;</span>
-<span class="source-line-no">505</span><span id="line-505"> }</span>
-<span class="source-line-no">506</span><span id="line-506"></span>
-<span class="source-line-no">507</span><span id="line-507"> /**</span>
-<span class="source-line-no">508</span><span id="line-508"> * Gets the
'width'.</span>
-<span class="source-line-no">509</span><span id="line-509"> *</span>
-<span class="source-line-no">510</span><span id="line-510"> * @return the
'width'</span>
-<span class="source-line-no">511</span><span id="line-511"> */</span>
-<span class="source-line-no">512</span><span id="line-512"> public int
getWidth() {</span>
-<span class="source-line-no">513</span><span id="line-513"> return
defaultWidth;</span>
-<span class="source-line-no">514</span><span id="line-514"> }</span>
-<span class="source-line-no">515</span><span id="line-515"></span>
-<span class="source-line-no">516</span><span id="line-516"> /**</span>
-<span class="source-line-no">517</span><span id="line-517"> * Prints the
help for {@code options} with the specified command line syntax. This method
prints help information</span>
-<span class="source-line-no">518</span><span id="line-518"> * to {@link
System#out} by default.</span>
-<span class="source-line-no">519</span><span id="line-519"> *</span>
-<span class="source-line-no">520</span><span id="line-520"> * @param width
the number of characters to be displayed on each line</span>
-<span class="source-line-no">521</span><span id="line-521"> * @param
cmdLineSyntax the syntax for this application</span>
-<span class="source-line-no">522</span><span id="line-522"> * @param
header the banner to display at the beginning of the help</span>
-<span class="source-line-no">523</span><span id="line-523"> * @param
options the Options instance</span>
-<span class="source-line-no">524</span><span id="line-524"> * @param
footer the banner to display at the end of the help</span>
-<span class="source-line-no">525</span><span id="line-525"> */</span>
-<span class="source-line-no">526</span><span id="line-526"> public void
printHelp(final int width, final String cmdLineSyntax, final String header,
final Options options, final String footer) {</span>
-<span class="source-line-no">527</span><span id="line-527">
printHelp(width, cmdLineSyntax, header, options, footer, false);</span>
-<span class="source-line-no">528</span><span id="line-528"> }</span>
-<span class="source-line-no">529</span><span id="line-529"></span>
-<span class="source-line-no">530</span><span id="line-530"> /**</span>
-<span class="source-line-no">531</span><span id="line-531"> * Prints the
help for {@code options} with the specified command line syntax. This method
prints help information</span>
-<span class="source-line-no">532</span><span id="line-532"> * to {@link
System#out} by default.</span>
-<span class="source-line-no">533</span><span id="line-533"> *</span>
-<span class="source-line-no">534</span><span id="line-534"> * @param width
the number of characters to be displayed on each line</span>
-<span class="source-line-no">535</span><span id="line-535"> * @param
cmdLineSyntax the syntax for this application</span>
-<span class="source-line-no">536</span><span id="line-536"> * @param
header the banner to display at the beginning of the help</span>
-<span class="source-line-no">537</span><span id="line-537"> * @param
options the Options instance</span>
-<span class="source-line-no">538</span><span id="line-538"> * @param
footer the banner to display at the end of the help</span>
-<span class="source-line-no">539</span><span id="line-539"> * @param
autoUsage whether to print an automatically generated usage statement</span>
-<span class="source-line-no">540</span><span id="line-540"> */</span>
-<span class="source-line-no">541</span><span id="line-541"> public void
printHelp(final int width, final String cmdLineSyntax, final String header,
final Options options, final String footer,</span>
-<span class="source-line-no">542</span><span id="line-542"> final
boolean autoUsage) {</span>
-<span class="source-line-no">543</span><span id="line-543"> final
PrintWriter pw = new PrintWriter(printWriter);</span>
-<span class="source-line-no">544</span><span id="line-544">
printHelp(pw, width, cmdLineSyntax, header, options, getLeftPadding(),
getDescPadding(), footer, autoUsage);</span>
-<span class="source-line-no">545</span><span id="line-545">
pw.flush();</span>
-<span class="source-line-no">546</span><span id="line-546"> }</span>
-<span class="source-line-no">547</span><span id="line-547"></span>
-<span class="source-line-no">548</span><span id="line-548"> /**</span>
-<span class="source-line-no">549</span><span id="line-549"> * Prints the
help for {@code options} with the specified command line syntax.</span>
-<span class="source-line-no">550</span><span id="line-550"> *</span>
-<span class="source-line-no">551</span><span id="line-551"> * @param pw
the writer to which the help will be written</span>
-<span class="source-line-no">552</span><span id="line-552"> * @param width
the number of characters to be displayed on each line</span>
-<span class="source-line-no">553</span><span id="line-553"> * @param
cmdLineSyntax the syntax for this application</span>
-<span class="source-line-no">554</span><span id="line-554"> * @param
header the banner to display at the beginning of the help</span>
-<span class="source-line-no">555</span><span id="line-555"> * @param
options the Options instance</span>
-<span class="source-line-no">556</span><span id="line-556"> * @param
leftPad the number of characters of padding to be prefixed to each line</span>
-<span class="source-line-no">557</span><span id="line-557"> * @param
descPad the number of characters of padding to be prefixed to each description
line</span>
-<span class="source-line-no">558</span><span id="line-558"> * @param
footer the banner to display at the end of the help</span>
-<span class="source-line-no">559</span><span id="line-559"> *</span>
-<span class="source-line-no">560</span><span id="line-560"> * @throws
IllegalStateException if there is no room to print a line</span>
-<span class="source-line-no">561</span><span id="line-561"> */</span>
-<span class="source-line-no">562</span><span id="line-562"> public void
printHelp(final PrintWriter pw, final int width, final String cmdLineSyntax,
final String header, final Options options, final int leftPad,</span>
-<span class="source-line-no">563</span><span id="line-563"> final int
descPad, final String footer) {</span>
-<span class="source-line-no">564</span><span id="line-564">
printHelp(pw, width, cmdLineSyntax, header, options, leftPad, descPad, footer,
false);</span>
-<span class="source-line-no">565</span><span id="line-565"> }</span>
-<span class="source-line-no">566</span><span id="line-566"></span>
-<span class="source-line-no">567</span><span id="line-567"> /**</span>
-<span class="source-line-no">568</span><span id="line-568"> * Prints the
help for {@code options} with the specified command line syntax.</span>
-<span class="source-line-no">569</span><span id="line-569"> *</span>
-<span class="source-line-no">570</span><span id="line-570"> * @param pw
the writer to which the help will be written</span>
-<span class="source-line-no">571</span><span id="line-571"> * @param width
the number of characters to be displayed on each line</span>
-<span class="source-line-no">572</span><span id="line-572"> * @param
cmdLineSyntax the syntax for this application</span>
-<span class="source-line-no">573</span><span id="line-573"> * @param
header the banner to display at the beginning of the help</span>
-<span class="source-line-no">574</span><span id="line-574"> * @param
options the Options instance</span>
-<span class="source-line-no">575</span><span id="line-575"> * @param
leftPad the number of characters of padding to be prefixed to each line</span>
-<span class="source-line-no">576</span><span id="line-576"> * @param
descPad the number of characters of padding to be prefixed to each description
line</span>
-<span class="source-line-no">577</span><span id="line-577"> * @param
footer the banner to display at the end of the help</span>
-<span class="source-line-no">578</span><span id="line-578"> * @param
autoUsage whether to print an automatically generated usage statement</span>
-<span class="source-line-no">579</span><span id="line-579"> * @throws
IllegalStateException if there is no room to print a line</span>
-<span class="source-line-no">580</span><span id="line-580"> */</span>
-<span class="source-line-no">581</span><span id="line-581"> public void
printHelp(final PrintWriter pw, final int width, final String cmdLineSyntax,
final String header, final Options options, final int leftPad,</span>
-<span class="source-line-no">582</span><span id="line-582"> final int
descPad, final String footer, final boolean autoUsage) {</span>
-<span class="source-line-no">583</span><span id="line-583"> if
(Util.isEmpty(cmdLineSyntax)) {</span>
-<span class="source-line-no">584</span><span id="line-584"> throw
new IllegalArgumentException("cmdLineSyntax not provided");</span>
-<span class="source-line-no">585</span><span id="line-585"> }</span>
-<span class="source-line-no">586</span><span id="line-586"> if
(autoUsage) {</span>
-<span class="source-line-no">587</span><span id="line-587">
printUsage(pw, width, cmdLineSyntax, options);</span>
-<span class="source-line-no">588</span><span id="line-588"> } else
{</span>
-<span class="source-line-no">589</span><span id="line-589">
printUsage(pw, width, cmdLineSyntax);</span>
-<span class="source-line-no">590</span><span id="line-590"> }</span>
[... 1129 lines stripped ...]