Modified:
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html
==============================================================================
---
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html
(original)
+++
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/HelpFormatter.html
Thu Aug 15 00:03:23 2024
@@ -30,980 +30,1067 @@
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong
class="jxr_keyword">import</strong> java.io.PrintWriter;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong
class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong
class="jxr_keyword">import</strong> java.io.StringReader;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> java.util.ArrayList;
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> java.util.Arrays;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> java.util.Collection;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong> java.util.Collections;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> java.util.Comparator;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> java.util.Iterator;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> java.util.List;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong> java.util.function.Function;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> java.util.function.Supplier;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> * A formatter of help messages for command line
options.</em>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * Example:</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> * </p></em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * Options options = new Options();</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file
to be processed").hasArg().withArgName("FILE").isRequired().create('f'));</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print
the version of the application").create('v'));</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("help").create('h'));</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> * String header = "Do something useful with an
input file\n\n";</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * String footer = "\nPlease report issues at <a
href="https://example.com/issues"
target="alexandria_uri">https://example.com/issues</a>";</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment"> * HelpFormatter formatter = new
HelpFormatter();</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment"> * formatter.printHelp("myapp", header, options,
footer, true);</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> * This produces the following output:</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * </p></em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * usage: myapp -f &lt;FILE&gt; [-h]
[-v]</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * Do something useful with an input file</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> * -f,--file &lt;FILE&gt; The file to be
processed</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment"> * -h,--help</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment"> * -v,--version Print the version of the
application</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em
class="jxr_javadoccomment"> * Please report issues at <a
href="https://example.com/issues"
target="alexandria_uri">https://example.com/issues</a></em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>
{
-<a class="jxr_linenumber" name="L68" href="#L68">68</a>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em
class="jxr_javadoccomment"> * Builds {@link HelpFormatter}.</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">class</strong> Builder <strong
class="jxr_keyword">implements</strong> Supplier<HelpFormatter> {
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em
class="jxr_comment">// TODO All other instance HelpFormatter instance
variables.</em>
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em
class="jxr_comment">// Make HelpFormatter immutable for 2.0</em>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em
class="jxr_javadoccomment"> * A function to convert a description (not
null) and a deprecated Option (not null) to help description</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
Function<Option, String> DEFAULT_DEPRECATED_FORMAT = o -> <span
class="jxr_string">"[Deprecated] "</span> + getDescription(o);
-<a class="jxr_linenumber" name="L82" href="#L82">82</a>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment"> * Formatter for deprecated options.</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong
class="jxr_keyword">private</strong> Function<Option, String>
deprecatedFormatFunc = DEFAULT_DEPRECATED_FORMAT;
-<a class="jxr_linenumber" name="L87" href="#L87">87</a>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment"> * The output PrintWriter, defaults to
wrapping {@link System#out}.</em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong
class="jxr_keyword">private</strong> PrintWriter printStream =
createDefaultPrintWriter();
-<a class="jxr_linenumber" name="L92" href="#L92">92</a>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> @Override
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong
class="jxr_keyword">public</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>
get() {
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a
name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>(deprecatedFormatFunc,
printStream);
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
-<a class="jxr_linenumber" name="L97" href="#L97">97</a>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> * Sets the output PrintWriter, defaults to
wrapping {@link System#out}.</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em
class="jxr_javadoccomment"> * @param printWriter the output
PrintWriter, not null.</em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong
class="jxr_keyword">public</strong> Builder setPrintWriter(<strong
class="jxr_keyword">final</strong> PrintWriter printWriter) {
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong
class="jxr_keyword">this</strong>.printStream =
Objects.requireNonNull(printWriter, <span
class="jxr_string">"printWriter"</span>);
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
-<a class="jxr_linenumber" name="L108" href="#L108">108</a>
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment"> * Sets whether to show deprecated
options.</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em
class="jxr_javadoccomment"> * @param useDefaultFormat if {@code true}
use the default format, otherwise clear the formatter.</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong
class="jxr_keyword">public</strong> Builder setShowDeprecated(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
useDefaultFormat) {
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong
class="jxr_keyword">return</strong> setShowDeprecated(useDefaultFormat ?
DEFAULT_DEPRECATED_FORMAT : <strong class="jxr_keyword">null</strong>);
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
-<a class="jxr_linenumber" name="L118" href="#L118">118</a>
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em
class="jxr_javadoccomment"> * Sets whether to show deprecated
options.</em>
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em
class="jxr_javadoccomment"> * @param showDeprecatedFunc Specify the
format for the deprecated options.</em>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * @since 1.8.0</em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong
class="jxr_keyword">public</strong> Builder setShowDeprecated(<strong
class="jxr_keyword">final</strong> Function<Option, String>
showDeprecatedFunc) {
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong
class="jxr_keyword">this</strong>.deprecatedFormatFunc = showDeprecatedFunc;
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em
class="jxr_javadoccomment"> * This class implements the {@code Comparator}
interface for comparing Options.</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">class</strong> OptionComparator <strong
class="jxr_keyword">implements</strong> Comparator<Option>, Serializable {
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment">/** The serial version UID. */</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">long</strong> serialVersionUID =
5305467873966684014L;
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em
class="jxr_javadoccomment"> * Compares its two arguments for order.
Returns a negative integer, zero, or a positive integer as the first
argument</em>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> * is less than, equal to, or greater than
the second.</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> * @param opt1 The first Option to be
compared.</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * @param opt2 The second Option to be
compared.</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> * @return a negative integer, zero, or a
positive integer as the first argument is less than, equal to, or greater
than</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * the second.</em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Override
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
compare(<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> opt1,
<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> opt2) {
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong
class="jxr_keyword">return</strong>
opt1.getKey().compareToIgnoreCase(opt2.getKey());
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment">/** Default number of characters per line */</em>
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_WIDTH = 74;
-<a class="jxr_linenumber" name="L156" href="#L156">156</a>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment">/** Default padding to the left of each line */</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_LEFT_PAD = 1;
-<a class="jxr_linenumber" name="L159" href="#L159">159</a>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment">/** Number of space characters to be prefixed to
each description line */</em>
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_DESC_PAD = 3;
-<a class="jxr_linenumber" name="L162" href="#L162">162</a>
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment">/** The string to display at the beginning of the
usage statement */</em>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_SYNTAX_PREFIX = <span
class="jxr_string">"usage: "</span>;
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment">/** Default prefix for shortOpts */</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_OPT_PREFIX = <span
class="jxr_string">"-"</span>;
-<a class="jxr_linenumber" name="L168" href="#L168">168</a>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment">/** Default prefix for long Option */</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_PREFIX =
<span class="jxr_string">"--"</span>;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> java.io.UncheckedIOException;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> java.util.Arrays;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong> java.util.Collection;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> java.util.Comparator;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> java.util.Iterator;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> java.util.function.Function;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong> java.util.function.Supplier;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> * A formatter of help messages for command line
options.</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> * Example:</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * <pre></em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * Options options = new Options();</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file
to be processed").hasArg().withArgName("FILE").isRequired().create('f'));</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print
the version of the application").create('v'));</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> *
options.addOption(OptionBuilder.withLongOpt("help").create('h'));</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * String header = "Do something useful with an
input file\n\n";</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> * String footer = "\nPlease report issues at <a
href="https://example.com/issues"
target="alexandria_uri">https://example.com/issues</a>";</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment"> * HelpFormatter formatter = new
HelpFormatter();</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> * formatter.printHelp("myapp", header, options,
footer, true);</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> * </pre></em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * This produces the following output:</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * <pre></em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * usage: myapp -f &lt;FILE&gt; [-h]
[-v]</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> * Do something useful with an input file</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment"> * -f,--file &lt;FILE&gt; The file to be
processed</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment"> * -h,--help</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> * -v,--version Print the version of the
application</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment"> * Please report issues at <a
href="https://example.com/issues"
target="alexandria_uri">https://example.com/issues</a></em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> * </pre></em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>
{
+<a class="jxr_linenumber" name="L69" href="#L69">69</a>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em
class="jxr_javadoccomment"> * Builds {@link HelpFormatter}.</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">class</strong> Builder <strong
class="jxr_keyword">implements</strong> Supplier<HelpFormatter> {
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em
class="jxr_comment">// TODO All other instance HelpFormatter instance
variables.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em
class="jxr_comment">// Make HelpFormatter immutable for 2.0</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em
class="jxr_javadoccomment"> * A function to convert a description (not
null) and a deprecated Option (not null) to help description</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
Function<Option, String> DEFAULT_DEPRECATED_FORMAT = o -> <span
class="jxr_string">"[Deprecated] "</span> + getDescription(o);
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> * Formatter for deprecated options.</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong
class="jxr_keyword">private</strong> Function<Option, String>
deprecatedFormatFunction = DEFAULT_DEPRECATED_FORMAT;
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> * The output PrintWriter, defaults to
wrapping {@link System#out}.</em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong
class="jxr_keyword">private</strong> PrintWriter printStream =
createDefaultPrintWriter();
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment">/** The flag to determine if the since values should
be dispalyed */</em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> showSince;
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Override
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong
class="jxr_keyword">public</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>
get() {
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a
name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>(deprecatedFormatFunction,
printStream, showSince);
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_javadoccomment"> * Sets the output PrintWriter, defaults to
wrapping {@link System#out}.</em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em
class="jxr_javadoccomment"> * @param printWriter the output
PrintWriter, not null.</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong
class="jxr_keyword">public</strong> Builder setPrintWriter(<strong
class="jxr_keyword">final</strong> PrintWriter printWriter) {
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong
class="jxr_keyword">this</strong>.printStream =
Objects.requireNonNull(printWriter, <span
class="jxr_string">"printWriter"</span>);
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em
class="jxr_javadoccomment"> * Sets whether to show deprecated
options.</em>
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em
class="jxr_javadoccomment"> * @param useDefaultFormat if {@code true}
use the default format, otherwise clear the formatter.</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong
class="jxr_keyword">public</strong> Builder setShowDeprecated(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
useDefaultFormat) {
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong
class="jxr_keyword">return</strong> setShowDeprecated(useDefaultFormat ?
DEFAULT_DEPRECATED_FORMAT : <strong class="jxr_keyword">null</strong>);
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * Sets whether to show deprecated
options.</em>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * @param deprecatedFormatFunction Specify
the format for the deprecated options.</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * @return {@code this} instance.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> * @since 1.8.0</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong
class="jxr_keyword">public</strong> Builder setShowDeprecated(<strong
class="jxr_keyword">final</strong> Function<Option, String>
deprecatedFormatFunction) {
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong
class="jxr_keyword">this</strong>.deprecatedFormatFunction =
deprecatedFormatFunction;
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment"> * Sets whether to show the date the option
was first added.</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment"> * @param showSince if @{code true} the date
the options was first added will be shown.</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment"> * @since 1.9.0</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong
class="jxr_keyword">public</strong> Builder setShowSince(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
showSince) {
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong
class="jxr_keyword">this</strong>.showSince = showSince;
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
+<a class="jxr_linenumber" name="L146" href="#L146">146</a>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * This class implements the {@code Comparator}
interface for comparing Options.</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">class</strong> OptionComparator <strong
class="jxr_keyword">implements</strong> Comparator<Option>, Serializable {
+<a class="jxr_linenumber" name="L151" href="#L151">151</a>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment">/** The serial version UID. */</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">long</strong> serialVersionUID =
5305467873966684014L;
+<a class="jxr_linenumber" name="L154" href="#L154">154</a>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * Compares its two arguments for order.
Returns a negative integer, zero, or a positive integer as the first
argument</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * is less than, equal to, or greater than
the second.</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * @param opt1 The first Option to be
compared.</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * @param opt2 The second Option to be
compared.</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> * @return a negative integer, zero, or a
positive integer as the first argument is less than, equal to, or greater
than</em>
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> * the second.</em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> @Override
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
compare(<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> opt1,
<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> opt2) {
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong
class="jxr_keyword">return</strong>
opt1.getKey().compareToIgnoreCase(opt2.getKey());
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment">/** "Options" text for options header */</em>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String HEADER_OPTIONS = <span class="jxr_string">"Options"</span>;
<a class="jxr_linenumber" name="L171" href="#L171">171</a>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> * Default separator displayed between a long
Option and its value</em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment"> * @since 1.3</em>
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_SEPARATOR =
<span class="jxr_string">" "</span>;
-<a class="jxr_linenumber" name="L178" href="#L178">178</a>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment">/** Default name for an argument */</em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_ARG_NAME = <span
class="jxr_string">"arg"</span>;
-<a class="jxr_linenumber" name="L181" href="#L181">181</a>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> * Creates a new builder.</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * @return a new builder.</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder() {
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
Builder();
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
-<a class="jxr_linenumber" name="L191" href="#L191">191</a>
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> PrintWriter createDefaultPrintWriter() {
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
PrintWriter(System.out);
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment">/** "Since" text for options header */</em>
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String HEADER_SINCE = <span class="jxr_string">"Since"</span>;
+<a class="jxr_linenumber" name="L174" href="#L174">174</a>
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment">/** "Description" test for options header */</em>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String HEADER_DESCRIPTION = <span class="jxr_string">"Description"</span>;
+<a class="jxr_linenumber" name="L177" href="#L177">177</a>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment">/** Default number of characters per line */</em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_WIDTH = 74;
+<a class="jxr_linenumber" name="L180" href="#L180">180</a>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment">/** Default padding to the left of each line */</em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_LEFT_PAD = 1;
+<a class="jxr_linenumber" name="L183" href="#L183">183</a>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment">/** Number of space characters to be prefixed to
each description line */</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">int</strong> DEFAULT_DESC_PAD = 3;
+<a class="jxr_linenumber" name="L186" href="#L186">186</a>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment">/** The string to display at the beginning of the
usage statement */</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_SYNTAX_PREFIX = <span
class="jxr_string">"usage: "</span>;
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment">/** Default prefix for shortOpts */</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_OPT_PREFIX = <span
class="jxr_string">"-"</span>;
+<a class="jxr_linenumber" name="L192" href="#L192">192</a>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment">/** Default prefix for long Option */</em>
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_PREFIX =
<span class="jxr_string">"--"</span>;
<a class="jxr_linenumber" name="L195" href="#L195">195</a>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> * Gets the option description or an empty
string if the description is {@code null}.</em>
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @param option The option to get the
description from.</em>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @return the option description or an empty
string if the description is {@code null}.</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> * @since 1.8.0</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
String getDescription(<strong class="jxr_keyword">final</strong> <a
name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> option)
{
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong
class="jxr_keyword">final</strong> String desc = option.getDescription();
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong
class="jxr_keyword">return</strong> desc == <strong
class="jxr_keyword">null</strong> ? <span class="jxr_string">""</span> : desc;
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
-<a class="jxr_linenumber" name="L206" href="#L206">206</a>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em
class="jxr_javadoccomment"> * Number of characters per line</em>
-<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setWidth methods instead.</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> * Default separator displayed between a long
Option and its value</em>
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @since 1.3</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_LONG_OPT_SEPARATOR =
<span class="jxr_string">" "</span>;
+<a class="jxr_linenumber" name="L202" href="#L202">202</a>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment">/** Default name for an argument */</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">final</strong> String DEFAULT_ARG_NAME = <span
class="jxr_string">"arg"</span>;
+<a class="jxr_linenumber" name="L205" href="#L205">205</a>
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment"> * Creates a new builder.</em>
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em
class="jxr_javadoccomment"> * @return a new builder.</em>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L212" href="#L212">212</a> @Deprecated
-<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultWidth = DEFAULT_WIDTH;
-<a class="jxr_linenumber" name="L214" href="#L214">214</a>
-<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment"> * Amount of padding to the left of each
line</em>
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setLeftPadding methods instead.</em>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> @Deprecated
-<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultLeftPad = DEFAULT_LEFT_PAD;
-<a class="jxr_linenumber" name="L222" href="#L222">222</a>
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> * The number of characters of padding to be
prefixed to each description line</em>
-<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setDescPadding methods instead.</em>
-<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L228" href="#L228">228</a> @Deprecated
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultDescPad = DEFAULT_DESC_PAD;
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder() {
+<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
Builder();
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
+<a class="jxr_linenumber" name="L215" href="#L215">215</a>
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> PrintWriter createDefaultPrintWriter() {
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
PrintWriter(System.out);
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> }
+<a class="jxr_linenumber" name="L219" href="#L219">219</a>
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> * Gets the option description or an empty
string if the description is {@code null}.</em>
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment"> * @param option The option to get the
description from.</em>
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment"> * @return the option description or an empty
string if the description is {@code null}.</em>
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> * @since 1.8.0</em>
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
String getDescription(<strong class="jxr_keyword">final</strong> <a
name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> option)
{
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong
class="jxr_keyword">final</strong> String desc = option.getDescription();
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong
class="jxr_keyword">return</strong> desc == <strong
class="jxr_keyword">null</strong> ? <span class="jxr_string">""</span> : desc;
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> }
<a class="jxr_linenumber" name="L230" href="#L230">230</a>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em
class="jxr_javadoccomment"> * The string to display at the beginning of the
usage statement</em>
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em
class="jxr_javadoccomment"> * Number of characters per line</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setSyntaxPrefix methods instead.</em>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setWidth methods instead.</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> @Deprecated
-<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong
class="jxr_keyword">public</strong> String defaultSyntaxPrefix =
DEFAULT_SYNTAX_PREFIX;
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultWidth = DEFAULT_WIDTH;
<a class="jxr_linenumber" name="L238" href="#L238">238</a>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> * The new line string</em>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> * Amount of padding to the left of each
line</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setNewLine methods instead.</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setLeftPadding methods instead.</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> @Deprecated
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong
class="jxr_keyword">public</strong> String defaultNewLine =
System.lineSeparator();
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultLeftPad = DEFAULT_LEFT_PAD;
<a class="jxr_linenumber" name="L246" href="#L246">246</a>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em
class="jxr_javadoccomment"> * The shortOpt prefix</em>
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em
class="jxr_javadoccomment"> * The number of characters of padding to be
prefixed to each description line</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setOptPrefix methods instead.</em>
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setDescPadding methods instead.</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> @Deprecated
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong
class="jxr_keyword">public</strong> String defaultOptPrefix =
DEFAULT_OPT_PREFIX;
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
defaultDescPad = DEFAULT_DESC_PAD;
<a class="jxr_linenumber" name="L254" href="#L254">254</a>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> * The long Opt prefix</em>
+<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> * The string to display at the beginning of the
usage statement</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setLongOptPrefix methods instead.</em>
+<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setSyntaxPrefix methods instead.</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> @Deprecated
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong
class="jxr_keyword">public</strong> String defaultLongOptPrefix =
DEFAULT_LONG_OPT_PREFIX;
+<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong
class="jxr_keyword">public</strong> String defaultSyntaxPrefix =
DEFAULT_SYNTAX_PREFIX;
<a class="jxr_linenumber" name="L262" href="#L262">262</a>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment"> * The name of the argument</em>
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment"> * The new line string</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setArgName methods instead.</em>
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setNewLine methods instead.</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> @Deprecated
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong
class="jxr_keyword">public</strong> String defaultArgName = DEFAULT_ARG_NAME;
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong
class="jxr_keyword">public</strong> String defaultNewLine =
System.lineSeparator();
<a class="jxr_linenumber" name="L270" href="#L270">270</a>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> * Comparator used to sort the options when they
output in help text</em>
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> * The shortOpt prefix</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical
sorting by option key</em>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setOptPrefix methods instead.</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong
class="jxr_keyword">protected</strong> Comparator<Option>
optionComparator = <strong class="jxr_keyword">new</strong> OptionComparator();
-<a class="jxr_linenumber" name="L277" href="#L277">277</a>
-<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment"> * Function to format the description for a
deprecated option.</em>
-<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Function<Option, String> deprecatedFormatFunc;
-<a class="jxr_linenumber" name="L282" href="#L282">282</a>
-<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em
class="jxr_javadoccomment"> * Where to print help.</em>
-<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
PrintWriter printWriter;
-<a class="jxr_linenumber" name="L287" href="#L287">287</a>
-<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> * The separator displayed between the long
option and its value.</em>
-<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong
class="jxr_keyword">private</strong> String longOptSeparator =
DEFAULT_LONG_OPT_SEPARATOR;
-<a class="jxr_linenumber" name="L292" href="#L292">292</a>
-<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em
class="jxr_javadoccomment"> * Constructs a new instance.</em>
-<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong
class="jxr_keyword">public</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>()
{
-<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong
class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>,
createDefaultPrintWriter());
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
-<a class="jxr_linenumber" name="L299" href="#L299">299</a>
-<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em
class="jxr_javadoccomment"> * Constructs a new instance.</em>
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment"> * @param printStream TODO</em>
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong
class="jxr_keyword">private</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>(<strong
class="jxr_keyword">final</strong> Function<Option, String>
deprecatedFormatFunc, <strong class="jxr_keyword">final</strong> PrintWriter
printStream) {
-<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em
class="jxr_comment">// TODO All other instance HelpFormatter instance
variables.</em>
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em
class="jxr_comment">// Make HelpFormatter immutable for 2.0</em>
-<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong
class="jxr_keyword">this</strong>.deprecatedFormatFunc = deprecatedFormatFunc;
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong
class="jxr_keyword">this</strong>.printWriter = printStream;
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
-<a class="jxr_linenumber" name="L310" href="#L310">310</a>
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em
class="jxr_javadoccomment"> * Appends the usage clause for an Option to a
StringBuffer.</em>
-<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em
class="jxr_javadoccomment"> * @param buff the StringBuffer to append to</em>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment"> * @param option the Option to append</em>
-<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_javadoccomment"> * @param required whether the Option is
required or not</em>
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> @Deprecated
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong
class="jxr_keyword">public</strong> String defaultOptPrefix =
DEFAULT_OPT_PREFIX;
+<a class="jxr_linenumber" name="L278" href="#L278">278</a>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> * The long Opt prefix</em>
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setLongOptPrefix methods instead.</em>
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> @Deprecated
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong
class="jxr_keyword">public</strong> String defaultLongOptPrefix =
DEFAULT_LONG_OPT_PREFIX;
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em
class="jxr_javadoccomment"> * The name of the argument</em>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> * @deprecated Scope will be made private for
next major version - use get/setArgName methods instead.</em>
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> @Deprecated
+<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong
class="jxr_keyword">public</strong> String defaultArgName = DEFAULT_ARG_NAME;
+<a class="jxr_linenumber" name="L294" href="#L294">294</a>
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em
class="jxr_javadoccomment"> * Comparator used to sort the options when they
output in help text</em>
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em
class="jxr_javadoccomment"> * Defaults to case-insensitive alphabetical
sorting by option key</em>
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong
class="jxr_keyword">protected</strong> Comparator<Option>
optionComparator = <strong class="jxr_keyword">new</strong> OptionComparator();
+<a class="jxr_linenumber" name="L301" href="#L301">301</a>
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment"> * Function to format the description for a
deprecated option.</em>
+<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Function<Option, String> deprecatedFormatFunction;
+<a class="jxr_linenumber" name="L306" href="#L306">306</a>
+<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em
class="jxr_javadoccomment"> * Where to print help.</em>
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
PrintWriter printWriter;
+<a class="jxr_linenumber" name="L311" href="#L311">311</a>
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em
class="jxr_javadoccomment">/** Flag to determine if since field should be
displayed */</em>
+<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">boolean</strong> showSince;
+<a class="jxr_linenumber" name="L314" href="#L314">314</a>
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_javadoccomment"> * The separator displayed between the long
option and its value.</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
appendOption(<strong class="jxr_keyword">final</strong> StringBuffer buff,
<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> option,
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">boolean</strong> required) {
-<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong
class="jxr_keyword">if</strong> (!required) {
-<a class="jxr_linenumber" name="L320" href="#L320">320</a>
buff.append(<span class="jxr_string">"["</span>);
-<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong
class="jxr_keyword">if</strong> (option.getOpt() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L323" href="#L323">323</a>
buff.append(<span class="jxr_string">"-"</span>).append(option.getOpt());
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L325" href="#L325">325</a>
buff.append(<span class="jxr_string">"--"</span>).append(option.getLongOpt());
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
-<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em
class="jxr_comment">// if the Option has a value and a non blank argname</em>
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong
class="jxr_keyword">if</strong> (option.hasArg() &&
(option.getArgName() == <strong class="jxr_keyword">null</strong> ||
!option.getArgName().isEmpty())) {
-<a class="jxr_linenumber" name="L329" href="#L329">329</a>
buff.append(option.getOpt() == <strong class="jxr_keyword">null</strong> ?
longOptSeparator : <span class="jxr_string">" "</span>);
-<a class="jxr_linenumber" name="L330" href="#L330">330</a>
buff.append(<span class="jxr_string">"<"</span>).append(option.getArgName()
!= <strong class="jxr_keyword">null</strong> ? option.getArgName() :
getArgName()).append(<span class="jxr_string">">"</span>);
-<a class="jxr_linenumber" name="L331" href="#L331">331</a> }
-<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em
class="jxr_comment">// if the Option is not a required option</em>
-<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong
class="jxr_keyword">if</strong> (!required) {
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
buff.append(<span class="jxr_string">"]"</span>);
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> }
-<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
-<a class="jxr_linenumber" name="L337" href="#L337">337</a>
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em
class="jxr_javadoccomment"> * Appends the usage clause for an OptionGroup
to a StringBuffer. The clause is wrapped in square brackets if the group</em>
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em
class="jxr_javadoccomment"> * is required. The display of the options is
handled by appendOption</em>
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong
class="jxr_keyword">private</strong> String longOptSeparator =
DEFAULT_LONG_OPT_SEPARATOR;
+<a class="jxr_linenumber" name="L319" href="#L319">319</a>
+<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em
class="jxr_javadoccomment"> * Constructs a new instance.</em>
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong
class="jxr_keyword">public</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>()
{
+<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong
class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>,
createDefaultPrintWriter(), false);
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> }
+<a class="jxr_linenumber" name="L326" href="#L326">326</a>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em
class="jxr_javadoccomment"> * Constructs a new instance.</em>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em
class="jxr_javadoccomment"> * @param printWriter TODO</em>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong
class="jxr_keyword">private</strong> <a name="HelpFormatter"
href="../../../../org/apache/commons/cli/HelpFormatter.html#HelpFormatter">HelpFormatter</a>(<strong
class="jxr_keyword">final</strong> Function<Option, String>
deprecatedFormatFunction, <strong class="jxr_keyword">final</strong>
PrintWriter printWriter, <strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">boolean</strong> showSince) {
+<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em
class="jxr_comment">// TODO All other instance HelpFormatter instance
variables.</em>
+<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em
class="jxr_comment">// Make HelpFormatter immutable for 2.0</em>
+<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong
class="jxr_keyword">this</strong>.deprecatedFormatFunction =
deprecatedFormatFunction;
+<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong
class="jxr_keyword">this</strong>.printWriter = printWriter;
+<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong
class="jxr_keyword">this</strong>.showSince = showSince;
+<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
+<a class="jxr_linenumber" name="L338" href="#L338">338</a>
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em
class="jxr_javadoccomment"> * Appends the usage clause for an Option to a
StringBuffer.</em>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em
class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em
class="jxr_javadoccomment"> * @param buff the StringBuffer to append to</em>
-<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em
class="jxr_javadoccomment"> * @param group the group to append</em>
-<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em
class="jxr_javadoccomment"> * @see
#appendOption(StringBuffer,Option,boolean)</em>
+<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em
class="jxr_javadoccomment"> * @param option the Option to append</em>
+<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em
class="jxr_javadoccomment"> * @param required whether the Option is
required or not</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
appendOptionGroup(<strong class="jxr_keyword">final</strong> StringBuffer buff,
<strong class="jxr_keyword">final</strong> <a name="OptionGroup"
href="../../../../org/apache/commons/cli/OptionGroup.html#OptionGroup">OptionGroup</a>
group) {
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong
class="jxr_keyword">if</strong> (!group.isRequired()) {
+<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
appendOption(<strong class="jxr_keyword">final</strong> StringBuilder buff,
<strong class="jxr_keyword">final</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> option,
<strong class="jxr_keyword">final</strong> <strong
class="jxr_keyword">boolean</strong> required) {
+<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong
class="jxr_keyword">if</strong> (!required) {
<a class="jxr_linenumber" name="L348" href="#L348">348</a>
buff.append(<span class="jxr_string">"["</span>);
<a class="jxr_linenumber" name="L349" href="#L349">349</a> }
-<a class="jxr_linenumber" name="L350" href="#L350">350</a>
-<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong
class="jxr_keyword">final</strong> List<Option> optList = <strong
class="jxr_keyword">new</strong> ArrayList<>(group.getOptions());
-<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong
class="jxr_keyword">if</strong> (getOptionComparator() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L353" href="#L353">353</a>
Collections.sort(optList, getOptionComparator());
+<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong
class="jxr_keyword">if</strong> (option.getOpt() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L351" href="#L351">351</a>
buff.append(<span class="jxr_string">"-"</span>).append(option.getOpt());
+<a class="jxr_linenumber" name="L352" href="#L352">352</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L353" href="#L353">353</a>
buff.append(<span class="jxr_string">"--"</span>).append(option.getLongOpt());
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em
class="jxr_comment">// for each option in the OptionGroup</em>
-<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong
class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong>
Iterator<Option> it = optList.iterator(); it.hasNext();) {
-<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em
class="jxr_comment">// whether the option is required or not is handled at
group level</em>
-<a class="jxr_linenumber" name="L358" href="#L358">358</a>
appendOption(buff, it.next(), <strong class="jxr_keyword">true</strong>);
-<a class="jxr_linenumber" name="L359" href="#L359">359</a>
-<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong
class="jxr_keyword">if</strong> (it.hasNext()) {
-<a class="jxr_linenumber" name="L361" href="#L361">361</a>
buff.append(<span class="jxr_string">" | "</span>);
-<a class="jxr_linenumber" name="L362" href="#L362">362</a> }
+<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em
class="jxr_comment">// if the Option has a value and a non blank argname</em>
+<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong
class="jxr_keyword">if</strong> (option.hasArg() &&
(option.getArgName() == <strong class="jxr_keyword">null</strong> ||
!option.getArgName().isEmpty())) {
+<a class="jxr_linenumber" name="L357" href="#L357">357</a>
buff.append(option.getOpt() == <strong class="jxr_keyword">null</strong> ?
longOptSeparator : <span class="jxr_string">" "</span>);
+<a class="jxr_linenumber" name="L358" href="#L358">358</a>
buff.append(<span class="jxr_string">"<"</span>).append(option.getArgName()
!= <strong class="jxr_keyword">null</strong> ? option.getArgName() :
getArgName()).append(<span class="jxr_string">">"</span>);
+<a class="jxr_linenumber" name="L359" href="#L359">359</a> }
+<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em
class="jxr_comment">// if the Option is not a required option</em>
+<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong
class="jxr_keyword">if</strong> (!required) {
+<a class="jxr_linenumber" name="L362" href="#L362">362</a>
buff.append(<span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L363" href="#L363">363</a> }
-<a class="jxr_linenumber" name="L364" href="#L364">364</a>
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">if</strong> (!group.isRequired()) {
-<a class="jxr_linenumber" name="L366" href="#L366">366</a>
buff.append(<span class="jxr_string">"]"</span>);
-<a class="jxr_linenumber" name="L367" href="#L367">367</a> }
-<a class="jxr_linenumber" name="L368" href="#L368">368</a> }
-<a class="jxr_linenumber" name="L369" href="#L369">369</a>
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em
class="jxr_javadoccomment"> * Creates a String of padding of length {@code
len}.</em>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em
class="jxr_javadoccomment"> * @param len The length of the String of
padding to create.</em>
[... 1346 lines stripped ...]