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 Jun 8 17:47:18 2017 @@ -2,38 +2,24 @@ <!-- NewPage --> <html lang="de"> <head> -<!-- Generated by javadoc --> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Option (Apache Commons CLI 1.5-SNAPSHOT API)</title> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Option (Apache Commons CLI 1.5-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Option (Apache Commons CLI 1.5-SNAPSHOT API)"; } //--> -var methods = {"i0":42,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":42,"i34":10,"i35":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> +<div class="topNav"><a name="navbar_top"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +34,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/Option.html" target="_top">Frames</a></li> -<li><a href="Option.html" target="_top">No Frames</a></li> +<li><a href="Option.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -73,19 +59,19 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> -<li><a href="#field.summary">Field</a> | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field.detail">Field</a> | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -126,14 +112,11 @@ implements <a href="http://download.orac <p> <b>Note:</b> once an <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> has been added to an instance of <a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>, it's required flag may not be changed anymore.</div> -<dl> -<dt><span class="simpleTagLabel">Version:</span></dt> -<dd>$Id: Option.java 1756753 2016-08-18 10:18:43Z britter $</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>, +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>, <a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><code>CommandLine</code></a>, -<a href="../../../../serialized-form.html#org.apache.commons.cli.Option">Serialized Form</a></dd> -</dl> +<a href="../../../../serialized-form.html#org.apache.commons.cli.Option">Serialized Form</a></dd></dl> </li> </ul> </div> @@ -142,11 +125,11 @@ implements <a href="http://download.orac <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -154,7 +137,7 @@ implements <a href="http://download.orac </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></strong></code> <div class="block">A nested builder class to create <code>Option</code> instances using descriptive methods.</div> </td> @@ -164,11 +147,11 @@ implements <a href="http://download.orac </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.summary"> +<li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -176,13 +159,13 @@ implements <a href="http://download.orac </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#UNINITIALIZED">UNINITIALIZED</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#UNINITIALIZED">UNINITIALIZED</a></strong></code> <div class="block">constant that specifies the number of argument values has not been specified</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#UNLIMITED_VALUES">UNLIMITED_VALUES</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#UNLIMITED_VALUES">UNLIMITED_VALUES</a></strong></code> <div class="block">constant that specifies the number of argument values is infinite</div> </td> </tr> @@ -191,33 +174,33 @@ implements <a href="http://download.orac </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> +<li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#Option-java.lang.String-boolean-java.lang.String-">Option</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - boolean hasArg, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#Option(java.lang.String,%20boolean,%20java.lang.String)">Option</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, + boolean hasArg, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> <div class="block">Creates an Option using the specified parameters.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-">Option</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#Option(java.lang.String,%20java.lang.String)">Option</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> <div class="block">Creates an Option using the specified parameters.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-boolean-java.lang.String-">Option</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt, - boolean hasArg, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#Option(java.lang.String,%20java.lang.String,%20boolean,%20java.lang.String)">Option</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt, + boolean hasArg, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> <div class="block">Creates an Option using the specified parameters.</div> </td> </tr> @@ -226,241 +209,241 @@ implements <a href="http://download.orac </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#addValue-java.lang.String-">addValue</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#addValue(java.lang.String)">addValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> +<div class="block"><strong>Deprecated.</strong> </div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#builder--">builder</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#builder()">builder</a></strong>()</code> <div class="block">Returns a <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#builder-java.lang.String-">builder</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#builder(java.lang.String)">builder</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt)</code> <div class="block">Returns a <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#clone--">clone</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#clone()">clone</a></strong>()</code> <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 compat at the API level.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#equals-java.lang.Object-">equals</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getArgName--">getArgName</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getArgName()">getArgName</a></strong>()</code> <div class="block">Gets the display name for the argument value.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getArgs--">getArgs</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getArgs()">getArgs</a></strong>()</code> <div class="block">Returns the number of argument values this Option can take.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getDescription--">getDescription</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getDescription()">getDescription</a></strong>()</code> <div class="block">Retrieve the self-documenting description of this Option</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getId--">getId</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getId()">getId</a></strong>()</code> <div class="block">Returns the id of this Option.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getLongOpt--">getLongOpt</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getLongOpt()">getLongOpt</a></strong>()</code> <div class="block">Retrieve the long name of this Option.</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getOpt--">getOpt</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getOpt()">getOpt</a></strong>()</code> <div class="block">Retrieve the name of this Option.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getType--">getType</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getType()">getType</a></strong>()</code> <div class="block">Retrieve the type of this Option.</div> </td> </tr> -<tr id="i12" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValue--">getValue</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValue()">getValue</a></strong>()</code> <div class="block">Returns the specified value of this Option or <code>null</code> if there is no value.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValue-int-">getValue</a></span>(int index)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValue(int)">getValue</a></strong>(int index)</code> <div class="block">Returns the specified value of this Option or <code>null</code> if there is no value.</div> </td> </tr> -<tr id="i14" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValue-java.lang.String-">getValue</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValue(java.lang.String)">getValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code> <div class="block">Returns the value/first value of this Option or the <code>defaultValue</code> if there is no value.</div> </td> </tr> -<tr id="i15" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValues--">getValues</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValues()">getValues</a></strong>()</code> <div class="block">Return the values of this Option as a String array or null if there are no values</div> </td> </tr> -<tr id="i16" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>char</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValueSeparator--">getValueSeparator</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValueSeparator()">getValueSeparator</a></strong>()</code> <div class="block">Returns the value separator character.</div> </td> </tr> -<tr id="i17" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#getValuesList--">getValuesList</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#getValuesList()">getValuesList</a></strong>()</code> </td> </tr> -<tr id="i18" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasArg--">hasArg</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasArg()">hasArg</a></strong>()</code> <div class="block">Query to see if this Option requires an argument</div> </td> </tr> -<tr id="i19" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasArgName--">hasArgName</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasArgName()">hasArgName</a></strong>()</code> <div class="block">Returns whether the display name for the argument value has been set.</div> </td> </tr> -<tr id="i20" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasArgs--">hasArgs</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasArgs()">hasArgs</a></strong>()</code> <div class="block">Query to see if this Option can take many values.</div> </td> </tr> -<tr id="i21" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hashCode--">hashCode</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> -<tr id="i22" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasLongOpt--">hasLongOpt</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasLongOpt()">hasLongOpt</a></strong>()</code> <div class="block">Query to see if this Option has a long name</div> </td> </tr> -<tr id="i23" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasOptionalArg--">hasOptionalArg</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasOptionalArg()">hasOptionalArg</a></strong>()</code> </td> </tr> -<tr id="i24" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#hasValueSeparator--">hasValueSeparator</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#hasValueSeparator()">hasValueSeparator</a></strong>()</code> <div class="block">Return whether this Option has specified a value separator.</div> </td> </tr> -<tr id="i25" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#isRequired--">isRequired</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#isRequired()">isRequired</a></strong>()</code> <div class="block">Query to see if this Option is mandatory</div> </td> </tr> -<tr id="i26" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setArgName-java.lang.String-">setArgName</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> argName)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setArgName(java.lang.String)">setArgName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> argName)</code> <div class="block">Sets the display name for the argument value.</div> </td> </tr> -<tr id="i27" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setArgs-int-">setArgs</a></span>(int num)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setArgs(int)">setArgs</a></strong>(int num)</code> <div class="block">Sets the number of argument values this Option can take.</div> </td> </tr> -<tr id="i28" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setDescription-java.lang.String-">setDescription</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setDescription(java.lang.String)">setDescription</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> <div class="block">Sets the self-documenting description of this Option</div> </td> </tr> -<tr id="i29" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setLongOpt-java.lang.String-">setLongOpt</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setLongOpt(java.lang.String)">setLongOpt</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt)</code> <div class="block">Sets the long name of this Option.</div> </td> </tr> -<tr id="i30" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setOptionalArg-boolean-">setOptionalArg</a></span>(boolean optionalArg)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setOptionalArg(boolean)">setOptionalArg</a></strong>(boolean optionalArg)</code> <div class="block">Sets whether this Option can have an optional argument.</div> </td> </tr> -<tr id="i31" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setRequired-boolean-">setRequired</a></span>(boolean required)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setRequired(boolean)">setRequired</a></strong>(boolean required)</code> <div class="block">Sets whether this Option is mandatory.</div> </td> </tr> -<tr id="i32" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setType-java.lang.Class-">setType</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setType(java.lang.Class)">setType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code> <div class="block">Sets the type of this Option.</div> </td> </tr> -<tr id="i33" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setType-java.lang.Object-">setType</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> type)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#setType-java.lang.Class-"><code>setType(Class)</code></a> instead</span></div> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setType(java.lang.Object)">setType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> type)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#setType(java.lang.Class)"><code>setType(Class)</code></a> instead</i></div> </div> </td> </tr> -<tr id="i34" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#setValueSeparator-char-">setValueSeparator</a></span>(char sep)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#setValueSeparator(char)">setValueSeparator</a></strong>(char sep)</code> <div class="block">Sets the value separator.</div> </td> </tr> -<tr id="i35" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/Option.html#toString--">toString</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/Option.html#toString()">toString</a></strong>()</code> <div class="block">Dump state, suitable for debugging.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> -<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/a pi/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/a pi/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -472,7 +455,7 @@ implements <a href="http://download.orac <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.detail"> +<li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> @@ -484,10 +467,7 @@ implements <a href="http://download.orac <h4>UNINITIALIZED</h4> <pre>public static final int <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.45">UNINITIALIZED</a></pre> <div class="block">constant that specifies the number of argument values has not been specified</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.commons.cli.Option.UNINITIALIZED">Constant Field Values</a></dd> -</dl> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.commons.cli.Option.UNINITIALIZED">Constant Field Values</a></dd></dl> </li> </ul> <a name="UNLIMITED_VALUES"> @@ -498,96 +478,78 @@ implements <a href="http://download.orac <h4>UNLIMITED_VALUES</h4> <pre>public static final int <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.48">UNLIMITED_VALUES</a></pre> <div class="block">constant that specifies the number of argument values is infinite</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.commons.cli.Option.UNLIMITED_VALUES">Constant Field Values</a></dd> -</dl> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.commons.cli.Option.UNLIMITED_VALUES">Constant Field Values</a></dd></dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> +<li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="Option-java.lang.String-java.lang.String-"> +<a name="Option(java.lang.String, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Option</h4> <pre>public <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.111">Option</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> <div class="block">Creates an Option using the specified parameters. The option does not take an argument.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>opt</code> - short representation of the option</dd> -<dd><code>description</code> - describes the function of the option</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - short representation of the option</dd><dd><code>description</code> - describes the function of the option</dd> +<dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are any non valid - Option characters in <code>opt</code>.</dd> -</dl> + Option characters in <code>opt</code>.</dd></dl> </li> </ul> -<a name="Option-java.lang.String-boolean-java.lang.String-"> +<a name="Option(java.lang.String, boolean, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Option</h4> <pre>public <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.126">Option</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - boolean hasArg, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) + boolean hasArg, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> <div class="block">Creates an Option using the specified parameters.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>opt</code> - short representation of the option</dd> -<dd><code>hasArg</code> - specifies whether the Option takes an argument or not</dd> -<dd><code>description</code> - describes the function of the option</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - short representation of the option</dd><dd><code>hasArg</code> - specifies whether the Option takes an argument or not</dd><dd><code>description</code> - describes the function of the option</dd> +<dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are any non valid - Option characters in <code>opt</code>.</dd> -</dl> + Option characters in <code>opt</code>.</dd></dl> </li> </ul> -<a name="Option-java.lang.String-java.lang.String-boolean-java.lang.String-"> +<a name="Option(java.lang.String, java.lang.String, boolean, java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Option</h4> <pre>public <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.142">Option</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt, - boolean hasArg, - <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt, + boolean hasArg, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description) throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> <div class="block">Creates an Option using the specified parameters.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>opt</code> - short representation of the option</dd> -<dd><code>longOpt</code> - the long representation of the option</dd> -<dd><code>hasArg</code> - specifies whether the Option takes an argument or not</dd> -<dd><code>description</code> - describes the function of the option</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - short representation of the option</dd><dd><code>longOpt</code> - the long representation of the option</dd><dd><code>hasArg</code> - specifies whether the Option takes an argument or not</dd><dd><code>description</code> - describes the function of the option</dd> +<dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are any non valid - Option characters in <code>opt</code>.</dd> -</dl> + Option characters in <code>opt</code>.</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getId--"> +<a name="getId()"> <!-- --> </a> <ul class="blockList"> @@ -597,13 +559,10 @@ implements <a href="http://download.orac <div class="block">Returns 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> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the id of this Option</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the id of this Option</dd></dl> </li> </ul> -<a name="getOpt--"> +<a name="getOpt()"> <!-- --> </a> <ul class="blockList"> @@ -613,16 +572,13 @@ implements <a href="http://download.orac <div class="block">Retrieve the name of this Option. It is this String which can be used with - <a href="../../../../org/apache/commons/cli/CommandLine.html#hasOption-java.lang.String-"><code>CommandLine.hasOption(String opt)</code></a> and - <a href="../../../../org/apache/commons/cli/CommandLine.html#getOptionValue-java.lang.String-"><code>CommandLine.getOptionValue(String opt)</code></a> to check + <a href="../../../../org/apache/commons/cli/CommandLine.html#hasOption(java.lang.String)"><code>CommandLine.hasOption(String opt)</code></a> and + <a href="../../../../org/apache/commons/cli/CommandLine.html#getOptionValue(java.lang.String)"><code>CommandLine.getOptionValue(String opt)</code></a> to check for existence and argument.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The name of this option</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>The name of this option</dd></dl> </li> </ul> -<a name="getType--"> +<a name="getType()"> <!-- --> </a> <ul class="blockList"> @@ -630,13 +586,10 @@ implements <a href="http://download.orac <h4>getType</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.203">getType</a>()</pre> <div class="block">Retrieve the type of this Option.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The type of this option</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>The type of this option</dd></dl> </li> </ul> -<a name="setType-java.lang.Object-"> +<a name="setType(java.lang.Object)"> <!-- --> </a> <ul class="blockList"> @@ -644,18 +597,15 @@ implements <a href="http://download.orac <h4>setType</h4> <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.218">setType</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> type)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#setType-java.lang.Class-"><code>setType(Class)</code></a> instead</span></div> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#setType(java.lang.Class)"><code>setType(Class)</code></a> instead</i></div> <div class="block">Sets the type of this Option. <p> <b>Note:</b> this method is kept for binary compatibility and the input type is supposed to be a <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> object.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>type</code> - the type of this Option</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type of this Option</dd></dl> </li> </ul> -<a name="setType-java.lang.Class-"> +<a name="setType(java.lang.Class)"> <!-- --> </a> <ul class="blockList"> @@ -663,15 +613,11 @@ public void <a href="../../../ <h4>setType</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.229">setType</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</pre> <div class="block">Sets the type of this Option.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>type</code> - the type of this Option</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.3</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type of this Option</dd><dt><span class="strong">Since:</span></dt> + <dd>1.3</dd></dl> </li> </ul> -<a name="getLongOpt--"> +<a name="getLongOpt()"> <!-- --> </a> <ul class="blockList"> @@ -679,13 +625,10 @@ public void <a href="../../../ <h4>getLongOpt</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.239">getLongOpt</a>()</pre> <div class="block">Retrieve the long name of this Option.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>Long name of this option, or null, if there is no long name</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>Long name of this option, or null, if there is no long name</dd></dl> </li> </ul> -<a name="setLongOpt-java.lang.String-"> +<a name="setLongOpt(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -693,13 +636,10 @@ public void <a href="../../../ <h4>setLongOpt</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.249">setLongOpt</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> longOpt)</pre> <div class="block">Sets the long name of this Option.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>longOpt</code> - the long name of this Option</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>longOpt</code> - the long name of this Option</dd></dl> </li> </ul> -<a name="setOptionalArg-boolean-"> +<a name="setOptionalArg(boolean)"> <!-- --> </a> <ul class="blockList"> @@ -707,27 +647,21 @@ public void <a href="../../../ <h4>setOptionalArg</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.260">setOptionalArg</a>(boolean optionalArg)</pre> <div class="block">Sets whether this Option can have an optional argument.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>optionalArg</code> - specifies whether the Option can have - an optional argument.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>optionalArg</code> - specifies whether the Option can have + an optional argument.</dd></dl> </li> </ul> -<a name="hasOptionalArg--"> +<a name="hasOptionalArg()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasOptionalArg</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.268">hasOptionalArg</a>()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>whether this Option can have an optional argument</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>whether this Option can have an optional argument</dd></dl> </li> </ul> -<a name="hasLongOpt--"> +<a name="hasLongOpt()"> <!-- --> </a> <ul class="blockList"> @@ -735,13 +669,10 @@ public void <a href="../../../ <h4>hasLongOpt</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.278">hasLongOpt</a>()</pre> <div class="block">Query to see if this Option has a long name</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>boolean flag indicating existence of a long name</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean flag indicating existence of a long name</dd></dl> </li> </ul> -<a name="hasArg--"> +<a name="hasArg()"> <!-- --> </a> <ul class="blockList"> @@ -749,13 +680,10 @@ public void <a href="../../../ <h4>hasArg</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.288">hasArg</a>()</pre> <div class="block">Query to see if this Option requires an argument</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>boolean flag indicating if an argument is required</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean flag indicating if an argument is required</dd></dl> </li> </ul> -<a name="getDescription--"> +<a name="getDescription()"> <!-- --> </a> <ul class="blockList"> @@ -763,13 +691,10 @@ public void <a href="../../../ <h4>getDescription</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.298">getDescription</a>()</pre> <div class="block">Retrieve the self-documenting description of this Option</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The string description of this option</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>The string description of this option</dd></dl> </li> </ul> -<a name="setDescription-java.lang.String-"> +<a name="setDescription(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -777,15 +702,11 @@ public void <a href="../../../ <h4>setDescription</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.309">setDescription</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre> <div class="block">Sets the self-documenting description of this Option</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>description</code> - The description of this option</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.1</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - The description of this option</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1</dd></dl> </li> </ul> -<a name="isRequired--"> +<a name="isRequired()"> <!-- --> </a> <ul class="blockList"> @@ -793,13 +714,10 @@ public void <a href="../../../ <h4>isRequired</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.319">isRequired</a>()</pre> <div class="block">Query to see if this Option is mandatory</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>boolean flag indicating whether this Option is mandatory</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean flag indicating whether this Option is mandatory</dd></dl> </li> </ul> -<a name="setRequired-boolean-"> +<a name="setRequired(boolean)"> <!-- --> </a> <ul class="blockList"> @@ -807,13 +725,10 @@ public void <a href="../../../ <h4>setRequired</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.329">setRequired</a>(boolean required)</pre> <div class="block">Sets whether this Option is mandatory.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>required</code> - specifies whether this Option is mandatory</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>required</code> - specifies whether this Option is mandatory</dd></dl> </li> </ul> -<a name="setArgName-java.lang.String-"> +<a name="setArgName(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -821,13 +736,10 @@ public void <a href="../../../ <h4>setArgName</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.339">setArgName</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> argName)</pre> <div class="block">Sets the display name for the argument value.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>argName</code> - the display name for the argument value.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>argName</code> - the display name for the argument value.</dd></dl> </li> </ul> -<a name="getArgName--"> +<a name="getArgName()"> <!-- --> </a> <ul class="blockList"> @@ -835,13 +747,10 @@ public void <a href="../../../ <h4>getArgName</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.349">getArgName</a>()</pre> <div class="block">Gets the display name for the argument value.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the display name for the argument value.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the display name for the argument value.</dd></dl> </li> </ul> -<a name="hasArgName--"> +<a name="hasArgName()"> <!-- --> </a> <ul class="blockList"> @@ -849,13 +758,10 @@ public void <a href="../../../ <h4>hasArgName</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.359">hasArgName</a>()</pre> <div class="block">Returns whether the display name for the argument value has been set.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>if the display name for the argument value has been set.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>if the display name for the argument value has been set.</dd></dl> </li> </ul> -<a name="hasArgs--"> +<a name="hasArgs()"> <!-- --> </a> <ul class="blockList"> @@ -863,13 +769,10 @@ public void <a href="../../../ <h4>hasArgs</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.369">hasArgs</a>()</pre> <div class="block">Query to see if this Option can take many values.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>boolean flag indicating if multiple values are allowed</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean flag indicating if multiple values are allowed</dd></dl> </li> </ul> -<a name="setArgs-int-"> +<a name="setArgs(int)"> <!-- --> </a> <ul class="blockList"> @@ -877,13 +780,10 @@ public void <a href="../../../ <h4>setArgs</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.379">setArgs</a>(int num)</pre> <div class="block">Sets the number of argument values this Option can take.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>num</code> - the number of argument values</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>num</code> - the number of argument values</dd></dl> </li> </ul> -<a name="setValueSeparator-char-"> +<a name="setValueSeparator(char)"> <!-- --> </a> <ul class="blockList"> @@ -892,13 +792,10 @@ public void <a href="../../../ <pre>public void <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.390">setValueSeparator</a>(char sep)</pre> <div class="block">Sets the value separator. For example if the argument value was a Java property, the value separator would be '='.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>sep</code> - The value separator.</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sep</code> - The value separator.</dd></dl> </li> </ul> -<a name="getValueSeparator--"> +<a name="getValueSeparator()"> <!-- --> </a> <ul class="blockList"> @@ -906,13 +803,10 @@ public void <a href="../../../ <h4>getValueSeparator</h4> <pre>public char <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.400">getValueSeparator</a>()</pre> <div class="block">Returns the value separator character.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the value separator character.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the value separator character.</dd></dl> </li> </ul> -<a name="hasValueSeparator--"> +<a name="hasValueSeparator()"> <!-- --> </a> <ul class="blockList"> @@ -920,15 +814,11 @@ public void <a href="../../../ <h4>hasValueSeparator</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.411">hasValueSeparator</a>()</pre> <div class="block">Return whether this Option has specified a value separator.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>whether this Option has specified a value separator.</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.1</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>whether this Option has specified a value separator.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1</dd></dl> </li> </ul> -<a name="getArgs--"> +<a name="getArgs()"> <!-- --> </a> <ul class="blockList"> @@ -943,16 +833,11 @@ public void <a href="../../../ A value equal to the constant <a href="../../../../org/apache/commons/cli/Option.html#UNLIMITED_VALUES"><code>UNLIMITED_VALUES</code></a> (= -2) indicates that this options takes an unlimited amount of values. </p></div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>num the number of argument values</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../org/apache/commons/cli/Option.html#UNINITIALIZED"><code>UNINITIALIZED</code></a>, -<a href="../../../../org/apache/commons/cli/Option.html#UNLIMITED_VALUES"><code>UNLIMITED_VALUES</code></a></dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>num the number of argument values</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/cli/Option.html#UNINITIALIZED"><code>UNINITIALIZED</code></a>, +<a href="../../../../org/apache/commons/cli/Option.html#UNLIMITED_VALUES"><code>UNLIMITED_VALUES</code></a></dd></dl> </li> </ul> -<a name="getValue--"> +<a name="getValue()"> <!-- --> </a> <ul class="blockList"> @@ -961,14 +846,11 @@ public void <a href="../../../ <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.522">getValue</a>()</pre> <div class="block">Returns the specified value of this Option or <code>null</code> if there is no value.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the value/first value of this Option or - <code>null</code> if there is no value.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the value/first value of this Option or + <code>null</code> if there is no value.</dd></dl> </li> </ul> -<a name="getValue-int-"> +<a name="getValue(int)"> <!-- --> </a> <ul class="blockList"> @@ -978,19 +860,15 @@ public void <a href="../../../ throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></pre> <div class="block">Returns the specified value of this Option or <code>null</code> if there is no value.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>index</code> - The index of the value to be returned.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the specified value of this Option or +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The index of the value to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the specified value of this Option or <code>null</code> if there is no value.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - if index is less than 1 - or greater than the number of the values for this Option.</dd> -</dl> + or greater than the number of the values for this Option.</dd></dl> </li> </ul> -<a name="getValue-java.lang.String-"> +<a name="getValue(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -999,17 +877,13 @@ public void <a href="../../../ <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.554">getValue</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre> <div class="block">Returns the value/first value of this Option or the <code>defaultValue</code> if there is no value.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>defaultValue</code> - The value to be returned if there +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - The value to be returned if there is no value.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the value/first value of this Option or the - <code>defaultValue</code> if there are no values.</dd> -</dl> +<dt><span class="strong">Returns:</span></dt><dd>the value/first value of this Option or the + <code>defaultValue</code> if there are no values.</dd></dl> </li> </ul> -<a name="getValues--"> +<a name="getValues()"> <!-- --> </a> <ul class="blockList"> @@ -1018,28 +892,22 @@ public void <a href="../../../ <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.568">getValues</a>()</pre> <div class="block">Return the values of this Option as a String array or null if there are no values</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the values of this Option as a String array - or null if there are no values</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the values of this Option as a String array + or null if there are no values</dd></dl> </li> </ul> -<a name="getValuesList--"> +<a name="getValuesList()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValuesList</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.577">getValuesList</a>()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the values of this Option as a List - or null if there are no values</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the values of this Option as a List + or null if there are no values</dd></dl> </li> </ul> -<a name="toString--"> +<a name="toString()"> <!-- --> </a> <ul class="blockList"> @@ -1048,14 +916,12 @@ public void <a href="../../../ <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.588">toString</a>()</pre> <div class="block">Dump state, suitable for debugging.</div> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>Stringified form of this object</dd> -</dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Stringified form of this object</dd></dl> </li> </ul> -<a name="equals-java.lang.Object-"> +<a name="equals(java.lang.Object)"> <!-- --> </a> <ul class="blockList"> @@ -1063,31 +929,31 @@ public void <a href="../../../ <h4>equals</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.633">equals</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> -<a name="hashCode--"> +<a name="hashCode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> -<pre>public int <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.660">hashCode</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.659">hashCode</a>()</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> -<a name="clone--"> +<a name="clone()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>clone</h4> -<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.681">clone</a>()</pre> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.680">clone</a>()</pre> <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 compat at the API level. @@ -1095,73 +961,58 @@ public void <a href="../../../ After calling this method, it is very likely you will want to call clearValues().</div> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a clone of this Option instance</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a clone of this Option instance</dd> +<dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if a <a href="http://download.oracle.com/javase/6/docs/api/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang"><code>CloneNotSupportedException</code></a> has been thrown - by <code>super.clone()</code></dd> -</dl> + by <code>super.clone()</code></dd></dl> </li> </ul> -<a name="addValue-java.lang.String-"> +<a name="addValue(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addValue</h4> <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.716">addValue</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +public boolean <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.715">addValue</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i></i></div> <div class="block">This method is not intended to be used. It was a piece of internal API that was made public in 1.0. It currently throws an UnsupportedOperationException.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>value</code> - the value to add</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>always throws an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a></dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - always</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to add</dd> +<dt><span class="strong">Returns:</span></dt><dd>always throws an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - always</dd></dl> </li> </ul> -<a name="builder--"> +<a name="builder()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>builder</h4> -<pre>public static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.759">builder</a>()</pre> +<pre>public static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.758">builder</a>()</pre> <div class="block">Returns a <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> instance</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.3</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> instance</dd><dt><span class="strong">Since:</span></dt> + <dd>1.3</dd></dl> </li> </ul> -<a name="builder-java.lang.String-"> +<a name="builder(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>builder</h4> -<pre>public static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.773">builder</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt)</pre> +<pre>public static <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a> <a href="../../../../src-html/org/apache/commons/cli/Option.html#line.772">builder</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opt)</pre> <div class="block">Returns a <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive methods.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>opt</code> - short representation of the option</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> instance</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are any non valid Option characters in <code>opt</code></dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.3</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - short representation of the option</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are any non valid Option characters in <code>opt</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.3</dd></dl> </li> </ul> </li> @@ -1172,11 +1023,9 @@ public boolean <a href="../../ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -1191,15 +1040,15 @@ public boolean <a href="../../ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li>
[... 42 lines stripped ...]