Modified:
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/Option.html
==============================================================================
---
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/Option.html
(original)
+++
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/Option.html
Thu Aug 15 00:03:23 2024
@@ -1,8 +1,8 @@
<!DOCTYPE HTML>
-<html lang="en">
+<html lang>
<head>
<!-- Generated by javadoc (17) -->
-<title>Option (Apache Commons CLI 1.8.1-SNAPSHOT API)</title>
+<title>Option (Apache Commons CLI 1.9.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package:
org.apache.commons.cli, class: Option">
@@ -178,8 +178,8 @@ implements <a href="https://docs.oracle.
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button
id="method-summary-table-tab0" role="tab" aria-selected="true"
aria-controls="method-summary-table.tabpanel" tabindex="0"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table', 3)" class="active-table-tab">All
Methods</button><button id="method-summary-table-tab1" role="tab"
aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab1', 3)"
class="table-tab">Static Methods</button><button id="method-summary-table-tab2"
role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab2', 3)"
class="table-tab">Instance Methods</button><button
id="method-summary-table-tab4" role="tab" aria-selected="false"
aria-controls="method-summary-table.ta
bpanel" tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab4', 3)"
class="table-tab">Concrete Methods</button><button
id="method-summary-table-tab6" role="tab" aria-selected="false"
aria-controls="method-summary-table.tabpanel" tabindex="-1"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table-tab6', 3)" class="table-tab">Deprecated
Methods</button></div>
-<div id="method-summary-table.tabpanel" role="tabpanel">
-<div class="summary-table three-column-summary"
aria-labelledby="method-summary-table-tab0">
+<div id="method-summary-table.tabpanel" role="tabpanel"
aria-labelledby="method-summary-table-tab0">
+<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
@@ -254,139 +254,144 @@ implements <a href="https://docs.oracle.
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the name of this Option.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()"
class="member-name-link">getType</a>()</code></div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getSince()" class="member-name-link">getSince</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the type of this Option.</div>
+<div class="block">Gets the version when this option was added.</div>
</div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue()" class="member-name-link">getValue</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()"
class="member-name-link">getType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the specified value of this Option or
<code>null</code> if there is no value.</div>
+<div class="block">Gets the type of this Option.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue(int)"
class="member-name-link">getValue</a><wbr>(int index)</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue()" class="member-name-link">getValue</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the specified value of this Option or
<code>null</code> if there is no value.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue(java.lang.String)"
class="member-name-link">getValue</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> defaultValue)</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue(int)"
class="member-name-link">getValue</a><wbr>(int index)</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the value/first value of this Option or the
<code>defaultValue</code> if there is no value.</div>
+<div class="block">Gets the specified value of this Option or
<code>null</code> if there is no value.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>[]</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValues()" class="member-name-link">getValues</a>()</code></div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValue(java.lang.String)"
class="member-name-link">getValue</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> defaultValue)</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the values of this Option as a String array or null if
there are no values.</div>
+<div class="block">Gets the value/first value of this Option or the
<code>defaultValue</code> if there is no value.</div>
</div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValueSeparator()"
class="member-name-link">getValueSeparator</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>[]</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValues()" class="member-name-link">getValues</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the value separator character.</div>
+<div class="block">Gets the values of this Option as a String array or null if
there are no values.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>></code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValuesList()"
class="member-name-link">getValuesList</a>()</code></div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValueSeparator()"
class="member-name-link">getValueSeparator</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Gets the values of this Option as a List or null if there
are no values.</div>
+<div class="block">Gets the value separator character.</div>
</div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasArg()"
class="member-name-link">hasArg</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getValuesList()"
class="member-name-link">getValuesList</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option requires an argument.</div>
+<div class="block">Gets the values of this Option as a List or null if there
are no values.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasArgName()" class="member-name-link">hasArgName</a>()</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasArg()"
class="member-name-link">hasArg</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether the display name for the argument value has
been set.</div>
+<div class="block">Tests whether this Option requires an argument.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasArgs()"
class="member-name-link">hasArgs</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasArgName()" class="member-name-link">hasArgName</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option can take many values.</div>
+<div class="block">Tests whether the display name for the argument value has
been set.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"> </div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasLongOpt()" class="member-name-link">hasLongOpt</a>()</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option has a long name.</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasArgs()"
class="member-name-link">hasArgs</a>()</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Tests whether this Option can take many values.</div>
</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"> </div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasOptionalArg()"
class="member-name-link">hasOptionalArg</a>()</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasLongOpt()" class="member-name-link">hasLongOpt</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option can have an optional
argument.</div>
+<div class="block">Tests whether this Option has a long name.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasValueSeparator()"
class="member-name-link">hasValueSeparator</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasOptionalArg()"
class="member-name-link">hasOptionalArg</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option has specified a value
separator.</div>
+<div class="block">Tests whether this Option can have an optional
argument.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isDeprecated()" class="member-name-link">isDeprecated</a>()</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#hasValueSeparator()"
class="member-name-link">hasValueSeparator</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option is deprecated.</div>
+<div class="block">Tests whether this Option has specified a value
separator.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isRequired()" class="member-name-link">isRequired</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isDeprecated()" class="member-name-link">isDeprecated</a>()</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Tests whether this Option is required.</div>
+<div class="block">Tests whether this Option is deprecated.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setArgName(java.lang.String)"
class="member-name-link">setArgName</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> argName)</code></div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isRequired()" class="member-name-link">isRequired</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets the display name for the argument value.</div>
+<div class="block">Tests whether this Option is required.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setArgs(int)"
class="member-name-link">setArgs</a><wbr>(int num)</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setArgName(java.lang.String)"
class="member-name-link">setArgName</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> argName)</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets the number of argument values this Option can
take.</div>
+<div class="block">Sets the display name for the argument value.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setConverter(org.apache.commons.cli.Converter)"
class="member-name-link">setConverter</a><wbr>(<a href="Converter.html"
title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?> converter)</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setArgs(int)"
class="member-name-link">setArgs</a><wbr>(int num)</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets the value to type converter.</div>
+<div class="block">Sets the number of argument values this Option can
take.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setDescription(java.lang.String)"
class="member-name-link">setDescription</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setConverter(org.apache.commons.cli.Converter)"
class="member-name-link">setConverter</a><wbr>(<a href="Converter.html"
title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?> converter)</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets the self-documenting description of this Option.</div>
+<div class="block">Sets the value to type converter.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setLongOpt(java.lang.String)"
class="member-name-link">setLongOpt</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> longOpt)</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setDescription(java.lang.String)"
class="member-name-link">setDescription</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets the long name of this Option.</div>
+<div class="block">Sets the self-documenting description of this Option.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setOptionalArg(boolean)"
class="member-name-link">setOptionalArg</a><wbr>(boolean optionalArg)</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setLongOpt(java.lang.String)"
class="member-name-link">setLongOpt</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> longOpt)</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets whether this Option can have an optional
argument.</div>
+<div class="block">Sets the long name of this Option.</div>
</div>
<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setRequired(boolean)"
class="member-name-link">setRequired</a><wbr>(boolean required)</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setOptionalArg(boolean)"
class="member-name-link">setOptionalArg</a><wbr>(boolean optionalArg)</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Sets whether this Option is mandatory.</div>
+<div class="block">Sets whether this Option can have an optional
argument.</div>
</div>
<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setType(java.lang.Class)" class="member-name-link">setType</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html"
title="class or interface in java.lang"
class="external-link">Class</a><?> type)</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setRequired(boolean)"
class="member-name-link">setRequired</a><wbr>(boolean required)</code></div>
<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Sets whether this Option is mandatory.</div>
+</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setType(java.lang.Class)" class="member-name-link">setType</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html"
title="class or interface in java.lang"
class="external-link">Class</a><?> type)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the type of this Option.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a href="#setType(java.lang.Object)"
class="member-name-link">setType</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> type)</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a href="#setType(java.lang.Object)"
class="member-name-link">setType</a><wbr>(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> type)</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">since 1.3, use <a
href="#setType(java.lang.Object)"><code>setType(Class)</code></a> instead.</div>
</div>
</div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setValueSeparator(char)"
class="member-name-link">setValueSeparator</a><wbr>(char sep)</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setValueSeparator(char)"
class="member-name-link">setValueSeparator</a><wbr>(char valueSeparator)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the value separator.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#toString()" class="member-name-link">toString</a>()</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#toString()" class="member-name-link">toString</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a String suitable for debugging.</div>
</div>
</div>
@@ -409,7 +414,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="UNINITIALIZED">
<h3>UNINITIALIZED</h3>
-<div class="member-signature"><span class="modifiers">public static
final</span> <span class="return-type">int</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-339">UNINITIALIZED</a></span></div>
+<div class="member-signature"><span class="modifiers">public static
final</span> <span class="return-type">int</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-351">UNINITIALIZED</a></span></div>
<div class="block">Specifies the number of argument values has not been
specified.</div>
<dl class="notes">
<dt>See Also:</dt>
@@ -424,7 +429,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="UNLIMITED_VALUES">
<h3>UNLIMITED_VALUES</h3>
-<div class="member-signature"><span class="modifiers">public static
final</span> <span class="return-type">int</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-342">UNLIMITED_VALUES</a></span></div>
+<div class="member-signature"><span class="modifiers">public static
final</span> <span class="return-type">int</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-354">UNLIMITED_VALUES</a></span></div>
<div class="block">Specifies the number of argument values is infinite.</div>
<dl class="notes">
<dt>See Also:</dt>
@@ -447,7 +452,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail"
id="<init>(java.lang.String,boolean,java.lang.String)">
<h3>Option</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-435">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
+<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-451">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
boolean hasArg,
<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</span>
throws <span class="exceptions"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html"
title="class or interface in java.lang"
class="external-link">IllegalArgumentException</a></span></div>
@@ -465,7 +470,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="<init>(java.lang.String,java.lang.String)">
<h3>Option</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-447">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
+<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-463">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</span>
throws <span class="exceptions"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html"
title="class or interface in java.lang"
class="external-link">IllegalArgumentException</a></span></div>
<div class="block">Creates an Option using the specified parameters. The
option does not take an argument.</div>
@@ -481,7 +486,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail"
id="<init>(java.lang.String,java.lang.String,boolean,java.lang.String)">
<h3>Option</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-461">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
+<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-477">Option</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option,
<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> longOption,
boolean hasArg,
<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</span>
@@ -509,7 +514,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="builder()">
<h3>builder</h3>
-<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="Option.Builder.html"
title="class in org.apache.commons.cli">Option.Builder</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-350">builder</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="Option.Builder.html"
title="class in org.apache.commons.cli">Option.Builder</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-362">builder</a></span>()</div>
<div class="block">Returns a <a href="Option.Builder.html" title="class in
org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a
href="Option.html" title="class in
org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -522,7 +527,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="builder(java.lang.String)">
<h3>builder</h3>
-<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="Option.Builder.html"
title="class in org.apache.commons.cli">Option.Builder</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-362">builder</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option)</span></div>
+<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="Option.Builder.html"
title="class in org.apache.commons.cli">Option.Builder</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-374">builder</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> option)</span></div>
<div class="block">Returns a <a href="Option.Builder.html" title="class in
org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a
href="Option.html" title="class in
org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -540,7 +545,7 @@ implements <a href="https://docs.oracle.
<section class="detail" id="addValue(java.lang.String)">
<h3>addValue</h3>
<div class="member-signature"><span class="annotations"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html"
title="class or interface in java.lang" class="external-link">@Deprecated</a>
-</span><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-505">addValue</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> value)</span></div>
+</span><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-521">addValue</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> value)</span></div>
<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Unused.</div>
</div>
@@ -558,7 +563,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-529">clone</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-545">clone</a></span>()</div>
<div class="block">A rather odd clone method - due to incorrect code in 1.0 it
is public and in 1.1 rather than throwing a CloneNotSupportedException it
throws a
RuntimeException so as to maintain backwards compatible at the API level.
@@ -576,7 +581,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-540">equals</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> obj)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-556">equals</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> obj)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"
title="class or interface in java.lang"
class="external-link">equals</a></code> in class <code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></code></dd>
@@ -586,7 +591,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getArgName()">
<h3>getArgName</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-557">getArgName</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-573">getArgName</a></span>()</div>
<div class="block">Gets the display name for the argument value.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -597,7 +602,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getArgs()">
<h3>getArgs</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-573">getArgs</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-589">getArgs</a></span>()</div>
<div class="block">Gets the number of argument values this Option can take.
<p>
@@ -620,7 +625,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getConverter()">
<h3>getConverter</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a href="Converter.html" title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-583">getConverter</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a href="Converter.html" title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-599">getConverter</a></span>()</div>
<div class="block">Gets the value to type converter.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -633,7 +638,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getDeprecated()">
<h3>getDeprecated</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a href="DeprecatedAttributes.html" title="class in
org.apache.commons.cli">DeprecatedAttributes</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-593">getDeprecated</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a href="DeprecatedAttributes.html" title="class in
org.apache.commons.cli">DeprecatedAttributes</a></span> <span
class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-609">getDeprecated</a></span>()</div>
<div class="block">Gets deprecated attributes if any.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -646,7 +651,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getDescription()">
<h3>getDescription</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-602">getDescription</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-618">getDescription</a></span>()</div>
<div class="block">Gets the self-documenting description of this Option.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -657,7 +662,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getId()">
<h3>getId</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-611">getId</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-627">getId</a></span>()</div>
<div class="block">Gets the id of this Option. This is only set when the
Option shortOpt is a single character. This is used for switch statements.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -668,7 +673,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getKey()">
<h3>getKey</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-621">getKey</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-637">getKey</a></span>()</div>
<div class="block">Gets the 'unique' Option identifier. This is the option
value if set or the long value if the options value is not set.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -681,7 +686,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getLongOpt()">
<h3>getLongOpt</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-631">getLongOpt</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-647">getLongOpt</a></span>()</div>
<div class="block">Gets the long name of this Option.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -692,7 +697,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getOpt()">
<h3>getOpt</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-643">getOpt</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-659">getOpt</a></span>()</div>
<div class="block">Gets the name of this Option.
It is this String which can be used with <a
href="CommandLine.html#hasOption(java.lang.String)"><code>CommandLine.hasOption(String
opt)</code></a> and <a
href="CommandLine.html#getOptionValue(java.lang.String)"><code>CommandLine.getOptionValue(String
opt)</code></a> to check for
@@ -704,9 +709,20 @@ implements <a href="https://docs.oracle.
</section>
</li>
<li>
+<section class="detail" id="getSince()">
+<h3>getSince</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-667">getSince</a></span>()</div>
+<div class="block">Gets the version when this option was added.</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>the version when this option was added, or <code>null</code> if not
set.</dd>
+</dl>
+</section>
+</li>
+<li>
<section class="detail" id="getType()">
<h3>getType</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-652">getType</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-677">getType</a></span>()</div>
<div class="block">Gets the type of this Option.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -717,7 +733,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValue()">
<h3>getValue</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-661">getValue</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-686">getValue</a></span>()</div>
<div class="block">Gets the specified value of this Option or
<code>null</code> if there is no value.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -728,7 +744,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValue(int)">
<h3>getValue</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-674">getValue</a></span><wbr><span
class="parameters">(int index)</span>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-699">getValue</a></span><wbr><span
class="parameters">(int index)</span>
throws <span class="exceptions"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IndexOutOfBoundsException.html"
title="class or interface in java.lang"
class="external-link">IndexOutOfBoundsException</a></span></div>
<div class="block">Gets the specified value of this Option or
<code>null</code> if there is no value.</div>
<dl class="notes">
@@ -744,7 +760,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValue(java.lang.String)">
<h3>getValue</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-685">getValue</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> defaultValue)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-710">getValue</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> defaultValue)</span></div>
<div class="block">Gets the value/first value of this Option or the
<code>defaultValue</code> if there is no value.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -757,7 +773,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValues()">
<h3>getValues</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>[]</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-695">getValues</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>[]</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-720">getValues</a></span>()</div>
<div class="block">Gets the values of this Option as a String array or null if
there are no values.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -768,7 +784,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValueSeparator()">
<h3>getValueSeparator</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">char</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-704">getValueSeparator</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">char</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-729">getValueSeparator</a></span>()</div>
<div class="block">Gets the value separator character.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -779,7 +795,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="getValuesList()">
<h3>getValuesList</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-713">getValuesList</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a>></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-738">getValuesList</a></span>()</div>
<div class="block">Gets the values of this Option as a List or null if there
are no values.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -790,7 +806,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasArg()">
<h3>hasArg</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-722">hasArg</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-747">hasArg</a></span>()</div>
<div class="block">Tests whether this Option requires an argument.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -801,7 +817,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasArgName()">
<h3>hasArgName</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-731">hasArgName</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-756">hasArgName</a></span>()</div>
<div class="block">Tests whether the display name for the argument value has
been set.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -812,7 +828,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasArgs()">
<h3>hasArgs</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-740">hasArgs</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-765">hasArgs</a></span>()</div>
<div class="block">Tests whether this Option can take many values.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -823,7 +839,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-744">hashCode</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">int</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-769">hashCode</a></span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()"
title="class or interface in java.lang"
class="external-link">hashCode</a></code> in class <code><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a></code></dd>
@@ -833,7 +849,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasLongOpt()">
<h3>hasLongOpt</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-754">hasLongOpt</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-779">hasLongOpt</a></span>()</div>
<div class="block">Tests whether this Option has a long name.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -844,7 +860,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasOptionalArg()">
<h3>hasOptionalArg</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-772">hasOptionalArg</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-797">hasOptionalArg</a></span>()</div>
<div class="block">Tests whether this Option can have an optional
argument.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -855,7 +871,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="hasValueSeparator()">
<h3>hasValueSeparator</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-782">hasValueSeparator</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-807">hasValueSeparator</a></span>()</div>
<div class="block">Tests whether this Option has specified a value
separator.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -868,7 +884,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="isDeprecated()">
<h3>isDeprecated</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-792">isDeprecated</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-817">isDeprecated</a></span>()</div>
<div class="block">Tests whether this Option is deprecated.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -881,7 +897,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="isRequired()">
<h3>isRequired</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-801">isRequired</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">boolean</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-826">isRequired</a></span>()</div>
<div class="block">Tests whether this Option is required.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -892,7 +908,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setArgName(java.lang.String)">
<h3>setArgName</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-860">setArgName</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> argName)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-885">setArgName</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> argName)</span></div>
<div class="block">Sets the display name for the argument value.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -903,7 +919,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setArgs(int)">
<h3>setArgs</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-869">setArgs</a></span><wbr><span
class="parameters">(int num)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-894">setArgs</a></span><wbr><span
class="parameters">(int num)</span></div>
<div class="block">Sets the number of argument values this Option can
take.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -914,7 +930,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setConverter(org.apache.commons.cli.Converter)">
<h3>setConverter</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-879">setConverter</a></span><wbr><span
class="parameters">(<a href="Converter.html" title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?> converter)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-904">setConverter</a></span><wbr><span
class="parameters">(<a href="Converter.html" title="interface in
org.apache.commons.cli">Converter</a><?,<wbr>?> converter)</span></div>
<div class="block">Sets the value to type converter.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -927,7 +943,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setDescription(java.lang.String)">
<h3>setDescription</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-889">setDescription</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-914">setDescription</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> description)</span></div>
<div class="block">Sets the self-documenting description of this Option.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -940,7 +956,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setLongOpt(java.lang.String)">
<h3>setLongOpt</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-898">setLongOpt</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> longOpt)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-923">setLongOpt</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a> longOpt)</span></div>
<div class="block">Sets the long name of this Option.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -951,7 +967,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setOptionalArg(boolean)">
<h3>setOptionalArg</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-907">setOptionalArg</a></span><wbr><span
class="parameters">(boolean optionalArg)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-932">setOptionalArg</a></span><wbr><span
class="parameters">(boolean optionalArg)</span></div>
<div class="block">Sets whether this Option can have an optional
argument.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -962,7 +978,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setRequired(boolean)">
<h3>setRequired</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-916">setRequired</a></span><wbr><span
class="parameters">(boolean required)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-941">setRequired</a></span><wbr><span
class="parameters">(boolean required)</span></div>
<div class="block">Sets whether this Option is mandatory.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -973,7 +989,7 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setType(java.lang.Class)">
<h3>setType</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-926">setType</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html"
title="class or interface in java.lang"
class="external-link">Class</a><?> type)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-951">setType</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html"
title="class or interface in java.lang"
class="external-link">Class</a><?> type)</span></div>
<div class="block">Sets the type of this Option.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -987,7 +1003,7 @@ implements <a href="https://docs.oracle.
<section class="detail" id="setType(java.lang.Object)">
<h3>setType</h3>
<div class="member-signature"><span class="annotations"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html"
title="class or interface in java.lang" class="external-link">@Deprecated</a>
-</span><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-939">setType</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> type)</span></div>
+</span><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-964">setType</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">Object</a> type)</span></div>
<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">since 1.3, use <a
href="#setType(java.lang.Object)"><code>setType(Class)</code></a> instead.</div>
</div>
@@ -1004,18 +1020,18 @@ implements <a href="https://docs.oracle.
<li>
<section class="detail" id="setValueSeparator(char)">
<h3>setValueSeparator</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-949">setValueSeparator</a></span><wbr><span
class="parameters">(char sep)</span></div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-974">setValueSeparator</a></span><wbr><span
class="parameters">(char valueSeparator)</span></div>
<div class="block">Sets the value separator. For example if the argument value
was a Java property, the value separator would be '='.</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>sep</code> - The value separator.</dd>
+<dd><code>valueSeparator</code> - The value separator.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
-<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-975">toString</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../src-html/org/apache/commons/cli/Option.html#line-1000">toString</a></span>()</div>
<div class="block">Creates a String suitable for debugging.</div>
<dl class="notes">
<dt>Overrides:</dt>
Modified:
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionBuilder.html
==============================================================================
---
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionBuilder.html
(original)
+++
websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionBuilder.html
Thu Aug 15 00:03:23 2024
@@ -1,8 +1,8 @@
<!DOCTYPE HTML>
-<html lang="en">
+<html lang>
<head>
<!-- Generated by javadoc (17) -->
-<title>OptionBuilder (Apache Commons CLI 1.8.1-SNAPSHOT API)</title>
+<title>OptionBuilder (Apache Commons CLI 1.9.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package:
org.apache.commons.cli, class: OptionBuilder">
@@ -101,8 +101,8 @@ loadScripts(document, 'script');</script
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button
id="method-summary-table-tab0" role="tab" aria-selected="true"
aria-controls="method-summary-table.tabpanel" tabindex="0"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table', 3)" class="active-table-tab">All
Methods</button><button id="method-summary-table-tab1" role="tab"
aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab1', 3)"
class="table-tab">Static Methods</button><button id="method-summary-table-tab4"
role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab4', 3)"
class="table-tab">Concrete Methods</button><button
id="method-summary-table-tab6" role="tab" aria-selected="false"
aria-controls="method-summary-table.ta
bpanel" tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab6', 3)"
class="table-tab">Deprecated Methods</button></div>
-<div id="method-summary-table.tabpanel" role="tabpanel">
-<div class="summary-table three-column-summary"
aria-labelledby="method-summary-table-tab0">
+<div id="method-summary-table.tabpanel" role="tabpanel"
aria-labelledby="method-summary-table-tab0">
+<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
@@ -371,7 +371,7 @@ loadScripts(document, 'script');</script
<div class="block">The next Option can have the specified number of optional
arguments.</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>numArgs</code> - - the maximum number of optional arguments the next
Option created can have.</dd>
+<dd><code>numArgs</code> - the maximum number of optional arguments the next
Option created can have.</dd>
<dt>Returns:</dt>
<dd>the OptionBuilder instance</dd>
</dl>