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 Sat May 9 18:19:15 2015 @@ -2,24 +2,38 @@ <!-- NewPage --> <html lang="de"> <head> -<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> -<title>OptionBuilder (Apache Commons CLI 1.3-SNAPSHOT API)</title> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<title>OptionBuilder (Apache Commons CLI 1.3 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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OptionBuilder (Apache Commons CLI 1.3-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OptionBuilder (Apache Commons CLI 1.3 API)"; + } + } + catch(err) { } //--> +var methods = {"i0":41,"i1":41,"i2":41,"i3":41,"i4":41,"i5":41,"i6":41,"i7":41,"i8":41,"i9":41,"i10":41,"i11":41,"i12":41,"i13":41,"i14":41,"i15":41,"i16":41,"i17":41,"i18":41}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -34,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/OptionBuilder.html" target="_top">Frames</a></li> -<li><a href="OptionBuilder.html" target="_top">No Frames</a></li> +<li><a href="OptionBuilder.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"><!-- @@ -62,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</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 ========= --> @@ -93,8 +107,8 @@ <ul class="blockList"> <li class="blockList"> <hr> -<div class="block"><strong>Deprecated.</strong> -<div class="block"><i>since 1.3, use <a href="../../../../org/apache/commons/cli/Option.html#builder(java.lang.String)"><code>Option.builder(String)</code></a> instead</i></div> +<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#builder-java.lang.String-"><code>Option.builder(String)</code></a> instead</span></div> </div> <br> <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> @@ -106,10 +120,12 @@ extends <a href="http://download.oracle. <a href="http://c2.com/cgi-bin/wiki?BuilderPattern">http://c2.com/cgi-bin/wiki?BuilderPattern</a>. <p> This class is NOT thread safe. See <a href="https://issues.apache.org/jira/browse/CLI-209">CLI-209</a></div> -<dl><dt><span class="strong">Since:</span></dt> - <dd>1.0</dd> -<dt><span class="strong">Version:</span></dt> - <dd>$Id: OptionBuilder.java 1669814 2015-03-28 18:09:26Z britter $</dd></dl> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id: OptionBuilder.java 1677400 2015-05-03 13:46:08Z britter $</dd> +</dl> </li> </ul> </div> @@ -118,164 +134,164 @@ extends <a href="http://download.oracle. <li class="blockList"> <!-- ========== 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="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> +<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="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> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create()">create</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create--">create</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create(char)">create</a></strong>(char opt)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create-char-">create</a></span>(char opt)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings and with the specified Option <code>char</code>.</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create(java.lang.String)">create</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"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#create-java.lang.String-">create</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> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings and with the specified Option <code>char</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg()">hasArg</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg--">hasArg</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will require an argument value.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg(boolean)">hasArg</a></strong>(boolean hasArg)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArg-boolean-">hasArg</a></span>(boolean hasArg)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will require an argument value if <code>hasArg</code> is true.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs()">hasArgs</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs--">hasArgs</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created can have unlimited argument values.</div> </td> </tr> -<tr class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs(int)">hasArgs</a></strong>(int num)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasArgs-int-">hasArgs</a></span>(int num)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created can have <code>num</code> argument values.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArg()">hasOptionalArg</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArg--">hasOptionalArg</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have an optional argument.</div> </td> </tr> -<tr class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs()">hasOptionalArgs</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs--">hasOptionalArgs</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have an unlimited number of optional arguments.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs(int)">hasOptionalArgs</a></strong>(int numArgs)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs-int-">hasOptionalArgs</a></span>(int numArgs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have the specified number of optional arguments.</div> </td> </tr> -<tr class="altColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired()">isRequired</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired--">isRequired</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will be required.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired(boolean)">isRequired</a></strong>(boolean newRequired)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#isRequired-boolean-">isRequired</a></span>(boolean newRequired)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will be required if <code>required</code> is true.</div> </td> </tr> -<tr class="altColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withArgName(java.lang.String)">withArgName</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> name)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withArgName-java.lang.String-">withArgName</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> name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the specified argument value name.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withDescription(java.lang.String)">withDescription</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> newDescription)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withDescription-java.lang.String-">withDescription</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> newDescription)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the specified description</div> </td> </tr> -<tr class="altColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withLongOpt(java.lang.String)">withLongOpt</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> newLongopt)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withLongOpt-java.lang.String-">withLongOpt</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> newLongopt)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the following long option value.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i15" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType(java.lang.Class)">withType</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><?> newType)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-">withType</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><?> newType)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have a value that will be an instance of <code>type</code>.</div> </td> </tr> -<tr class="altColor"> +<tr id="i16" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType(java.lang.Object)">withType</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> newType)</code> -<div class="block"><strong>Deprecated.</strong> -<div class="block"><i>since 1.3, use <a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType(java.lang.Class)"><code>withType(Class)</code></a> instead</i></div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Object-">withType</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> newType)</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/OptionBuilder.html#withType-java.lang.Class-"><code>withType(Class)</code></a> instead</span></div> </div> </td> </tr> -<tr class="rowColor"> +<tr id="i17" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator()">withValueSeparator</a></strong>()</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator--">withValueSeparator</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created uses '<code>=</code>' as a means to separate argument values.</div> </td> </tr> -<tr class="altColor"> +<tr id="i18" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator(char)">withValueSeparator</a></strong>(char sep)</code> -<div class="block"><strong>Deprecated.</strong> </div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionBuilder.html#withValueSeparator-char-">withValueSeparator</a></span>(char sep)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created uses <code>sep</code> as a means to separate argument values.</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#clone()" title="class or interface in java.lang">clone</a>, <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>, <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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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#clone--" title="class or interface in java.lang">clone</a>, <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>, <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#hashCode--" title="class or interface in java.lang">hashCode</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#toString--" title="class or interface in java.lang">toString</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/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -287,82 +303,100 @@ extends <a href="http://download.oracle. <li class="blockList"> <!-- ============ 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="withLongOpt(java.lang.String)"> +<a name="withLongOpt-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withLongOpt</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.97">withLongOpt</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> newLongopt)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the following long option value.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newLongopt</code> - the long option value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newLongopt</code> - the long option value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasArg()"> +<a name="hasArg--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasArg</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.109">hasArg</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will require an argument value.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasArg(boolean)"> +<a name="hasArg-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasArg</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.123">hasArg</a>(boolean hasArg)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will require an argument value if <code>hasArg</code> is true.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hasArg</code> - if true then the Option has an argument value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hasArg</code> - if true then the Option has an argument value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="withArgName(java.lang.String)"> +<a name="withArgName-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withArgName</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.136">withArgName</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> name)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the specified argument value name.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name for the argument value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name for the argument value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="isRequired()"> +<a name="isRequired--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRequired</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.148">isRequired</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will be required.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="withValueSeparator(char)"> +<a name="withValueSeparator-char-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withValueSeparator</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.174">withValueSeparator</a>(char sep)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created uses <code>sep</code> as a means to separate argument values. <p> @@ -376,18 +410,22 @@ extends <a href="http://download.oracle. String propertyName = opt.getValue(0); // will be "key" String propertyValue = opt.getValue(1); // will be "value" </pre></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sep</code> - The value separator to be used for the argument values.</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sep</code> - The value separator to be used for the argument values.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="withValueSeparator()"> +<a name="withValueSeparator--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withValueSeparator</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.197">withValueSeparator</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created uses '<code>=</code>' as a means to separate argument values. @@ -400,87 +438,111 @@ extends <a href="http://download.oracle. String propertyName = opt.getValue(0); String propertyValue = opt.getValue(1); </pre></div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="isRequired(boolean)"> +<a name="isRequired-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRequired</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.211">isRequired</a>(boolean newRequired)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will be required if <code>required</code> is true.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newRequired</code> - if true then the Option is required</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newRequired</code> - if true then the Option is required</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasArgs()"> +<a name="hasArgs--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasArgs</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.223">hasArgs</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created can have unlimited argument values.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasArgs(int)"> +<a name="hasArgs-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasArgs</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.236">hasArgs</a>(int num)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created can have <code>num</code> argument values.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>num</code> - the number of args that the option can have</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>num</code> - the number of args that the option can have</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasOptionalArg()"> +<a name="hasOptionalArg--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasOptionalArg</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.248">hasOptionalArg</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have an optional argument.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasOptionalArgs()"> +<a name="hasOptionalArgs--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasOptionalArgs</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.261">hasOptionalArgs</a>()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have an unlimited number of optional arguments.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="hasOptionalArgs(int)"> +<a name="hasOptionalArgs-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasOptionalArgs</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.276">hasOptionalArgs</a>(int numArgs)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option can have the specified number of optional arguments.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numArgs</code> - - the maximum number of optional arguments +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>numArgs</code> - - the maximum number of optional arguments the next Option created can have.</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="withType(java.lang.Object)"> +<a name="withType-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -488,45 +550,58 @@ extends <a href="http://download.oracle. <h4>withType</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 static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.296">withType</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> newType)</pre> -<div class="block"><span class="strong">Deprecated.</span> <i>since 1.3, use <a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType(java.lang.Class)"><code>withType(Class)</code></a> instead</i></div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-"><code>withType(Class)</code></a> instead</span></div> <div class="block">The next Option created will have a value that will be an instance of <code>type</code>. <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="strong">Parameters:</span></dt><dd><code>newType</code> - the type of the Options argument value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newType</code> - the type of the Options argument value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="withType(java.lang.Class)"> +<a name="withType-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withType</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.309">withType</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><?> newType)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have a value that will be an instance of <code>type</code>.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newType</code> - the type of the Options argument value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd><dt><span class="strong">Since:</span></dt> - <dd>1.3</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newType</code> - the type of the Options argument value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.3</dd> +</dl> </li> </ul> -<a name="withDescription(java.lang.String)"> +<a name="withDescription-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withDescription</h4> <pre>public static <a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.322">withDescription</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> newDescription)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">The next Option created will have the specified description</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newDescription</code> - a description of the Option's purpose</dd> -<dt><span class="strong">Returns:</span></dt><dd>the OptionBuilder instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newDescription</code> - a description of the Option's purpose</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OptionBuilder instance</dd> +</dl> </li> </ul> -<a name="create(char)"> +<a name="create-char-"> <!-- --> </a> <ul class="blockList"> @@ -534,17 +609,21 @@ public static <a href="../../../../ <h4>create</h4> <pre>public static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.338">create</a>(char opt) 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"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings and with the specified Option <code>char</code>.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - the character representation of the Option</dd> -<dt><span class="strong">Returns:</span></dt><dd>the Option instance</dd> -<dt><span class="strong">Throws:</span></dt> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>opt</code> - the character representation of the Option</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Option 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 <code>opt</code> is not - a valid character. See Option.</dd></dl> + a valid character. See Option.</dd> +</dl> </li> </ul> -<a name="create()"> +<a name="create--"> <!-- --> </a> <ul class="blockList"> @@ -552,14 +631,17 @@ public static <a href="../../../../ <h4>create</h4> <pre>public static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.349">create</a>() 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"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the Option 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 <code>longOpt</code> has not been set.</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Option 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 <code>longOpt</code> has not been set.</dd> +</dl> </li> </ul> -<a name="create(java.lang.String)"> +<a name="create-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> @@ -567,15 +649,19 @@ public static <a href="../../../../ <h4>create</h4> <pre>public static <a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> <a href="../../../../src-html/org/apache/commons/cli/OptionBuilder.html#line.370">create</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) 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"><span class="strong">Deprecated.</span> </div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create an Option using the current settings and with the specified Option <code>char</code>.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opt</code> - the <code>java.lang.String</code> representation +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>opt</code> - the <code>java.lang.String</code> representation of the Option</dd> -<dt><span class="strong">Returns:</span></dt><dd>the Option instance</dd> -<dt><span class="strong">Throws:</span></dt> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Option 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 <code>opt</code> is not - a valid character. See Option.</dd></dl> + a valid character. See Option.</dd> +</dl> </li> </ul> </li> @@ -586,9 +672,11 @@ public static <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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -603,15 +691,15 @@ public static <a href="../../../../ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/OptionBuilder.html" target="_top">Frames</a></li> -<li><a href="OptionBuilder.html" target="_top">No Frames</a></li> +<li><a href="OptionBuilder.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<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"><!-- @@ -631,16 +719,16 @@ public static <a href="../../../../ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionGroup.html ============================================================================== --- websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionGroup.html (original) +++ websites/production/commons/content/proper/commons-cli/apidocs/org/apache/commons/cli/OptionGroup.html Sat May 9 18:19:15 2015 @@ -2,24 +2,38 @@ <!-- NewPage --> <html lang="de"> <head> -<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> -<title>OptionGroup (Apache Commons CLI 1.3-SNAPSHOT API)</title> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<title>OptionGroup (Apache Commons CLI 1.3 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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OptionGroup (Apache Commons CLI 1.3-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OptionGroup (Apache Commons CLI 1.3 API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -34,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/OptionGroup.html" target="_top">Frames</a></li> -<li><a href="OptionGroup.html" target="_top">No Frames</a></li> +<li><a href="OptionGroup.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"><!-- @@ -61,17 +75,17 @@ <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</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>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</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 ========= --> @@ -102,9 +116,12 @@ extends <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> implements <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> <div class="block">A group of mutually exclusive options.</div> -<dl><dt><span class="strong">Version:</span></dt> - <dd>$Id: OptionGroup.java 1669814 2015-03-28 18:09:26Z britter $</dd> -<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.commons.cli.OptionGroup">Serialized Form</a></dd></dl> +<dl> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id: OptionGroup.java 1669814 2015-03-28 18:09:26Z britter $</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.commons.cli.OptionGroup">Serialized Form</a></dd> +</dl> </li> </ul> </div> @@ -113,80 +130,80 @@ implements <a href="http://download.orac <li class="blockList"> <!-- ======== 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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="memberSummary" 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><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#OptionGroup()">OptionGroup</a></strong>()</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#OptionGroup--">OptionGroup</a></span>()</code> </td> </tr> </table> </li> </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="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> +<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="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></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#addOption(org.apache.commons.cli.Option)">addOption</a></strong>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#addOption-org.apache.commons.cli.Option-">addOption</a></span>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option)</code> <div class="block">Add the specified <code>Option</code> to this group.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#getNames()">getNames</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#getNames--">getNames</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#getOptions()">getOptions</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#getOptions--">getOptions</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i3" 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><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#getSelected()">getSelected</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#getSelected--">getSelected</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#isRequired()">isRequired</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#isRequired--">isRequired</a></span>()</code> <div class="block">Returns whether this option group is required.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#setRequired(boolean)">setRequired</a></strong>(boolean required)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#setRequired-boolean-">setRequired</a></span>(boolean required)</code> </td> </tr> -<tr class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#setSelected(org.apache.commons.cli.Option)">setSelected</a></strong>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#setSelected-org.apache.commons.cli.Option-">setSelected</a></span>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option)</code> <div class="block">Set the selected option of this group to <code>name</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i7" 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><strong><a href="../../../../org/apache/commons/cli/OptionGroup.html#toString()">toString</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/cli/OptionGroup.html#toString--">toString</a></span>()</code> <div class="block">Returns the stringified version of this OptionGroup.</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#clone()" title="class or interface in java.lang">clone</a>, <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>, <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#hashCode()" title="class or interface in java.lang">hashCode</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/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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#clone--" title="class or interface in java.lang">clone</a>, <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>, <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#hashCode--" title="class or interface in java.lang">hashCode</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/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -198,11 +215,11 @@ implements <a href="http://download.orac <li class="blockList"> <!-- ========= 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="OptionGroup()"> +<a name="OptionGroup--"> <!-- --> </a> <ul class="blockListLast"> @@ -215,11 +232,11 @@ implements <a href="http://download.orac </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="addOption(org.apache.commons.cli.Option)"> +<a name="addOption-org.apache.commons.cli.Option-"> <!-- --> </a> <ul class="blockList"> @@ -227,32 +244,42 @@ implements <a href="http://download.orac <h4>addOption</h4> <pre>public <a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a> <a href="../../../../src-html/org/apache/commons/cli/OptionGroup.html#line.51">addOption</a>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option)</pre> <div class="block">Add the specified <code>Option</code> to this group.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>option</code> - the option to add to this group</dd> -<dt><span class="strong">Returns:</span></dt><dd>this option group with the option added</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>option</code> - the option to add to this group</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this option group with the option added</dd> +</dl> </li> </ul> -<a name="getNames()"> +<a name="getNames--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNames</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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/OptionGroup.html#line.64">getNames</a>()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the options in this group as a - <code>Collection</code></dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the names of the options in this group as a + <code>Collection</code></dd> +</dl> </li> </ul> -<a name="getOptions()"> +<a name="getOptions--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOptions</h4> <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a>> <a href="../../../../src-html/org/apache/commons/cli/OptionGroup.html#line.73">getOptions</a>()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the options in this group as a <code>Collection</code></dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the options in this group as a <code>Collection</code></dd> +</dl> </li> </ul> -<a name="setSelected(org.apache.commons.cli.Option)"> +<a name="setSelected-org.apache.commons.cli.Option-"> <!-- --> </a> <ul class="blockList"> @@ -261,33 +288,42 @@ implements <a href="http://download.orac <pre>public void <a href="../../../../src-html/org/apache/commons/cli/OptionGroup.html#line.86">setSelected</a>(<a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a> option) throws <a href="../../../../org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></pre> <div class="block">Set the selected option of this group to <code>name</code>.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>option</code> - the option that is selected</dd> -<dt><span class="strong">Throws:</span></dt> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>option</code> - the option that is selected</dd> +<dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></code> - if an option from this group has - already been selected.</dd></dl> + already been selected.</dd> +</dl> </li> </ul> -<a name="getSelected()"> +<a name="getSelected--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSelected</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/OptionGroup.html#line.111">getSelected</a>()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>the selected option name</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the selected option name</dd> +</dl> </li> </ul> -<a name="setRequired(boolean)"> +<a name="setRequired-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setRequired</h4> <pre>public void <a href="../../../../src-html/org/apache/commons/cli/OptionGroup.html#line.119">setRequired</a>(boolean required)</pre> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>required</code> - specifies if this group is required</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>required</code> - specifies if this group is required</dd> +</dl> </li> </ul> -<a name="isRequired()"> +<a name="isRequired--"> <!-- --> </a> <ul class="blockList"> @@ -295,10 +331,13 @@ implements <a href="http://download.orac <h4>isRequired</h4> <pre>public boolean <a href="../../../../src-html/org/apache/commons/cli/OptionGroup.html#line.129">isRequired</a>()</pre> <div class="block">Returns whether this option group is required.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>whether this option group is required</dd></dl> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this option group is required</dd> +</dl> </li> </ul> -<a name="toString()"> +<a name="toString--"> <!-- --> </a> <ul class="blockListLast"> @@ -307,9 +346,11 @@ implements <a href="http://download.orac <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/OptionGroup.html#line.140">toString</a>()</pre> <div class="block">Returns the stringified version of this OptionGroup.</div> <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>the stringified representation of this group</dd></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>the stringified representation of this group</dd> +</dl> </li> </ul> </li> @@ -320,9 +361,11 @@ implements <a href="http://download.orac </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -337,15 +380,15 @@ implements <a href="http://download.orac </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/OptionGroup.html" target="_top">Frames</a></li> -<li><a href="OptionGroup.html" target="_top">No Frames</a></li> +<li><a href="OptionGroup.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> -<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"><!-- @@ -364,17 +407,17 @@ implements <a href="http://download.orac <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</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>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->