Modified:
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/Option.html
==============================================================================
---
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/Option.html
(original)
+++
websites/production/commons/content/proper/commons-cli/xref/org/apache/commons/cli/Option.html
Thu Aug 15 00:03:23 2024
@@ -101,912 +101,937 @@
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment">/** Specifies whether this option is required to be
present. */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> required;
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment">/** The type of this Option. */</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong
class="jxr_keyword">private</strong> Class<?> type = DEFAULT_TYPE;
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment">/** Specifies the version when this option was
added. May be null */</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong
class="jxr_keyword">private</strong> String since;
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment">/** The character that is the value separator.
*/</em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>
valueSeparator;
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment">/** The type of this Option. */</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong
class="jxr_keyword">private</strong> Class<?> type = DEFAULT_TYPE;
<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"> * Constructs a new {@code Builder} with the
minimum required parameters for an {@code Option} instance.</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 option short representation of the
option.</em>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there
are any non valid Option characters in {@code opt}.</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">private</strong> Builder(<strong
class="jxr_keyword">final</strong> String option) <strong
class="jxr_keyword">throws</strong> IllegalArgumentException {
-<a class="jxr_linenumber" name="L109" href="#L109">109</a>
option(option);
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em
class="jxr_javadoccomment"> * Sets the display name for the argument
value.</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em
class="jxr_javadoccomment"> * @param argName the display name for the
argument value.</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">public</strong> Builder argName(<strong
class="jxr_keyword">final</strong> String argName) {
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong
class="jxr_keyword">this</strong>.argName = argName;
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</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"> * Constructs an Option with the values
declared by this {@link Builder}.</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"> * @return the new {@link Option}.</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if
neither {@code opt} or {@code longOpt} has been set.</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong
class="jxr_keyword">public</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> build()
{
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong
class="jxr_keyword">if</strong> (option == <strong
class="jxr_keyword">null</strong> && longOption == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> IllegalArgumentException(<span
class="jxr_string">"Either opt or longOpt must be specified"</span>);
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a
name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>(<strong
class="jxr_keyword">this</strong>);
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
-<a class="jxr_linenumber" name="L135" href="#L135">135</a>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment"> * Sets the converter for the option.</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> * Note: see {@link TypeHandler} for
serialization discussion.</em>
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em
class="jxr_javadoccomment"> * </p></em>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> * @param converter the Converter to
use.</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong
class="jxr_keyword">public</strong> Builder converter(<strong
class="jxr_keyword">final</strong> Converter<?, ?> converter) {
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong
class="jxr_keyword">this</strong>.converter = converter;
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> }
-<a class="jxr_linenumber" name="L151" href="#L151">151</a>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> * Marks this Option as deprecated.</em>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong
class="jxr_keyword">public</strong> Builder deprecated() {
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong
class="jxr_keyword">return</strong> deprecated(DeprecatedAttributes.DEFAULT);
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
-<a class="jxr_linenumber" name="L161" href="#L161">161</a>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> * Sets whether the Option is
deprecated.</em>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> * @param deprecated specifies whether the
Option is deprecated.</em>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong
class="jxr_keyword">public</strong> Builder deprecated(<strong
class="jxr_keyword">final</strong> <a name="DeprecatedAttributes"
href="../../../../org/apache/commons/cli/DeprecatedAttributes.html#DeprecatedAttributes">DeprecatedAttributes</a>
deprecated) {
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong
class="jxr_keyword">this</strong>.deprecated = deprecated;
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
-<a class="jxr_linenumber" name="L173" href="#L173">173</a>
-<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"> * Sets the description for this option.</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> <em
class="jxr_javadoccomment"> * @param description the description of the
option.</em>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong
class="jxr_keyword">public</strong> Builder desc(<strong
class="jxr_keyword">final</strong> String description) {
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong
class="jxr_keyword">this</strong>.description = description;
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> }
-<a class="jxr_linenumber" name="L184" href="#L184">184</a>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * Tests whether the Option will require an
argument.</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> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong
class="jxr_keyword">public</strong> Builder hasArg() {
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong
class="jxr_keyword">return</strong> hasArg(<strong
class="jxr_keyword">true</strong>);
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
-<a class="jxr_linenumber" name="L193" href="#L193">193</a>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * Tests whether the Option has an argument
or not.</em>
-<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"> * @param hasArg specifies whether the
Option takes an argument or not.</em>
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong
class="jxr_keyword">public</strong> Builder hasArg(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
hasArg) {
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_comment">// set to UNINITIALIZED when no arg is specified to be
compatible with OptionBuilder</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a>
argCount = hasArg ? 1 : UNINITIALIZED;
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
-<a class="jxr_linenumber" name="L205" href="#L205">205</a>
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment"> * Tests whether the Option can have
unlimited argument values.</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 this builder.</em>
-<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong
class="jxr_keyword">public</strong> Builder hasArgs() {
-<a class="jxr_linenumber" name="L212" href="#L212">212</a>
argCount = UNLIMITED_VALUES;
-<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
-<a class="jxr_linenumber" name="L215" href="#L215">215</a>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> * Sets the long name of the Option.</em>
-<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> * @param longOpt the long name of the
Option</em>
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong
class="jxr_keyword">public</strong> Builder longOpt(<strong
class="jxr_keyword">final</strong> String longOpt) {
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong
class="jxr_keyword">this</strong>.longOption = longOpt;
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
-<a class="jxr_linenumber" name="L226" href="#L226">226</a>
-<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> <em
class="jxr_javadoccomment"> * Sets the number of argument values the
Option can take.</em>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_javadoccomment"> * @param argCount the number of argument
values</em>
-<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong
class="jxr_keyword">public</strong> Builder numberOfArgs(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>
argCount) {
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong
class="jxr_keyword">this</strong>.argCount = argCount;
-<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
-<a class="jxr_linenumber" name="L237" href="#L237">237</a>
-<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * Sets the name of the Option.</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * @param option the name of the Option.</em>
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there
are any non valid Option characters in {@code opt}.</em>
-<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> * @since 1.5.0</em>
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong
class="jxr_keyword">public</strong> Builder option(<strong
class="jxr_keyword">final</strong> String option) <strong
class="jxr_keyword">throws</strong> IllegalArgumentException {
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong
class="jxr_keyword">this</strong>.option = OptionValidator.validate(option);
-<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
-<a class="jxr_linenumber" name="L250" href="#L250">250</a>
-<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> <em
class="jxr_javadoccomment"> * Sets whether the Option can have an
optional argument.</em>
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> * @param optionalArg specifies whether the
Option can have an optional argument.</em>
-<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong
class="jxr_keyword">public</strong> Builder optionalArg(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
optionalArg) {
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong
class="jxr_keyword">if</strong> (optionalArg && <strong
class="jxr_keyword">this</strong>.argCount == UNINITIALIZED) {
-<a class="jxr_linenumber" name="L259" href="#L259">259</a>
<strong class="jxr_keyword">this</strong>.argCount = 1;
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong
class="jxr_keyword">this</strong>.optionalArg = optionalArg;
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
-<a class="jxr_linenumber" name="L264" href="#L264">264</a>
-<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"> * Marks this Option as required.</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> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong
class="jxr_keyword">public</strong> Builder required() {
-<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong
class="jxr_keyword">return</strong> required(<strong
class="jxr_keyword">true</strong>);
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> }
-<a class="jxr_linenumber" name="L273" href="#L273">273</a>
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em
class="jxr_javadoccomment"> * Sets whether the Option is required.</em>
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em
class="jxr_javadoccomment"> * @param required specifies whether the
Option is required.</em>
-<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<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> <strong
class="jxr_keyword">public</strong> Builder required(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
required) {
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong
class="jxr_keyword">this</strong>.required = required;
-<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L283" href="#L283">283</a> }
-<a class="jxr_linenumber" name="L284" href="#L284">284</a>
-<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> <em
class="jxr_javadoccomment"> * Sets the type of the Option.</em>
-<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"> * @param type the type of the Option.</em>
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong
class="jxr_keyword">public</strong> Builder type(<strong
class="jxr_keyword">final</strong> Class<?> type) {
-<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong
class="jxr_keyword">this</strong>.type = toType(type);
-<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
-<a class="jxr_linenumber" name="L295" href="#L295">295</a>
-<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em
class="jxr_javadoccomment"> * The Option will use '=' as a means to
separate argument value.</em>
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong
class="jxr_keyword">public</strong> Builder valueSeparator() {
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong
class="jxr_keyword">return</strong> valueSeparator(Char.EQUAL);
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> }
-<a class="jxr_linenumber" name="L304" href="#L304">304</a>
-<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em
class="jxr_javadoccomment"> * The Option will use {@code sep} as a
means to separate argument values.</em>
-<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em
class="jxr_javadoccomment"> * <b>Example:</b></em>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment">/** The character that is the value separator.
*/</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>
valueSeparator;
+<a class="jxr_linenumber" name="L104" href="#L104">104</a>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> * Constructs a new {@code Builder} with the
minimum required parameters for an {@code Option} 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> <em
class="jxr_javadoccomment"> * @param option short representation of the
option.</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there
are any non valid Option characters in {@code opt}.</em>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong
class="jxr_keyword">private</strong> Builder(<strong
class="jxr_keyword">final</strong> String option) <strong
class="jxr_keyword">throws</strong> IllegalArgumentException {
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
option(option);
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
+<a class="jxr_linenumber" name="L114" href="#L114">114</a>
+<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"> * Sets the display name for the argument
value.</em>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em
class="jxr_javadoccomment"> * @param argName the display name for the
argument value.</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong
class="jxr_keyword">public</strong> Builder argName(<strong
class="jxr_keyword">final</strong> String argName) {
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong
class="jxr_keyword">this</strong>.argName = argName;
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * Constructs an Option with the values
declared by this {@link Builder}.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em
class="jxr_javadoccomment"> * @return the new {@link Option}.</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if
neither {@code opt} or {@code longOpt} has been set.</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong
class="jxr_keyword">public</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a> build()
{
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong
class="jxr_keyword">if</strong> (option == <strong
class="jxr_keyword">null</strong> && longOption == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> IllegalArgumentException(<span
class="jxr_string">"Either opt or longOpt must be specified"</span>);
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a
name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>(<strong
class="jxr_keyword">this</strong>);
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> * Sets the converter for the option.</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> * Note: See {@link TypeHandler} for
serialization discussion.</em>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * @param converter the Converter to
use.</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</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> <strong
class="jxr_keyword">public</strong> Builder converter(<strong
class="jxr_keyword">final</strong> Converter<?, ?> converter) {
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong
class="jxr_keyword">this</strong>.converter = converter;
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<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">/**</em>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * Marks this Option as deprecated.</em>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong
class="jxr_keyword">public</strong> Builder deprecated() {
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong
class="jxr_keyword">return</strong> deprecated(DeprecatedAttributes.DEFAULT);
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
+<a class="jxr_linenumber" name="L163" href="#L163">163</a>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> * Sets whether the Option is
deprecated.</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * @param deprecated specifies whether the
Option is deprecated.</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * @since 1.7.0</em>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong
class="jxr_keyword">public</strong> Builder deprecated(<strong
class="jxr_keyword">final</strong> <a name="DeprecatedAttributes"
href="../../../../org/apache/commons/cli/DeprecatedAttributes.html#DeprecatedAttributes">DeprecatedAttributes</a>
deprecated) {
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong
class="jxr_keyword">this</strong>.deprecated = deprecated;
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
+<a class="jxr_linenumber" name="L175" href="#L175">175</a>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * Sets the description for this option.</em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * @param description the description of the
option.</em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong
class="jxr_keyword">public</strong> Builder desc(<strong
class="jxr_keyword">final</strong> String description) {
+<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong
class="jxr_keyword">this</strong>.description = description;
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
+<a class="jxr_linenumber" name="L186" href="#L186">186</a>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> * Tests whether the Option will require an
argument.</em>
+<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong
class="jxr_keyword">public</strong> Builder hasArg() {
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong
class="jxr_keyword">return</strong> hasArg(<strong
class="jxr_keyword">true</strong>);
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
+<a class="jxr_linenumber" name="L195" href="#L195">195</a>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> * Tests whether the Option has an argument
or not.</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"> * @param hasArg specifies whether the
Option takes an argument or not.</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> * @return this builder, to allow method
chaining.</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> Builder hasArg(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
hasArg) {
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_comment">// set to UNINITIALIZED when no arg is specified to be
compatible with OptionBuilder</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a>
argCount = hasArg ? 1 : UNINITIALIZED;
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
+<a class="jxr_linenumber" name="L207" href="#L207">207</a>
+<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"> * Tests whether the Option can have
unlimited argument values.</em>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong
class="jxr_keyword">public</strong> Builder hasArgs() {
+<a class="jxr_linenumber" name="L214" href="#L214">214</a>
argCount = UNLIMITED_VALUES;
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
+<a class="jxr_linenumber" name="L217" href="#L217">217</a>
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> * Sets the long name of the Option.</em>
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> * @param longOption the long name of the
Option</em>
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<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> <strong
class="jxr_keyword">public</strong> Builder longOpt(<strong
class="jxr_keyword">final</strong> String longOption) {
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong
class="jxr_keyword">this</strong>.longOption = longOption;
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
+<a class="jxr_linenumber" name="L228" href="#L228">228</a>
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_javadoccomment"> * Sets the number of argument values the
Option can take.</em>
+<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"> * @param argCount the number of argument
values</em>
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong
class="jxr_keyword">public</strong> Builder numberOfArgs(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>
argCount) {
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong
class="jxr_keyword">this</strong>.argCount = argCount;
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
+<a class="jxr_linenumber" name="L239" href="#L239">239</a>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * Sets the name of the Option.</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> * @param option the name of the Option.</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there
are any non valid Option characters in {@code opt}.</em>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em
class="jxr_javadoccomment"> * @since 1.5.0</em>
+<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> <strong
class="jxr_keyword">public</strong> Builder option(<strong
class="jxr_keyword">final</strong> String option) <strong
class="jxr_keyword">throws</strong> IllegalArgumentException {
+<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong
class="jxr_keyword">this</strong>.option = OptionValidator.validate(option);
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
+<a class="jxr_linenumber" name="L252" href="#L252">252</a>
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> * Sets whether the Option can have an
optional argument.</em>
+<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"> * @param optionalArg specifies whether the
Option can have an optional argument.</em>
+<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong
class="jxr_keyword">public</strong> Builder optionalArg(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
optionalArg) {
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong
class="jxr_keyword">if</strong> (optionalArg && argCount ==
UNINITIALIZED) {
+<a class="jxr_linenumber" name="L261" href="#L261">261</a>
argCount = 1;
+<a class="jxr_linenumber" name="L262" href="#L262">262</a> }
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong
class="jxr_keyword">this</strong>.optionalArg = optionalArg;
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
+<a class="jxr_linenumber" name="L266" href="#L266">266</a>
+<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> <em
class="jxr_javadoccomment"> * Marks this Option as required.</em>
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<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> <strong
class="jxr_keyword">public</strong> Builder required() {
+<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong
class="jxr_keyword">return</strong> required(<strong
class="jxr_keyword">true</strong>);
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> }
+<a class="jxr_linenumber" name="L275" href="#L275">275</a>
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em
class="jxr_javadoccomment"> * Sets whether the Option is required.</em>
+<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment"> * @param required specifies whether the
Option is required.</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> * @return this builder.</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> <strong
class="jxr_keyword">public</strong> Builder required(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
required) {
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong
class="jxr_keyword">this</strong>.required = required;
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em
class="jxr_javadoccomment">/** Sets the version number when this option was
first defined."</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> * @param since the version number when this
option was first defined.</em>
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> * @return this builder.</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> <strong
class="jxr_keyword">public</strong> Builder since(<strong
class="jxr_keyword">final</strong> String since) {
+<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong
class="jxr_keyword">this</strong>.since = since;
+<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
+<a class="jxr_linenumber" name="L296" href="#L296">296</a>
+<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"> * Sets the type of the Option.</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> <em
class="jxr_javadoccomment"> * @param type the type of the Option.</em>
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong
class="jxr_keyword">public</strong> Builder type(<strong
class="jxr_keyword">final</strong> Class<?> type) {
+<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong
class="jxr_keyword">this</strong>.type = toType(type);
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
+<a class="jxr_linenumber" name="L307" href="#L307">307</a>
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em
class="jxr_javadoccomment"> * The Option will use '=' as a means to
separate argument value.</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em
class="jxr_javadoccomment"> * Option opt =
Option.builder("D").hasArgs().valueSeparator('=').build();</em>
-<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em
class="jxr_javadoccomment"> * Options options = new Options();</em>
-<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em
class="jxr_javadoccomment"> * options.addOption(opt);</em>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment"> * String[] args = { "-Dkey=value" };</em>
-<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_javadoccomment"> * CommandLineParser parser = new
DefaultParser();</em>
-<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em
class="jxr_javadoccomment"> * CommandLine line = parser.parse(options,
args);</em>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_javadoccomment"> * String propertyName =
line.getOptionValues("D")[0]; // will be "key"</em>
-<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em
class="jxr_javadoccomment"> * String propertyValue =
line.getOptionValues("D")[1]; // will be "value"</em>
-<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em
class="jxr_javadoccomment"> * @param valueSeparator The value
separator.</em>
-<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong
class="jxr_keyword">public</strong> Builder valueSeparator(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>
valueSeparator) {
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">this</strong>.valueSeparator = valueSeparator;
-<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> }
-<a class="jxr_linenumber" name="L329" href="#L329">329</a>
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> }
-<a class="jxr_linenumber" name="L331" href="#L331">331</a>
-<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em
class="jxr_javadoccomment">/** Empty array. */</em>
-<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>[]
EMPTY_ARRAY = {};
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em
class="jxr_javadoccomment">/** The serial version UID. */</em>
-<a class="jxr_linenumber" name="L336" href="#L336">336</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 = 1L;
-<a class="jxr_linenumber" name="L337" href="#L337">337</a>
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em
class="jxr_javadoccomment">/** Specifies the number of argument values has not
been specified. */</em>
-<a class="jxr_linenumber" name="L339" href="#L339">339</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> UNINITIALIZED = -1;
-<a class="jxr_linenumber" name="L340" href="#L340">340</a>
-<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em
class="jxr_javadoccomment">/** Specifies the number of argument values is
infinite. */</em>
-<a class="jxr_linenumber" name="L342" href="#L342">342</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> UNLIMITED_VALUES = -2;
+<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong
class="jxr_keyword">public</strong> Builder valueSeparator() {
+<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong
class="jxr_keyword">return</strong> valueSeparator(Char.EQUAL);
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
+<a class="jxr_linenumber" name="L316" href="#L316">316</a>
+<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> <em
class="jxr_javadoccomment"> * The Option will use {@code sep} as a
means to separate argument values.</em>
+<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em
class="jxr_javadoccomment"> * <b>Example:</b></em>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em
class="jxr_javadoccomment"> * <pre></em>
+<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em
class="jxr_javadoccomment"> * Option opt =
Option.builder("D").hasArgs().valueSeparator('=').build();</em>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em
class="jxr_javadoccomment"> * Options options = new Options();</em>
+<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em
class="jxr_javadoccomment"> * options.addOption(opt);</em>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em
class="jxr_javadoccomment"> * String[] args = { "-Dkey=value" };</em>
+<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em
class="jxr_javadoccomment"> * CommandLineParser parser = new
DefaultParser();</em>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em
class="jxr_javadoccomment"> * CommandLine line = parser.parse(options,
args);</em>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em
class="jxr_javadoccomment"> * String propertyName =
line.getOptionValues("D")[0]; // will be "key"</em>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em
class="jxr_javadoccomment"> * String propertyValue =
line.getOptionValues("D")[1]; // will be "value"</em>
+<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em
class="jxr_javadoccomment"> * </pre></em>
+<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em
class="jxr_javadoccomment"> * @param valueSeparator The value
separator.</em>
+<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em
class="jxr_javadoccomment"> * @return this builder.</em>
+<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong
class="jxr_keyword">public</strong> Builder valueSeparator(<strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>
valueSeparator) {
+<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong
class="jxr_keyword">this</strong>.valueSeparator = valueSeparator;
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
+<a class="jxr_linenumber" name="L341" href="#L341">341</a>
+<a class="jxr_linenumber" name="L342" href="#L342">342</a> }
<a class="jxr_linenumber" name="L343" href="#L343">343</a>
-<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em
class="jxr_javadoccomment"> * Returns a {@link Builder} to create an {@link
Option} using descriptive methods.</em>
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em
class="jxr_javadoccomment"> * @return a new {@link Builder} instance.</em>
-<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em
class="jxr_javadoccomment"> * @since 1.3</em>
-<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder() {
-<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong
class="jxr_keyword">return</strong> builder(<strong
class="jxr_keyword">null</strong>);
-<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
-<a class="jxr_linenumber" name="L353" href="#L353">353</a>
-<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em
class="jxr_javadoccomment"> * Returns a {@link Builder} to create an {@link
Option} using descriptive methods.</em>
-<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em
class="jxr_javadoccomment"> * @param option short representation of the
option.</em>
-<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em
class="jxr_javadoccomment"> * @return a new {@link Builder} instance.</em>
-<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there are
any non valid Option characters in {@code opt}.</em>
+<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em
class="jxr_javadoccomment">/** Empty array. */</em>
+<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
<a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>[]
EMPTY_ARRAY = {};
+<a class="jxr_linenumber" name="L346" href="#L346">346</a>
+<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em
class="jxr_javadoccomment">/** The serial version UID. */</em>
+<a class="jxr_linenumber" name="L348" href="#L348">348</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 = 1L;
+<a class="jxr_linenumber" name="L349" href="#L349">349</a>
+<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em
class="jxr_javadoccomment">/** Specifies the number of argument values has not
been specified. */</em>
+<a class="jxr_linenumber" name="L351" href="#L351">351</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> UNINITIALIZED = -1;
+<a class="jxr_linenumber" name="L352" href="#L352">352</a>
+<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em
class="jxr_javadoccomment">/** Specifies the number of argument values is
infinite. */</em>
+<a class="jxr_linenumber" name="L354" href="#L354">354</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> UNLIMITED_VALUES = -2;
+<a class="jxr_linenumber" name="L355" href="#L355">355</a>
+<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em
class="jxr_javadoccomment"> * Returns a {@link Builder} to create an {@link
Option} using descriptive methods.</em>
+<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em
class="jxr_javadoccomment"> * @return a new {@link Builder} instance.</em>
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em
class="jxr_javadoccomment"> * @since 1.3</em>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder(<strong class="jxr_keyword">final</strong> String option) {
-<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
Builder(option);
+<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder() {
+<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong
class="jxr_keyword">return</strong> builder(<strong
class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
<a class="jxr_linenumber" name="L365" href="#L365">365</a>
-<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em
class="jxr_javadoccomment">/** The number of argument values this option can
have. */</em>
-<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong>
argCount = UNINITIALIZED;
-<a class="jxr_linenumber" name="L368" href="#L368">368</a>
-<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em
class="jxr_javadoccomment">/** The name of the argument for this option. */</em>
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong
class="jxr_keyword">private</strong> String argName;
-<a class="jxr_linenumber" name="L371" href="#L371">371</a>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_javadoccomment">/** The explicit converter for this option. May be
null. */</em>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">transient</strong> Converter<?, ?> converter;
-<a class="jxr_linenumber" name="L374" href="#L374">374</a>
-<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em
class="jxr_javadoccomment"> * Specifies whether this option is deprecated,
may be null.</em>
-<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em
class="jxr_javadoccomment"> * If you want to serialize this field, use a
serialization proxy.</em>
-<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em
class="jxr_javadoccomment"> * </p></em>
-<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">transient</strong> <a name="DeprecatedAttributes"
href="../../../../org/apache/commons/cli/DeprecatedAttributes.html#DeprecatedAttributes">DeprecatedAttributes</a>
deprecated;
-<a class="jxr_linenumber" name="L382" href="#L382">382</a>
-<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em
class="jxr_javadoccomment">/** Description of the option. */</em>
-<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong
class="jxr_keyword">private</strong> String description;
-<a class="jxr_linenumber" name="L385" href="#L385">385</a>
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em
class="jxr_javadoccomment">/** The long representation of the option. */</em>
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong
class="jxr_keyword">private</strong> String longOption;
-<a class="jxr_linenumber" name="L388" href="#L388">388</a>
-<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em
class="jxr_javadoccomment">/** The name of the option. */</em>
-<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
String option;
-<a class="jxr_linenumber" name="L391" href="#L391">391</a>
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment">/** Specifies whether the argument value of this
Option is optional. */</em>
-<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> optionalArg;
+<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em
class="jxr_javadoccomment"> * Returns a {@link Builder} to create an {@link
Option} using descriptive methods.</em>
+<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em
class="jxr_javadoccomment"> * @param option short representation of the
option.</em>
+<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em
class="jxr_javadoccomment"> * @return a new {@link Builder} instance.</em>
+<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there are
any non valid Option characters in {@code opt}.</em>
+<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_javadoccomment"> * @since 1.3</em>
+<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Builder builder(<strong class="jxr_keyword">final</strong> String option) {
+<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong>
Builder(option);
+<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
+<a class="jxr_linenumber" name="L377" href="#L377">377</a>
+<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em
class="jxr_javadoccomment">/** The number of argument values this option can
have. */</em>
+<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong>
argCount = UNINITIALIZED;
+<a class="jxr_linenumber" name="L380" href="#L380">380</a>
+<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em
class="jxr_javadoccomment">/** The name of the argument for this option. */</em>
+<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong
class="jxr_keyword">private</strong> String argName;
+<a class="jxr_linenumber" name="L383" href="#L383">383</a>
+<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em
class="jxr_javadoccomment">/** The explicit converter for this option. May be
null. */</em>
+<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">transient</strong> Converter<?, ?> converter;
+<a class="jxr_linenumber" name="L386" href="#L386">386</a>
+<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em
class="jxr_javadoccomment"> * Specifies whether this option is deprecated,
may be null.</em>
+<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em
class="jxr_javadoccomment"> * If you want to serialize this field, use a
serialization proxy.</em>
+<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">transient</strong> <a name="DeprecatedAttributes"
href="../../../../org/apache/commons/cli/DeprecatedAttributes.html#DeprecatedAttributes">DeprecatedAttributes</a>
deprecated;
<a class="jxr_linenumber" name="L394" href="#L394">394</a>
-<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em
class="jxr_javadoccomment">/** Specifies whether this option is required to be
present. */</em>
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> required;
+<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em
class="jxr_javadoccomment">/** Description of the option. */</em>
+<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong
class="jxr_keyword">private</strong> String description;
<a class="jxr_linenumber" name="L397" href="#L397">397</a>
-<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em
class="jxr_javadoccomment">/** The type of this Option. */</em>
-<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong
class="jxr_keyword">private</strong> Class<?> type = String.<strong
class="jxr_keyword">class</strong>;
+<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em
class="jxr_javadoccomment">/** The long representation of the option. */</em>
+<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong
class="jxr_keyword">private</strong> String longOption;
<a class="jxr_linenumber" name="L400" href="#L400">400</a>
-<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em
class="jxr_javadoccomment">/** The list of argument values. **/</em>
-<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong
class="jxr_keyword">private</strong> List<String> values = <strong
class="jxr_keyword">new</strong> ArrayList<>();
+<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em
class="jxr_javadoccomment">/** The name of the option. */</em>
+<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
String option;
<a class="jxr_linenumber" name="L403" href="#L403">403</a>
-<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em
class="jxr_javadoccomment">/** The character that is the value separator.
*/</em>
-<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>
valuesep;
+<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em
class="jxr_javadoccomment">/** Specifies whether the argument value of this
Option is optional. */</em>
+<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> optionalArg;
<a class="jxr_linenumber" name="L406" href="#L406">406</a>
-<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em
class="jxr_javadoccomment"> * Private constructor used by the nested
Builder class.</em>
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em
class="jxr_javadoccomment"> * @param builder builder used to create this
option.</em>
-<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong
class="jxr_keyword">private</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>(<strong
class="jxr_keyword">final</strong> Builder builder) {
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong
class="jxr_keyword">this</strong>.argName = builder.argName;
-<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong
class="jxr_keyword">this</strong>.description = builder.description;
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong
class="jxr_keyword">this</strong>.longOption = builder.longOption;
-<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong
class="jxr_keyword">this</strong>.argCount = builder.argCount;
-<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong
class="jxr_keyword">this</strong>.option = builder.option;
-<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong
class="jxr_keyword">this</strong>.optionalArg = builder.optionalArg;
-<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong
class="jxr_keyword">this</strong>.deprecated = builder.deprecated;
-<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong
class="jxr_keyword">this</strong>.required = builder.required;
-<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong
class="jxr_keyword">this</strong>.type = builder.type;
-<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong
class="jxr_keyword">this</strong>.valuesep = builder.valueSeparator;
-<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong
class="jxr_keyword">this</strong>.converter = builder.converter;
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> }
-<a class="jxr_linenumber" name="L425" href="#L425">425</a>
-<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em
class="jxr_javadoccomment"> * Creates an Option using the specified
parameters.</em>
-<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em
class="jxr_javadoccomment"> * @param option short representation of
the option.</em>
-<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em
class="jxr_javadoccomment"> * @param hasArg specifies whether the
Option takes an argument or not.</em>
-<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em
class="jxr_javadoccomment"> * @param description describes the function of
the option.</em>
-<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if there are
any non valid Option characters in {@code opt}.</em>
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong
class="jxr_keyword">public</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>(<strong
class="jxr_keyword">final</strong> String option, <strong
class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong>
hasArg, <strong class="jxr_keyword">final</strong> String description) <strong
class="jxr_keyword">throws</strong> IllegalArgumentException {
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong
class="jxr_keyword">this</strong>(option, <strong
class="jxr_keyword">null</strong>, hasArg, description);
-<a class="jxr_linenumber" name="L437" href="#L437">437</a> }
-<a class="jxr_linenumber" name="L438" href="#L438">438</a>
-<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * Creates an Option using the specified
parameters. The option does not take an argument.</em>
-<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em
class="jxr_javadoccomment"> * @param option short representation of
the option.</em>
-<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em
class="jxr_javadoccomment"> * @param description describes the function of
the option.</em>
+<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em
class="jxr_javadoccomment">/** Specifies whether this option is required to be
present. */</em>
+<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> required;
+<a class="jxr_linenumber" name="L409" href="#L409">409</a>
+<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em
class="jxr_javadoccomment">/** Specifies the version when this option was
added. May be null */</em>
+<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong
class="jxr_keyword">private</strong> String since;
+<a class="jxr_linenumber" name="L412" href="#L412">412</a>
+<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em
class="jxr_javadoccomment">/** The type of this Option. */</em>
+<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong
class="jxr_keyword">private</strong> Class<?> type = String.<strong
class="jxr_keyword">class</strong>;
+<a class="jxr_linenumber" name="L415" href="#L415">415</a>
+<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em
class="jxr_javadoccomment">/** The list of argument values. **/</em>
+<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong
class="jxr_keyword">private</strong> List<String> values = <strong
class="jxr_keyword">new</strong> ArrayList<>();
+<a class="jxr_linenumber" name="L418" href="#L418">418</a>
+<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em
class="jxr_javadoccomment">/** The character that is the value separator.
*/</em>
+<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">char</strong>
valueSeparator;
+<a class="jxr_linenumber" name="L421" href="#L421">421</a>
+<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em
class="jxr_javadoccomment"> * Private constructor used by the nested
Builder class.</em>
+<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em
class="jxr_javadoccomment"> * @param builder builder used to create this
option.</em>
+<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong
class="jxr_keyword">private</strong> <a name="Option"
href="../../../../org/apache/commons/cli/Option.html#Option">Option</a>(<strong
class="jxr_keyword">final</strong> Builder builder) {
+<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong
class="jxr_keyword">this</strong>.argName = builder.argName;
+<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong
class="jxr_keyword">this</strong>.description = builder.description;
+<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong
class="jxr_keyword">this</strong>.longOption = builder.longOption;
+<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong
class="jxr_keyword">this</strong>.argCount = builder.argCount;
+<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong
class="jxr_keyword">this</strong>.option = builder.option;
+<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong
class="jxr_keyword">this</strong>.optionalArg = builder.optionalArg;
+<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong
class="jxr_keyword">this</strong>.deprecated = builder.deprecated;
+<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong
class="jxr_keyword">this</strong>.required = builder.required;
+<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong
class="jxr_keyword">this</strong>.since = builder.since;
[... 1141 lines stripped ...]