commons-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject svn commit: r1013656 [24/45] - in /websites/production/commons/content/proper/commons-cli: ./ apidocs/ apidocs/org/apache/commons/cli/ apidocs/org/apache/commons/cli/class-use/ apidocs/resources/ apidocs/src-html/org/apache/commons/cli/ jacoco-aggregat...
Date Thu, 08 Jun 2017 17:47:21 GMT
Modified: websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/Option.html
==============================================================================
--- websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/Option.html (original)
+++ websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/Option.html Thu Jun  8 17:47:18 2017
@@ -45,7 +45,7 @@
 <span class="sourceLineNo">037</span> * @see org.apache.commons.cli.Options<a name="line.37"></a>
 <span class="sourceLineNo">038</span> * @see org.apache.commons.cli.CommandLine<a name="line.38"></a>
 <span class="sourceLineNo">039</span> *<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * @version $Id: Option.java 1756753 2016-08-18 10:18:43Z britter $<a name="line.40"></a>
+<span class="sourceLineNo">040</span> * @version $Id$<a name="line.40"></a>
 <span class="sourceLineNo">041</span> */<a name="line.41"></a>
 <span class="sourceLineNo">042</span>public class Option implements Cloneable, Serializable<a name="line.42"></a>
 <span class="sourceLineNo">043</span>{<a name="line.43"></a>
@@ -116,7 +116,7 @@
 <span class="sourceLineNo">108</span>     * @throws IllegalArgumentException if there are any non valid<a name="line.108"></a>
 <span class="sourceLineNo">109</span>     * Option characters in &lt;code&gt;opt&lt;/code&gt;.<a name="line.109"></a>
 <span class="sourceLineNo">110</span>     */<a name="line.110"></a>
-<span class="sourceLineNo">111</span>    public Option(String opt, String description) throws IllegalArgumentException<a name="line.111"></a>
+<span class="sourceLineNo">111</span>    public Option(final String opt, final String description) throws IllegalArgumentException<a name="line.111"></a>
 <span class="sourceLineNo">112</span>    {<a name="line.112"></a>
 <span class="sourceLineNo">113</span>        this(opt, null, false, description);<a name="line.113"></a>
 <span class="sourceLineNo">114</span>    }<a name="line.114"></a>
@@ -131,7 +131,7 @@
 <span class="sourceLineNo">123</span>     * @throws IllegalArgumentException if there are any non valid<a name="line.123"></a>
 <span class="sourceLineNo">124</span>     * Option characters in &lt;code&gt;opt&lt;/code&gt;.<a name="line.124"></a>
 <span class="sourceLineNo">125</span>     */<a name="line.125"></a>
-<span class="sourceLineNo">126</span>    public Option(String opt, boolean hasArg, String description) throws IllegalArgumentException<a name="line.126"></a>
+<span class="sourceLineNo">126</span>    public Option(final String opt, final boolean hasArg, final String description) throws IllegalArgumentException<a name="line.126"></a>
 <span class="sourceLineNo">127</span>    {<a name="line.127"></a>
 <span class="sourceLineNo">128</span>        this(opt, null, hasArg, description);<a name="line.128"></a>
 <span class="sourceLineNo">129</span>    }<a name="line.129"></a>
@@ -147,7 +147,7 @@
 <span class="sourceLineNo">139</span>     * @throws IllegalArgumentException if there are any non valid<a name="line.139"></a>
 <span class="sourceLineNo">140</span>     * Option characters in &lt;code&gt;opt&lt;/code&gt;.<a name="line.140"></a>
 <span class="sourceLineNo">141</span>     */<a name="line.141"></a>
-<span class="sourceLineNo">142</span>    public Option(String opt, String longOpt, boolean hasArg, String description)<a name="line.142"></a>
+<span class="sourceLineNo">142</span>    public Option(final String opt, final String longOpt, final boolean hasArg, final String description)<a name="line.142"></a>
 <span class="sourceLineNo">143</span>           throws IllegalArgumentException<a name="line.143"></a>
 <span class="sourceLineNo">144</span>    {<a name="line.144"></a>
 <span class="sourceLineNo">145</span>        // ensure that the option is valid<a name="line.145"></a>
@@ -223,7 +223,7 @@
 <span class="sourceLineNo">215</span>     * @deprecated since 1.3, use {@link #setType(Class)} instead<a name="line.215"></a>
 <span class="sourceLineNo">216</span>     */<a name="line.216"></a>
 <span class="sourceLineNo">217</span>    @Deprecated<a name="line.217"></a>
-<span class="sourceLineNo">218</span>    public void setType(Object type)<a name="line.218"></a>
+<span class="sourceLineNo">218</span>    public void setType(final Object type)<a name="line.218"></a>
 <span class="sourceLineNo">219</span>    {<a name="line.219"></a>
 <span class="sourceLineNo">220</span>        setType((Class&lt;?&gt;) type);<a name="line.220"></a>
 <span class="sourceLineNo">221</span>    }<a name="line.221"></a>
@@ -234,7 +234,7 @@
 <span class="sourceLineNo">226</span>     * @param type the type of this Option<a name="line.226"></a>
 <span class="sourceLineNo">227</span>     * @since 1.3<a name="line.227"></a>
 <span class="sourceLineNo">228</span>     */<a name="line.228"></a>
-<span class="sourceLineNo">229</span>    public void setType(Class&lt;?&gt; type)<a name="line.229"></a>
+<span class="sourceLineNo">229</span>    public void setType(final Class&lt;?&gt; type)<a name="line.229"></a>
 <span class="sourceLineNo">230</span>    {<a name="line.230"></a>
 <span class="sourceLineNo">231</span>        this.type = type;<a name="line.231"></a>
 <span class="sourceLineNo">232</span>    }<a name="line.232"></a>
@@ -254,7 +254,7 @@
 <span class="sourceLineNo">246</span>     *<a name="line.246"></a>
 <span class="sourceLineNo">247</span>     * @param longOpt the long name of this Option<a name="line.247"></a>
 <span class="sourceLineNo">248</span>     */<a name="line.248"></a>
-<span class="sourceLineNo">249</span>    public void setLongOpt(String longOpt)<a name="line.249"></a>
+<span class="sourceLineNo">249</span>    public void setLongOpt(final String longOpt)<a name="line.249"></a>
 <span class="sourceLineNo">250</span>    {<a name="line.250"></a>
 <span class="sourceLineNo">251</span>        this.longOpt = longOpt;<a name="line.251"></a>
 <span class="sourceLineNo">252</span>    }<a name="line.252"></a>
@@ -265,7 +265,7 @@
 <span class="sourceLineNo">257</span>     * @param optionalArg specifies whether the Option can have<a name="line.257"></a>
 <span class="sourceLineNo">258</span>     * an optional argument.<a name="line.258"></a>
 <span class="sourceLineNo">259</span>     */<a name="line.259"></a>
-<span class="sourceLineNo">260</span>    public void setOptionalArg(boolean optionalArg)<a name="line.260"></a>
+<span class="sourceLineNo">260</span>    public void setOptionalArg(final boolean optionalArg)<a name="line.260"></a>
 <span class="sourceLineNo">261</span>    {<a name="line.261"></a>
 <span class="sourceLineNo">262</span>        this.optionalArg = optionalArg;<a name="line.262"></a>
 <span class="sourceLineNo">263</span>    }<a name="line.263"></a>
@@ -314,7 +314,7 @@
 <span class="sourceLineNo">306</span>     * @param description The description of this option<a name="line.306"></a>
 <span class="sourceLineNo">307</span>     * @since 1.1<a name="line.307"></a>
 <span class="sourceLineNo">308</span>     */<a name="line.308"></a>
-<span class="sourceLineNo">309</span>    public void setDescription(String description)<a name="line.309"></a>
+<span class="sourceLineNo">309</span>    public void setDescription(final String description)<a name="line.309"></a>
 <span class="sourceLineNo">310</span>    {<a name="line.310"></a>
 <span class="sourceLineNo">311</span>        this.description = description;<a name="line.311"></a>
 <span class="sourceLineNo">312</span>    }<a name="line.312"></a>
@@ -334,7 +334,7 @@
 <span class="sourceLineNo">326</span>     *<a name="line.326"></a>
 <span class="sourceLineNo">327</span>     * @param required specifies whether this Option is mandatory<a name="line.327"></a>
 <span class="sourceLineNo">328</span>     */<a name="line.328"></a>
-<span class="sourceLineNo">329</span>    public void setRequired(boolean required)<a name="line.329"></a>
+<span class="sourceLineNo">329</span>    public void setRequired(final boolean required)<a name="line.329"></a>
 <span class="sourceLineNo">330</span>    {<a name="line.330"></a>
 <span class="sourceLineNo">331</span>        this.required = required;<a name="line.331"></a>
 <span class="sourceLineNo">332</span>    }<a name="line.332"></a>
@@ -344,7 +344,7 @@
 <span class="sourceLineNo">336</span>     *<a name="line.336"></a>
 <span class="sourceLineNo">337</span>     * @param argName the display name for the argument value.<a name="line.337"></a>
 <span class="sourceLineNo">338</span>     */<a name="line.338"></a>
-<span class="sourceLineNo">339</span>    public void setArgName(String argName)<a name="line.339"></a>
+<span class="sourceLineNo">339</span>    public void setArgName(final String argName)<a name="line.339"></a>
 <span class="sourceLineNo">340</span>    {<a name="line.340"></a>
 <span class="sourceLineNo">341</span>        this.argName = argName;<a name="line.341"></a>
 <span class="sourceLineNo">342</span>    }<a name="line.342"></a>
@@ -384,7 +384,7 @@
 <span class="sourceLineNo">376</span>     *<a name="line.376"></a>
 <span class="sourceLineNo">377</span>     * @param num the number of argument values<a name="line.377"></a>
 <span class="sourceLineNo">378</span>     */<a name="line.378"></a>
-<span class="sourceLineNo">379</span>    public void setArgs(int num)<a name="line.379"></a>
+<span class="sourceLineNo">379</span>    public void setArgs(final int num)<a name="line.379"></a>
 <span class="sourceLineNo">380</span>    {<a name="line.380"></a>
 <span class="sourceLineNo">381</span>        this.numberOfArgs = num;<a name="line.381"></a>
 <span class="sourceLineNo">382</span>    }<a name="line.382"></a>
@@ -395,7 +395,7 @@
 <span class="sourceLineNo">387</span>     *<a name="line.387"></a>
 <span class="sourceLineNo">388</span>     * @param sep The value separator.<a name="line.388"></a>
 <span class="sourceLineNo">389</span>     */<a name="line.389"></a>
-<span class="sourceLineNo">390</span>    public void setValueSeparator(char sep)<a name="line.390"></a>
+<span class="sourceLineNo">390</span>    public void setValueSeparator(final char sep)<a name="line.390"></a>
 <span class="sourceLineNo">391</span>    {<a name="line.391"></a>
 <span class="sourceLineNo">392</span>        this.valuesep = sep;<a name="line.392"></a>
 <span class="sourceLineNo">393</span>    }<a name="line.393"></a>
@@ -445,7 +445,7 @@
 <span class="sourceLineNo">437</span>     * <a name="line.437"></a>
 <span class="sourceLineNo">438</span>     * @param value is a/the value of this Option<a name="line.438"></a>
 <span class="sourceLineNo">439</span>     */<a name="line.439"></a>
-<span class="sourceLineNo">440</span>    void addValueForProcessing(String value)<a name="line.440"></a>
+<span class="sourceLineNo">440</span>    void addValueForProcessing(final String value)<a name="line.440"></a>
 <span class="sourceLineNo">441</span>    {<a name="line.441"></a>
 <span class="sourceLineNo">442</span>        if (numberOfArgs == UNINITIALIZED)<a name="line.442"></a>
 <span class="sourceLineNo">443</span>        {<a name="line.443"></a>
@@ -471,7 +471,7 @@
 <span class="sourceLineNo">463</span>        if (hasValueSeparator())<a name="line.463"></a>
 <span class="sourceLineNo">464</span>        {<a name="line.464"></a>
 <span class="sourceLineNo">465</span>            // get the separator character<a name="line.465"></a>
-<span class="sourceLineNo">466</span>            char sep = getValueSeparator();<a name="line.466"></a>
+<span class="sourceLineNo">466</span>            final char sep = getValueSeparator();<a name="line.466"></a>
 <span class="sourceLineNo">467</span><a name="line.467"></a>
 <span class="sourceLineNo">468</span>            // store the index for the value separator<a name="line.468"></a>
 <span class="sourceLineNo">469</span>            int index = value.indexOf(sep);<a name="line.469"></a>
@@ -509,7 +509,7 @@
 <span class="sourceLineNo">501</span>     *<a name="line.501"></a>
 <span class="sourceLineNo">502</span>     * @since 1.0.1<a name="line.502"></a>
 <span class="sourceLineNo">503</span>     */<a name="line.503"></a>
-<span class="sourceLineNo">504</span>    private void add(String value)<a name="line.504"></a>
+<span class="sourceLineNo">504</span>    private void add(final String value)<a name="line.504"></a>
 <span class="sourceLineNo">505</span>    {<a name="line.505"></a>
 <span class="sourceLineNo">506</span>        if (!acceptsArg())<a name="line.506"></a>
 <span class="sourceLineNo">507</span>        {<a name="line.507"></a>
@@ -544,7 +544,7 @@
 <span class="sourceLineNo">536</span>     * @throws IndexOutOfBoundsException if index is less than 1<a name="line.536"></a>
 <span class="sourceLineNo">537</span>     * or greater than the number of the values for this Option.<a name="line.537"></a>
 <span class="sourceLineNo">538</span>     */<a name="line.538"></a>
-<span class="sourceLineNo">539</span>    public String getValue(int index) throws IndexOutOfBoundsException<a name="line.539"></a>
+<span class="sourceLineNo">539</span>    public String getValue(final int index) throws IndexOutOfBoundsException<a name="line.539"></a>
 <span class="sourceLineNo">540</span>    {<a name="line.540"></a>
 <span class="sourceLineNo">541</span>        return hasNoValues() ? null : values.get(index);<a name="line.541"></a>
 <span class="sourceLineNo">542</span>    }<a name="line.542"></a>
@@ -559,9 +559,9 @@
 <span class="sourceLineNo">551</span>     * @return the value/first value of this Option or the <a name="line.551"></a>
 <span class="sourceLineNo">552</span>     * &lt;code&gt;defaultValue&lt;/code&gt; if there are no values.<a name="line.552"></a>
 <span class="sourceLineNo">553</span>     */<a name="line.553"></a>
-<span class="sourceLineNo">554</span>    public String getValue(String defaultValue)<a name="line.554"></a>
+<span class="sourceLineNo">554</span>    public String getValue(final String defaultValue)<a name="line.554"></a>
 <span class="sourceLineNo">555</span>    {<a name="line.555"></a>
-<span class="sourceLineNo">556</span>        String value = getValue();<a name="line.556"></a>
+<span class="sourceLineNo">556</span>        final String value = getValue();<a name="line.556"></a>
 <span class="sourceLineNo">557</span><a name="line.557"></a>
 <span class="sourceLineNo">558</span>        return (value != null) ? value : defaultValue;<a name="line.558"></a>
 <span class="sourceLineNo">559</span>    }<a name="line.559"></a>
@@ -595,7 +595,7 @@
 <span class="sourceLineNo">587</span>    @Override<a name="line.587"></a>
 <span class="sourceLineNo">588</span>    public String toString()<a name="line.588"></a>
 <span class="sourceLineNo">589</span>    {<a name="line.589"></a>
-<span class="sourceLineNo">590</span>        StringBuilder buf = new StringBuilder().append("[ option: ");<a name="line.590"></a>
+<span class="sourceLineNo">590</span>        final StringBuilder buf = new StringBuilder().append("[ option: ");<a name="line.590"></a>
 <span class="sourceLineNo">591</span><a name="line.591"></a>
 <span class="sourceLineNo">592</span>        buf.append(opt);<a name="line.592"></a>
 <span class="sourceLineNo">593</span><a name="line.593"></a>
@@ -638,7 +638,7 @@
 <span class="sourceLineNo">630</span>    }<a name="line.630"></a>
 <span class="sourceLineNo">631</span><a name="line.631"></a>
 <span class="sourceLineNo">632</span>    @Override<a name="line.632"></a>
-<span class="sourceLineNo">633</span>    public boolean equals(Object o)<a name="line.633"></a>
+<span class="sourceLineNo">633</span>    public boolean equals(final Object o)<a name="line.633"></a>
 <span class="sourceLineNo">634</span>    {<a name="line.634"></a>
 <span class="sourceLineNo">635</span>        if (this == o)<a name="line.635"></a>
 <span class="sourceLineNo">636</span>        {<a name="line.636"></a>
@@ -649,378 +649,377 @@
 <span class="sourceLineNo">641</span>            return false;<a name="line.641"></a>
 <span class="sourceLineNo">642</span>        }<a name="line.642"></a>
 <span class="sourceLineNo">643</span><a name="line.643"></a>
-<span class="sourceLineNo">644</span>        Option option = (Option) o;<a name="line.644"></a>
+<span class="sourceLineNo">644</span>        final Option option = (Option) o;<a name="line.644"></a>
 <span class="sourceLineNo">645</span><a name="line.645"></a>
-<span class="sourceLineNo">646</span><a name="line.646"></a>
-<span class="sourceLineNo">647</span>        if (opt != null ? !opt.equals(option.opt) : option.opt != null)<a name="line.647"></a>
-<span class="sourceLineNo">648</span>        {<a name="line.648"></a>
-<span class="sourceLineNo">649</span>            return false;<a name="line.649"></a>
-<span class="sourceLineNo">650</span>        }<a name="line.650"></a>
-<span class="sourceLineNo">651</span>        if (longOpt != null ? !longOpt.equals(option.longOpt) : option.longOpt != null)<a name="line.651"></a>
-<span class="sourceLineNo">652</span>        {<a name="line.652"></a>
-<span class="sourceLineNo">653</span>            return false;<a name="line.653"></a>
-<span class="sourceLineNo">654</span>        }<a name="line.654"></a>
-<span class="sourceLineNo">655</span><a name="line.655"></a>
-<span class="sourceLineNo">656</span>        return true;<a name="line.656"></a>
-<span class="sourceLineNo">657</span>    }<a name="line.657"></a>
-<span class="sourceLineNo">658</span><a name="line.658"></a>
-<span class="sourceLineNo">659</span>    @Override<a name="line.659"></a>
-<span class="sourceLineNo">660</span>    public int hashCode()<a name="line.660"></a>
-<span class="sourceLineNo">661</span>    {<a name="line.661"></a>
-<span class="sourceLineNo">662</span>        int result;<a name="line.662"></a>
-<span class="sourceLineNo">663</span>        result = opt != null ? opt.hashCode() : 0;<a name="line.663"></a>
-<span class="sourceLineNo">664</span>        result = 31 * result + (longOpt != null ? longOpt.hashCode() : 0);<a name="line.664"></a>
-<span class="sourceLineNo">665</span>        return result;<a name="line.665"></a>
-<span class="sourceLineNo">666</span>    }<a name="line.666"></a>
-<span class="sourceLineNo">667</span><a name="line.667"></a>
-<span class="sourceLineNo">668</span>    /**<a name="line.668"></a>
-<span class="sourceLineNo">669</span>     * A rather odd clone method - due to incorrect code in 1.0 it is public <a name="line.669"></a>
-<span class="sourceLineNo">670</span>     * and in 1.1 rather than throwing a CloneNotSupportedException it throws <a name="line.670"></a>
-<span class="sourceLineNo">671</span>     * a RuntimeException so as to maintain backwards compat at the API level. <a name="line.671"></a>
-<span class="sourceLineNo">672</span>     *<a name="line.672"></a>
-<span class="sourceLineNo">673</span>     * After calling this method, it is very likely you will want to call <a name="line.673"></a>
-<span class="sourceLineNo">674</span>     * clearValues(). <a name="line.674"></a>
-<span class="sourceLineNo">675</span>     *<a name="line.675"></a>
-<span class="sourceLineNo">676</span>     * @return a clone of this Option instance<a name="line.676"></a>
-<span class="sourceLineNo">677</span>     * @throws RuntimeException if a {@link CloneNotSupportedException} has been thrown<a name="line.677"></a>
-<span class="sourceLineNo">678</span>     * by {@code super.clone()}<a name="line.678"></a>
-<span class="sourceLineNo">679</span>     */<a name="line.679"></a>
-<span class="sourceLineNo">680</span>    @Override<a name="line.680"></a>
-<span class="sourceLineNo">681</span>    public Object clone()<a name="line.681"></a>
-<span class="sourceLineNo">682</span>    {<a name="line.682"></a>
-<span class="sourceLineNo">683</span>        try<a name="line.683"></a>
-<span class="sourceLineNo">684</span>        {<a name="line.684"></a>
-<span class="sourceLineNo">685</span>            Option option = (Option) super.clone();<a name="line.685"></a>
-<span class="sourceLineNo">686</span>            option.values = new ArrayList&lt;String&gt;(values);<a name="line.686"></a>
-<span class="sourceLineNo">687</span>            return option;<a name="line.687"></a>
-<span class="sourceLineNo">688</span>        }<a name="line.688"></a>
-<span class="sourceLineNo">689</span>        catch (CloneNotSupportedException cnse)<a name="line.689"></a>
-<span class="sourceLineNo">690</span>        {<a name="line.690"></a>
-<span class="sourceLineNo">691</span>            throw new RuntimeException("A CloneNotSupportedException was thrown: " + cnse.getMessage());<a name="line.691"></a>
-<span class="sourceLineNo">692</span>        }<a name="line.692"></a>
-<span class="sourceLineNo">693</span>    }<a name="line.693"></a>
-<span class="sourceLineNo">694</span><a name="line.694"></a>
-<span class="sourceLineNo">695</span>    /**<a name="line.695"></a>
-<span class="sourceLineNo">696</span>     * Clear the Option values. After a parse is complete, these are left with<a name="line.696"></a>
-<span class="sourceLineNo">697</span>     * data in them and they need clearing if another parse is done.<a name="line.697"></a>
-<span class="sourceLineNo">698</span>     *<a name="line.698"></a>
-<span class="sourceLineNo">699</span>     * See: &lt;a href="https://issues.apache.org/jira/browse/CLI-71"&gt;CLI-71&lt;/a&gt;<a name="line.699"></a>
-<span class="sourceLineNo">700</span>     */<a name="line.700"></a>
-<span class="sourceLineNo">701</span>    void clearValues()<a name="line.701"></a>
-<span class="sourceLineNo">702</span>    {<a name="line.702"></a>
-<span class="sourceLineNo">703</span>        values.clear();<a name="line.703"></a>
-<span class="sourceLineNo">704</span>    }<a name="line.704"></a>
-<span class="sourceLineNo">705</span><a name="line.705"></a>
-<span class="sourceLineNo">706</span>    /**<a name="line.706"></a>
-<span class="sourceLineNo">707</span>     * This method is not intended to be used. It was a piece of internal <a name="line.707"></a>
-<span class="sourceLineNo">708</span>     * API that was made public in 1.0. It currently throws an UnsupportedOperationException.<a name="line.708"></a>
-<span class="sourceLineNo">709</span>     *<a name="line.709"></a>
-<span class="sourceLineNo">710</span>     * @param value the value to add<a name="line.710"></a>
-<span class="sourceLineNo">711</span>     * @return always throws an {@link UnsupportedOperationException}<a name="line.711"></a>
-<span class="sourceLineNo">712</span>     * @throws UnsupportedOperationException always<a name="line.712"></a>
-<span class="sourceLineNo">713</span>     * @deprecated<a name="line.713"></a>
-<span class="sourceLineNo">714</span>     */<a name="line.714"></a>
-<span class="sourceLineNo">715</span>    @Deprecated<a name="line.715"></a>
-<span class="sourceLineNo">716</span>    public boolean addValue(String value)<a name="line.716"></a>
-<span class="sourceLineNo">717</span>    {<a name="line.717"></a>
-<span class="sourceLineNo">718</span>        throw new UnsupportedOperationException("The addValue method is not intended for client use. "<a name="line.718"></a>
-<span class="sourceLineNo">719</span>                + "Subclasses should use the addValueForProcessing method instead. ");<a name="line.719"></a>
-<span class="sourceLineNo">720</span>    }<a name="line.720"></a>
-<span class="sourceLineNo">721</span><a name="line.721"></a>
-<span class="sourceLineNo">722</span>    /**<a name="line.722"></a>
-<span class="sourceLineNo">723</span>     * Tells if the option can accept more arguments.<a name="line.723"></a>
-<span class="sourceLineNo">724</span>     * <a name="line.724"></a>
-<span class="sourceLineNo">725</span>     * @return false if the maximum number of arguments is reached<a name="line.725"></a>
-<span class="sourceLineNo">726</span>     * @since 1.3<a name="line.726"></a>
-<span class="sourceLineNo">727</span>     */<a name="line.727"></a>
-<span class="sourceLineNo">728</span>    boolean acceptsArg()<a name="line.728"></a>
-<span class="sourceLineNo">729</span>    {<a name="line.729"></a>
-<span class="sourceLineNo">730</span>        return (hasArg() || hasArgs() || hasOptionalArg()) &amp;&amp; (numberOfArgs &lt;= 0 || values.size() &lt; numberOfArgs);<a name="line.730"></a>
-<span class="sourceLineNo">731</span>    }<a name="line.731"></a>
-<span class="sourceLineNo">732</span><a name="line.732"></a>
-<span class="sourceLineNo">733</span>    /**<a name="line.733"></a>
-<span class="sourceLineNo">734</span>     * Tells if the option requires more arguments to be valid.<a name="line.734"></a>
-<span class="sourceLineNo">735</span>     * <a name="line.735"></a>
-<span class="sourceLineNo">736</span>     * @return false if the option doesn't require more arguments<a name="line.736"></a>
-<span class="sourceLineNo">737</span>     * @since 1.3<a name="line.737"></a>
-<span class="sourceLineNo">738</span>     */<a name="line.738"></a>
-<span class="sourceLineNo">739</span>    boolean requiresArg()<a name="line.739"></a>
-<span class="sourceLineNo">740</span>    {<a name="line.740"></a>
-<span class="sourceLineNo">741</span>        if (optionalArg)<a name="line.741"></a>
-<span class="sourceLineNo">742</span>        {<a name="line.742"></a>
-<span class="sourceLineNo">743</span>            return false;<a name="line.743"></a>
-<span class="sourceLineNo">744</span>        }<a name="line.744"></a>
-<span class="sourceLineNo">745</span>        if (numberOfArgs == UNLIMITED_VALUES)<a name="line.745"></a>
-<span class="sourceLineNo">746</span>        {<a name="line.746"></a>
-<span class="sourceLineNo">747</span>            return values.isEmpty();<a name="line.747"></a>
-<span class="sourceLineNo">748</span>        }<a name="line.748"></a>
-<span class="sourceLineNo">749</span>        return acceptsArg();<a name="line.749"></a>
-<span class="sourceLineNo">750</span>    }<a name="line.750"></a>
-<span class="sourceLineNo">751</span>    <a name="line.751"></a>
-<span class="sourceLineNo">752</span>    /**<a name="line.752"></a>
-<span class="sourceLineNo">753</span>     * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.753"></a>
-<span class="sourceLineNo">754</span>     * methods.  <a name="line.754"></a>
-<span class="sourceLineNo">755</span>     * <a name="line.755"></a>
-<span class="sourceLineNo">756</span>     * @return a new {@link Builder} instance<a name="line.756"></a>
-<span class="sourceLineNo">757</span>     * @since 1.3<a name="line.757"></a>
-<span class="sourceLineNo">758</span>     */<a name="line.758"></a>
-<span class="sourceLineNo">759</span>    public static Builder builder()<a name="line.759"></a>
-<span class="sourceLineNo">760</span>    {<a name="line.760"></a>
-<span class="sourceLineNo">761</span>        return builder(null);<a name="line.761"></a>
-<span class="sourceLineNo">762</span>    }<a name="line.762"></a>
-<span class="sourceLineNo">763</span>    <a name="line.763"></a>
-<span class="sourceLineNo">764</span>    /**<a name="line.764"></a>
-<span class="sourceLineNo">765</span>     * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.765"></a>
-<span class="sourceLineNo">766</span>     * methods.  <a name="line.766"></a>
-<span class="sourceLineNo">767</span>     *<a name="line.767"></a>
-<span class="sourceLineNo">768</span>     * @param opt short representation of the option<a name="line.768"></a>
-<span class="sourceLineNo">769</span>     * @return a new {@link Builder} instance<a name="line.769"></a>
-<span class="sourceLineNo">770</span>     * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.770"></a>
-<span class="sourceLineNo">771</span>     * @since 1.3<a name="line.771"></a>
-<span class="sourceLineNo">772</span>     */<a name="line.772"></a>
-<span class="sourceLineNo">773</span>    public static Builder builder(final String opt)<a name="line.773"></a>
-<span class="sourceLineNo">774</span>    {<a name="line.774"></a>
-<span class="sourceLineNo">775</span>        return new Builder(opt);<a name="line.775"></a>
-<span class="sourceLineNo">776</span>    }<a name="line.776"></a>
-<span class="sourceLineNo">777</span>    <a name="line.777"></a>
-<span class="sourceLineNo">778</span>    /**<a name="line.778"></a>
-<span class="sourceLineNo">779</span>     * A nested builder class to create &lt;code&gt;Option&lt;/code&gt; instances<a name="line.779"></a>
-<span class="sourceLineNo">780</span>     * using descriptive methods.<a name="line.780"></a>
-<span class="sourceLineNo">781</span>     * &lt;p&gt;<a name="line.781"></a>
-<span class="sourceLineNo">782</span>     * Example usage:<a name="line.782"></a>
-<span class="sourceLineNo">783</span>     * &lt;pre&gt;<a name="line.783"></a>
-<span class="sourceLineNo">784</span>     * Option option = Option.builder("a")<a name="line.784"></a>
-<span class="sourceLineNo">785</span>     *     .required(true)<a name="line.785"></a>
-<span class="sourceLineNo">786</span>     *     .longOpt("arg-name")<a name="line.786"></a>
-<span class="sourceLineNo">787</span>     *     .build();<a name="line.787"></a>
-<span class="sourceLineNo">788</span>     * &lt;/pre&gt;<a name="line.788"></a>
-<span class="sourceLineNo">789</span>     * <a name="line.789"></a>
-<span class="sourceLineNo">790</span>     * @since 1.3<a name="line.790"></a>
-<span class="sourceLineNo">791</span>     */<a name="line.791"></a>
-<span class="sourceLineNo">792</span>    public static final class Builder <a name="line.792"></a>
-<span class="sourceLineNo">793</span>    {<a name="line.793"></a>
-<span class="sourceLineNo">794</span>        /** the name of the option */<a name="line.794"></a>
-<span class="sourceLineNo">795</span>        private final String opt;<a name="line.795"></a>
-<span class="sourceLineNo">796</span><a name="line.796"></a>
-<span class="sourceLineNo">797</span>        /** description of the option */<a name="line.797"></a>
-<span class="sourceLineNo">798</span>        private String description;<a name="line.798"></a>
-<span class="sourceLineNo">799</span><a name="line.799"></a>
-<span class="sourceLineNo">800</span>        /** the long representation of the option */<a name="line.800"></a>
-<span class="sourceLineNo">801</span>        private String longOpt;<a name="line.801"></a>
-<span class="sourceLineNo">802</span><a name="line.802"></a>
-<span class="sourceLineNo">803</span>        /** the name of the argument for this option */<a name="line.803"></a>
-<span class="sourceLineNo">804</span>        private String argName;<a name="line.804"></a>
-<span class="sourceLineNo">805</span><a name="line.805"></a>
-<span class="sourceLineNo">806</span>        /** specifies whether this option is required to be present */<a name="line.806"></a>
-<span class="sourceLineNo">807</span>        private boolean required;<a name="line.807"></a>
-<span class="sourceLineNo">808</span><a name="line.808"></a>
-<span class="sourceLineNo">809</span>        /** specifies whether the argument value of this Option is optional */<a name="line.809"></a>
-<span class="sourceLineNo">810</span>        private boolean optionalArg;<a name="line.810"></a>
-<span class="sourceLineNo">811</span><a name="line.811"></a>
-<span class="sourceLineNo">812</span>        /** the number of argument values this option can have */<a name="line.812"></a>
-<span class="sourceLineNo">813</span>        private int numberOfArgs = UNINITIALIZED;<a name="line.813"></a>
-<span class="sourceLineNo">814</span><a name="line.814"></a>
-<span class="sourceLineNo">815</span>        /** the type of this Option */<a name="line.815"></a>
-<span class="sourceLineNo">816</span>        private Class&lt;?&gt; type = String.class;<a name="line.816"></a>
-<span class="sourceLineNo">817</span><a name="line.817"></a>
-<span class="sourceLineNo">818</span>        /** the character that is the value separator */<a name="line.818"></a>
-<span class="sourceLineNo">819</span>        private char valuesep;<a name="line.819"></a>
-<span class="sourceLineNo">820</span><a name="line.820"></a>
-<span class="sourceLineNo">821</span>        /**<a name="line.821"></a>
-<span class="sourceLineNo">822</span>         * Constructs a new &lt;code&gt;Builder&lt;/code&gt; with the minimum<a name="line.822"></a>
-<span class="sourceLineNo">823</span>         * required parameters for an &lt;code&gt;Option&lt;/code&gt; instance.<a name="line.823"></a>
-<span class="sourceLineNo">824</span>         * <a name="line.824"></a>
-<span class="sourceLineNo">825</span>         * @param opt short representation of the option<a name="line.825"></a>
-<span class="sourceLineNo">826</span>         * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.826"></a>
-<span class="sourceLineNo">827</span>         */<a name="line.827"></a>
-<span class="sourceLineNo">828</span>        private Builder(final String opt) throws IllegalArgumentException<a name="line.828"></a>
-<span class="sourceLineNo">829</span>        {<a name="line.829"></a>
-<span class="sourceLineNo">830</span>            OptionValidator.validateOption(opt);<a name="line.830"></a>
-<span class="sourceLineNo">831</span>            this.opt = opt;<a name="line.831"></a>
-<span class="sourceLineNo">832</span>        }<a name="line.832"></a>
-<span class="sourceLineNo">833</span>        <a name="line.833"></a>
-<span class="sourceLineNo">834</span>        /**<a name="line.834"></a>
-<span class="sourceLineNo">835</span>         * Sets the display name for the argument value.<a name="line.835"></a>
-<span class="sourceLineNo">836</span>         *<a name="line.836"></a>
-<span class="sourceLineNo">837</span>         * @param argName the display name for the argument value.<a name="line.837"></a>
-<span class="sourceLineNo">838</span>         * @return this builder, to allow method chaining<a name="line.838"></a>
-<span class="sourceLineNo">839</span>         */<a name="line.839"></a>
-<span class="sourceLineNo">840</span>        public Builder argName(final String argName)<a name="line.840"></a>
-<span class="sourceLineNo">841</span>        {<a name="line.841"></a>
-<span class="sourceLineNo">842</span>            this.argName = argName;<a name="line.842"></a>
-<span class="sourceLineNo">843</span>            return this;<a name="line.843"></a>
-<span class="sourceLineNo">844</span>        }<a name="line.844"></a>
-<span class="sourceLineNo">845</span><a name="line.845"></a>
-<span class="sourceLineNo">846</span>        /**<a name="line.846"></a>
-<span class="sourceLineNo">847</span>         * Sets the description for this option.<a name="line.847"></a>
-<span class="sourceLineNo">848</span>         *<a name="line.848"></a>
-<span class="sourceLineNo">849</span>         * @param description the description of the option.<a name="line.849"></a>
-<span class="sourceLineNo">850</span>         * @return this builder, to allow method chaining<a name="line.850"></a>
-<span class="sourceLineNo">851</span>         */<a name="line.851"></a>
-<span class="sourceLineNo">852</span>        public Builder desc(final String description)<a name="line.852"></a>
-<span class="sourceLineNo">853</span>        {<a name="line.853"></a>
-<span class="sourceLineNo">854</span>            this.description = description;<a name="line.854"></a>
-<span class="sourceLineNo">855</span>            return this;<a name="line.855"></a>
-<span class="sourceLineNo">856</span>        }<a name="line.856"></a>
-<span class="sourceLineNo">857</span><a name="line.857"></a>
-<span class="sourceLineNo">858</span>        /**<a name="line.858"></a>
-<span class="sourceLineNo">859</span>         * Sets the long name of the Option.<a name="line.859"></a>
-<span class="sourceLineNo">860</span>         *<a name="line.860"></a>
-<span class="sourceLineNo">861</span>         * @param longOpt the long name of the Option<a name="line.861"></a>
-<span class="sourceLineNo">862</span>         * @return this builder, to allow method chaining<a name="line.862"></a>
-<span class="sourceLineNo">863</span>         */        <a name="line.863"></a>
-<span class="sourceLineNo">864</span>        public Builder longOpt(final String longOpt)<a name="line.864"></a>
-<span class="sourceLineNo">865</span>        {<a name="line.865"></a>
-<span class="sourceLineNo">866</span>            this.longOpt = longOpt;<a name="line.866"></a>
-<span class="sourceLineNo">867</span>            return this;<a name="line.867"></a>
-<span class="sourceLineNo">868</span>        }<a name="line.868"></a>
-<span class="sourceLineNo">869</span>        <a name="line.869"></a>
-<span class="sourceLineNo">870</span>        /** <a name="line.870"></a>
-<span class="sourceLineNo">871</span>         * Sets the number of argument values the Option can take.<a name="line.871"></a>
-<span class="sourceLineNo">872</span>         *<a name="line.872"></a>
-<span class="sourceLineNo">873</span>         * @param numberOfArgs the number of argument values<a name="line.873"></a>
-<span class="sourceLineNo">874</span>         * @return this builder, to allow method chaining<a name="line.874"></a>
-<span class="sourceLineNo">875</span>         */        <a name="line.875"></a>
-<span class="sourceLineNo">876</span>        public Builder numberOfArgs(final int numberOfArgs)<a name="line.876"></a>
-<span class="sourceLineNo">877</span>        {<a name="line.877"></a>
-<span class="sourceLineNo">878</span>            this.numberOfArgs = numberOfArgs;<a name="line.878"></a>
-<span class="sourceLineNo">879</span>            return this;<a name="line.879"></a>
-<span class="sourceLineNo">880</span>        }<a name="line.880"></a>
-<span class="sourceLineNo">881</span>        <a name="line.881"></a>
-<span class="sourceLineNo">882</span>        /**<a name="line.882"></a>
-<span class="sourceLineNo">883</span>         * Sets whether the Option can have an optional argument.<a name="line.883"></a>
-<span class="sourceLineNo">884</span>         *<a name="line.884"></a>
-<span class="sourceLineNo">885</span>         * @param isOptional specifies whether the Option can have<a name="line.885"></a>
-<span class="sourceLineNo">886</span>         * an optional argument.<a name="line.886"></a>
-<span class="sourceLineNo">887</span>         * @return this builder, to allow method chaining<a name="line.887"></a>
-<span class="sourceLineNo">888</span>         */<a name="line.888"></a>
-<span class="sourceLineNo">889</span>        public Builder optionalArg(final boolean isOptional)<a name="line.889"></a>
-<span class="sourceLineNo">890</span>        {<a name="line.890"></a>
-<span class="sourceLineNo">891</span>            this.optionalArg = isOptional;<a name="line.891"></a>
-<span class="sourceLineNo">892</span>            return this;<a name="line.892"></a>
-<span class="sourceLineNo">893</span>        }<a name="line.893"></a>
-<span class="sourceLineNo">894</span>        <a name="line.894"></a>
-<span class="sourceLineNo">895</span>        /**<a name="line.895"></a>
-<span class="sourceLineNo">896</span>         * Marks this Option as required.<a name="line.896"></a>
-<span class="sourceLineNo">897</span>         *<a name="line.897"></a>
-<span class="sourceLineNo">898</span>         * @return this builder, to allow method chaining<a name="line.898"></a>
-<span class="sourceLineNo">899</span>         */<a name="line.899"></a>
-<span class="sourceLineNo">900</span>        public Builder required()<a name="line.900"></a>
-<span class="sourceLineNo">901</span>        {<a name="line.901"></a>
-<span class="sourceLineNo">902</span>            return required(true);<a name="line.902"></a>
-<span class="sourceLineNo">903</span>        }<a name="line.903"></a>
-<span class="sourceLineNo">904</span><a name="line.904"></a>
-<span class="sourceLineNo">905</span>        /**<a name="line.905"></a>
-<span class="sourceLineNo">906</span>         * Sets whether the Option is mandatory.<a name="line.906"></a>
-<span class="sourceLineNo">907</span>         *<a name="line.907"></a>
-<span class="sourceLineNo">908</span>         * @param required specifies whether the Option is mandatory<a name="line.908"></a>
-<span class="sourceLineNo">909</span>         * @return this builder, to allow method chaining<a name="line.909"></a>
-<span class="sourceLineNo">910</span>         */<a name="line.910"></a>
-<span class="sourceLineNo">911</span>        public Builder required(final boolean required)<a name="line.911"></a>
-<span class="sourceLineNo">912</span>        {<a name="line.912"></a>
-<span class="sourceLineNo">913</span>            this.required = required;<a name="line.913"></a>
-<span class="sourceLineNo">914</span>            return this;<a name="line.914"></a>
-<span class="sourceLineNo">915</span>        }<a name="line.915"></a>
-<span class="sourceLineNo">916</span>        <a name="line.916"></a>
-<span class="sourceLineNo">917</span>        /**<a name="line.917"></a>
-<span class="sourceLineNo">918</span>         * Sets the type of the Option.<a name="line.918"></a>
-<span class="sourceLineNo">919</span>         *<a name="line.919"></a>
-<span class="sourceLineNo">920</span>         * @param type the type of the Option<a name="line.920"></a>
-<span class="sourceLineNo">921</span>         * @return this builder, to allow method chaining<a name="line.921"></a>
-<span class="sourceLineNo">922</span>         */<a name="line.922"></a>
-<span class="sourceLineNo">923</span>        public Builder type(final Class&lt;?&gt; type)<a name="line.923"></a>
-<span class="sourceLineNo">924</span>        {<a name="line.924"></a>
-<span class="sourceLineNo">925</span>            this.type = type;<a name="line.925"></a>
-<span class="sourceLineNo">926</span>            return this;<a name="line.926"></a>
-<span class="sourceLineNo">927</span>        }<a name="line.927"></a>
-<span class="sourceLineNo">928</span><a name="line.928"></a>
-<span class="sourceLineNo">929</span>        /**<a name="line.929"></a>
-<span class="sourceLineNo">930</span>         * The Option will use '=' as a means to separate argument value.<a name="line.930"></a>
-<span class="sourceLineNo">931</span>         *<a name="line.931"></a>
-<span class="sourceLineNo">932</span>         * @return this builder, to allow method chaining<a name="line.932"></a>
-<span class="sourceLineNo">933</span>         */<a name="line.933"></a>
-<span class="sourceLineNo">934</span>        public Builder valueSeparator()<a name="line.934"></a>
-<span class="sourceLineNo">935</span>        {<a name="line.935"></a>
-<span class="sourceLineNo">936</span>            return valueSeparator('=');<a name="line.936"></a>
-<span class="sourceLineNo">937</span>        }<a name="line.937"></a>
-<span class="sourceLineNo">938</span><a name="line.938"></a>
-<span class="sourceLineNo">939</span>        /**<a name="line.939"></a>
-<span class="sourceLineNo">940</span>         * The Option will use &lt;code&gt;sep&lt;/code&gt; as a means to<a name="line.940"></a>
-<span class="sourceLineNo">941</span>         * separate argument values.<a name="line.941"></a>
-<span class="sourceLineNo">942</span>         * &lt;p&gt;<a name="line.942"></a>
-<span class="sourceLineNo">943</span>         * &lt;b&gt;Example:&lt;/b&gt;<a name="line.943"></a>
-<span class="sourceLineNo">944</span>         * &lt;pre&gt;<a name="line.944"></a>
-<span class="sourceLineNo">945</span>         * Option opt = Option.builder("D").hasArgs()<a name="line.945"></a>
-<span class="sourceLineNo">946</span>         *                                 .valueSeparator('=')<a name="line.946"></a>
-<span class="sourceLineNo">947</span>         *                                 .build();<a name="line.947"></a>
-<span class="sourceLineNo">948</span>         * Options options = new Options();<a name="line.948"></a>
-<span class="sourceLineNo">949</span>         * options.addOption(opt);<a name="line.949"></a>
-<span class="sourceLineNo">950</span>         * String[] args = {"-Dkey=value"};<a name="line.950"></a>
-<span class="sourceLineNo">951</span>         * CommandLineParser parser = new DefaultParser();<a name="line.951"></a>
-<span class="sourceLineNo">952</span>         * CommandLine line = parser.parse(options, args);<a name="line.952"></a>
-<span class="sourceLineNo">953</span>         * String propertyName = line.getOptionValues("D")[0];  // will be "key"<a name="line.953"></a>
-<span class="sourceLineNo">954</span>         * String propertyValue = line.getOptionValues("D")[1]; // will be "value"<a name="line.954"></a>
-<span class="sourceLineNo">955</span>         * &lt;/pre&gt;<a name="line.955"></a>
-<span class="sourceLineNo">956</span>         *<a name="line.956"></a>
-<span class="sourceLineNo">957</span>         * @param sep The value separator.<a name="line.957"></a>
-<span class="sourceLineNo">958</span>         * @return this builder, to allow method chaining<a name="line.958"></a>
-<span class="sourceLineNo">959</span>         */<a name="line.959"></a>
-<span class="sourceLineNo">960</span>        public Builder valueSeparator(final char sep)<a name="line.960"></a>
-<span class="sourceLineNo">961</span>        {<a name="line.961"></a>
-<span class="sourceLineNo">962</span>            valuesep = sep;<a name="line.962"></a>
-<span class="sourceLineNo">963</span>            return this;<a name="line.963"></a>
-<span class="sourceLineNo">964</span>        }<a name="line.964"></a>
-<span class="sourceLineNo">965</span>        <a name="line.965"></a>
-<span class="sourceLineNo">966</span>        /**<a name="line.966"></a>
-<span class="sourceLineNo">967</span>         * Indicates that the Option will require an argument.<a name="line.967"></a>
-<span class="sourceLineNo">968</span>         * <a name="line.968"></a>
-<span class="sourceLineNo">969</span>         * @return this builder, to allow method chaining<a name="line.969"></a>
-<span class="sourceLineNo">970</span>         */<a name="line.970"></a>
-<span class="sourceLineNo">971</span>        public Builder hasArg()<a name="line.971"></a>
-<span class="sourceLineNo">972</span>        {<a name="line.972"></a>
-<span class="sourceLineNo">973</span>            return hasArg(true);<a name="line.973"></a>
-<span class="sourceLineNo">974</span>        }<a name="line.974"></a>
-<span class="sourceLineNo">975</span><a name="line.975"></a>
-<span class="sourceLineNo">976</span>        /**<a name="line.976"></a>
-<span class="sourceLineNo">977</span>         * Indicates if the Option has an argument or not.<a name="line.977"></a>
-<span class="sourceLineNo">978</span>         * <a name="line.978"></a>
-<span class="sourceLineNo">979</span>         * @param hasArg specifies whether the Option takes an argument or not<a name="line.979"></a>
-<span class="sourceLineNo">980</span>         * @return this builder, to allow method chaining<a name="line.980"></a>
-<span class="sourceLineNo">981</span>         */<a name="line.981"></a>
-<span class="sourceLineNo">982</span>        public Builder hasArg(final boolean hasArg)<a name="line.982"></a>
-<span class="sourceLineNo">983</span>        {<a name="line.983"></a>
-<span class="sourceLineNo">984</span>            // set to UNINITIALIZED when no arg is specified to be compatible with OptionBuilder<a name="line.984"></a>
-<span class="sourceLineNo">985</span>            numberOfArgs = hasArg ? 1 : Option.UNINITIALIZED;<a name="line.985"></a>
-<span class="sourceLineNo">986</span>            return this;<a name="line.986"></a>
-<span class="sourceLineNo">987</span>        }<a name="line.987"></a>
-<span class="sourceLineNo">988</span><a name="line.988"></a>
-<span class="sourceLineNo">989</span>        /**<a name="line.989"></a>
-<span class="sourceLineNo">990</span>         * Indicates that the Option can have unlimited argument values.<a name="line.990"></a>
-<span class="sourceLineNo">991</span>         * <a name="line.991"></a>
-<span class="sourceLineNo">992</span>         * @return this builder, to allow method chaining<a name="line.992"></a>
-<span class="sourceLineNo">993</span>         */<a name="line.993"></a>
-<span class="sourceLineNo">994</span>        public Builder hasArgs()<a name="line.994"></a>
-<span class="sourceLineNo">995</span>        {<a name="line.995"></a>
-<span class="sourceLineNo">996</span>            numberOfArgs = Option.UNLIMITED_VALUES;<a name="line.996"></a>
-<span class="sourceLineNo">997</span>            return this;<a name="line.997"></a>
-<span class="sourceLineNo">998</span>        }<a name="line.998"></a>
-<span class="sourceLineNo">999</span><a name="line.999"></a>
-<span class="sourceLineNo">1000</span>        /**<a name="line.1000"></a>
-<span class="sourceLineNo">1001</span>         * Constructs an Option with the values declared by this {@link Builder}.<a name="line.1001"></a>
-<span class="sourceLineNo">1002</span>         * <a name="line.1002"></a>
-<span class="sourceLineNo">1003</span>         * @return the new {@link Option}<a name="line.1003"></a>
-<span class="sourceLineNo">1004</span>         * @throws IllegalArgumentException if neither {@code opt} or {@code longOpt} has been set<a name="line.1004"></a>
-<span class="sourceLineNo">1005</span>         */<a name="line.1005"></a>
-<span class="sourceLineNo">1006</span>        public Option build()<a name="line.1006"></a>
-<span class="sourceLineNo">1007</span>        {<a name="line.1007"></a>
-<span class="sourceLineNo">1008</span>            if (opt == null &amp;&amp; longOpt == null)<a name="line.1008"></a>
-<span class="sourceLineNo">1009</span>            {<a name="line.1009"></a>
-<span class="sourceLineNo">1010</span>                throw new IllegalArgumentException("Either opt or longOpt must be specified");<a name="line.1010"></a>
-<span class="sourceLineNo">1011</span>            }<a name="line.1011"></a>
-<span class="sourceLineNo">1012</span>            return new Option(this);<a name="line.1012"></a>
-<span class="sourceLineNo">1013</span>        }<a name="line.1013"></a>
-<span class="sourceLineNo">1014</span>    }<a name="line.1014"></a>
-<span class="sourceLineNo">1015</span>}<a name="line.1015"></a>
+<span class="sourceLineNo">646</span>        if (opt != null ? !opt.equals(option.opt) : option.opt != null)<a name="line.646"></a>
+<span class="sourceLineNo">647</span>        {<a name="line.647"></a>
+<span class="sourceLineNo">648</span>            return false;<a name="line.648"></a>
+<span class="sourceLineNo">649</span>        }<a name="line.649"></a>
+<span class="sourceLineNo">650</span>        if (longOpt != null ? !longOpt.equals(option.longOpt) : option.longOpt != null)<a name="line.650"></a>
+<span class="sourceLineNo">651</span>        {<a name="line.651"></a>
+<span class="sourceLineNo">652</span>            return false;<a name="line.652"></a>
+<span class="sourceLineNo">653</span>        }<a name="line.653"></a>
+<span class="sourceLineNo">654</span><a name="line.654"></a>
+<span class="sourceLineNo">655</span>        return true;<a name="line.655"></a>
+<span class="sourceLineNo">656</span>    }<a name="line.656"></a>
+<span class="sourceLineNo">657</span><a name="line.657"></a>
+<span class="sourceLineNo">658</span>    @Override<a name="line.658"></a>
+<span class="sourceLineNo">659</span>    public int hashCode()<a name="line.659"></a>
+<span class="sourceLineNo">660</span>    {<a name="line.660"></a>
+<span class="sourceLineNo">661</span>        int result;<a name="line.661"></a>
+<span class="sourceLineNo">662</span>        result = opt != null ? opt.hashCode() : 0;<a name="line.662"></a>
+<span class="sourceLineNo">663</span>        result = 31 * result + (longOpt != null ? longOpt.hashCode() : 0);<a name="line.663"></a>
+<span class="sourceLineNo">664</span>        return result;<a name="line.664"></a>
+<span class="sourceLineNo">665</span>    }<a name="line.665"></a>
+<span class="sourceLineNo">666</span><a name="line.666"></a>
+<span class="sourceLineNo">667</span>    /**<a name="line.667"></a>
+<span class="sourceLineNo">668</span>     * A rather odd clone method - due to incorrect code in 1.0 it is public <a name="line.668"></a>
+<span class="sourceLineNo">669</span>     * and in 1.1 rather than throwing a CloneNotSupportedException it throws <a name="line.669"></a>
+<span class="sourceLineNo">670</span>     * a RuntimeException so as to maintain backwards compat at the API level. <a name="line.670"></a>
+<span class="sourceLineNo">671</span>     *<a name="line.671"></a>
+<span class="sourceLineNo">672</span>     * After calling this method, it is very likely you will want to call <a name="line.672"></a>
+<span class="sourceLineNo">673</span>     * clearValues(). <a name="line.673"></a>
+<span class="sourceLineNo">674</span>     *<a name="line.674"></a>
+<span class="sourceLineNo">675</span>     * @return a clone of this Option instance<a name="line.675"></a>
+<span class="sourceLineNo">676</span>     * @throws RuntimeException if a {@link CloneNotSupportedException} has been thrown<a name="line.676"></a>
+<span class="sourceLineNo">677</span>     * by {@code super.clone()}<a name="line.677"></a>
+<span class="sourceLineNo">678</span>     */<a name="line.678"></a>
+<span class="sourceLineNo">679</span>    @Override<a name="line.679"></a>
+<span class="sourceLineNo">680</span>    public Object clone()<a name="line.680"></a>
+<span class="sourceLineNo">681</span>    {<a name="line.681"></a>
+<span class="sourceLineNo">682</span>        try<a name="line.682"></a>
+<span class="sourceLineNo">683</span>        {<a name="line.683"></a>
+<span class="sourceLineNo">684</span>            final Option option = (Option) super.clone();<a name="line.684"></a>
+<span class="sourceLineNo">685</span>            option.values = new ArrayList&lt;String&gt;(values);<a name="line.685"></a>
+<span class="sourceLineNo">686</span>            return option;<a name="line.686"></a>
+<span class="sourceLineNo">687</span>        }<a name="line.687"></a>
+<span class="sourceLineNo">688</span>        catch (final CloneNotSupportedException cnse)<a name="line.688"></a>
+<span class="sourceLineNo">689</span>        {<a name="line.689"></a>
+<span class="sourceLineNo">690</span>            throw new RuntimeException("A CloneNotSupportedException was thrown: " + cnse.getMessage());<a name="line.690"></a>
+<span class="sourceLineNo">691</span>        }<a name="line.691"></a>
+<span class="sourceLineNo">692</span>    }<a name="line.692"></a>
+<span class="sourceLineNo">693</span><a name="line.693"></a>
+<span class="sourceLineNo">694</span>    /**<a name="line.694"></a>
+<span class="sourceLineNo">695</span>     * Clear the Option values. After a parse is complete, these are left with<a name="line.695"></a>
+<span class="sourceLineNo">696</span>     * data in them and they need clearing if another parse is done.<a name="line.696"></a>
+<span class="sourceLineNo">697</span>     *<a name="line.697"></a>
+<span class="sourceLineNo">698</span>     * See: &lt;a href="https://issues.apache.org/jira/browse/CLI-71"&gt;CLI-71&lt;/a&gt;<a name="line.698"></a>
+<span class="sourceLineNo">699</span>     */<a name="line.699"></a>
+<span class="sourceLineNo">700</span>    void clearValues()<a name="line.700"></a>
+<span class="sourceLineNo">701</span>    {<a name="line.701"></a>
+<span class="sourceLineNo">702</span>        values.clear();<a name="line.702"></a>
+<span class="sourceLineNo">703</span>    }<a name="line.703"></a>
+<span class="sourceLineNo">704</span><a name="line.704"></a>
+<span class="sourceLineNo">705</span>    /**<a name="line.705"></a>
+<span class="sourceLineNo">706</span>     * This method is not intended to be used. It was a piece of internal <a name="line.706"></a>
+<span class="sourceLineNo">707</span>     * API that was made public in 1.0. It currently throws an UnsupportedOperationException.<a name="line.707"></a>
+<span class="sourceLineNo">708</span>     *<a name="line.708"></a>
+<span class="sourceLineNo">709</span>     * @param value the value to add<a name="line.709"></a>
+<span class="sourceLineNo">710</span>     * @return always throws an {@link UnsupportedOperationException}<a name="line.710"></a>
+<span class="sourceLineNo">711</span>     * @throws UnsupportedOperationException always<a name="line.711"></a>
+<span class="sourceLineNo">712</span>     * @deprecated<a name="line.712"></a>
+<span class="sourceLineNo">713</span>     */<a name="line.713"></a>
+<span class="sourceLineNo">714</span>    @Deprecated<a name="line.714"></a>
+<span class="sourceLineNo">715</span>    public boolean addValue(final String value)<a name="line.715"></a>
+<span class="sourceLineNo">716</span>    {<a name="line.716"></a>
+<span class="sourceLineNo">717</span>        throw new UnsupportedOperationException("The addValue method is not intended for client use. "<a name="line.717"></a>
+<span class="sourceLineNo">718</span>                + "Subclasses should use the addValueForProcessing method instead. ");<a name="line.718"></a>
+<span class="sourceLineNo">719</span>    }<a name="line.719"></a>
+<span class="sourceLineNo">720</span><a name="line.720"></a>
+<span class="sourceLineNo">721</span>    /**<a name="line.721"></a>
+<span class="sourceLineNo">722</span>     * Tells if the option can accept more arguments.<a name="line.722"></a>
+<span class="sourceLineNo">723</span>     * <a name="line.723"></a>
+<span class="sourceLineNo">724</span>     * @return false if the maximum number of arguments is reached<a name="line.724"></a>
+<span class="sourceLineNo">725</span>     * @since 1.3<a name="line.725"></a>
+<span class="sourceLineNo">726</span>     */<a name="line.726"></a>
+<span class="sourceLineNo">727</span>    boolean acceptsArg()<a name="line.727"></a>
+<span class="sourceLineNo">728</span>    {<a name="line.728"></a>
+<span class="sourceLineNo">729</span>        return (hasArg() || hasArgs() || hasOptionalArg()) &amp;&amp; (numberOfArgs &lt;= 0 || values.size() &lt; numberOfArgs);<a name="line.729"></a>
+<span class="sourceLineNo">730</span>    }<a name="line.730"></a>
+<span class="sourceLineNo">731</span><a name="line.731"></a>
+<span class="sourceLineNo">732</span>    /**<a name="line.732"></a>
+<span class="sourceLineNo">733</span>     * Tells if the option requires more arguments to be valid.<a name="line.733"></a>
+<span class="sourceLineNo">734</span>     * <a name="line.734"></a>
+<span class="sourceLineNo">735</span>     * @return false if the option doesn't require more arguments<a name="line.735"></a>
+<span class="sourceLineNo">736</span>     * @since 1.3<a name="line.736"></a>
+<span class="sourceLineNo">737</span>     */<a name="line.737"></a>
+<span class="sourceLineNo">738</span>    boolean requiresArg()<a name="line.738"></a>
+<span class="sourceLineNo">739</span>    {<a name="line.739"></a>
+<span class="sourceLineNo">740</span>        if (optionalArg)<a name="line.740"></a>
+<span class="sourceLineNo">741</span>        {<a name="line.741"></a>
+<span class="sourceLineNo">742</span>            return false;<a name="line.742"></a>
+<span class="sourceLineNo">743</span>        }<a name="line.743"></a>
+<span class="sourceLineNo">744</span>        if (numberOfArgs == UNLIMITED_VALUES)<a name="line.744"></a>
+<span class="sourceLineNo">745</span>        {<a name="line.745"></a>
+<span class="sourceLineNo">746</span>            return values.isEmpty();<a name="line.746"></a>
+<span class="sourceLineNo">747</span>        }<a name="line.747"></a>
+<span class="sourceLineNo">748</span>        return acceptsArg();<a name="line.748"></a>
+<span class="sourceLineNo">749</span>    }<a name="line.749"></a>
+<span class="sourceLineNo">750</span>    <a name="line.750"></a>
+<span class="sourceLineNo">751</span>    /**<a name="line.751"></a>
+<span class="sourceLineNo">752</span>     * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.752"></a>
+<span class="sourceLineNo">753</span>     * methods.  <a name="line.753"></a>
+<span class="sourceLineNo">754</span>     * <a name="line.754"></a>
+<span class="sourceLineNo">755</span>     * @return a new {@link Builder} instance<a name="line.755"></a>
+<span class="sourceLineNo">756</span>     * @since 1.3<a name="line.756"></a>
+<span class="sourceLineNo">757</span>     */<a name="line.757"></a>
+<span class="sourceLineNo">758</span>    public static Builder builder()<a name="line.758"></a>
+<span class="sourceLineNo">759</span>    {<a name="line.759"></a>
+<span class="sourceLineNo">760</span>        return builder(null);<a name="line.760"></a>
+<span class="sourceLineNo">761</span>    }<a name="line.761"></a>
+<span class="sourceLineNo">762</span>    <a name="line.762"></a>
+<span class="sourceLineNo">763</span>    /**<a name="line.763"></a>
+<span class="sourceLineNo">764</span>     * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.764"></a>
+<span class="sourceLineNo">765</span>     * methods.  <a name="line.765"></a>
+<span class="sourceLineNo">766</span>     *<a name="line.766"></a>
+<span class="sourceLineNo">767</span>     * @param opt short representation of the option<a name="line.767"></a>
+<span class="sourceLineNo">768</span>     * @return a new {@link Builder} instance<a name="line.768"></a>
+<span class="sourceLineNo">769</span>     * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.769"></a>
+<span class="sourceLineNo">770</span>     * @since 1.3<a name="line.770"></a>
+<span class="sourceLineNo">771</span>     */<a name="line.771"></a>
+<span class="sourceLineNo">772</span>    public static Builder builder(final String opt)<a name="line.772"></a>
+<span class="sourceLineNo">773</span>    {<a name="line.773"></a>
+<span class="sourceLineNo">774</span>        return new Builder(opt);<a name="line.774"></a>
+<span class="sourceLineNo">775</span>    }<a name="line.775"></a>
+<span class="sourceLineNo">776</span>    <a name="line.776"></a>
+<span class="sourceLineNo">777</span>    /**<a name="line.777"></a>
+<span class="sourceLineNo">778</span>     * A nested builder class to create &lt;code&gt;Option&lt;/code&gt; instances<a name="line.778"></a>
+<span class="sourceLineNo">779</span>     * using descriptive methods.<a name="line.779"></a>
+<span class="sourceLineNo">780</span>     * &lt;p&gt;<a name="line.780"></a>
+<span class="sourceLineNo">781</span>     * Example usage:<a name="line.781"></a>
+<span class="sourceLineNo">782</span>     * &lt;pre&gt;<a name="line.782"></a>
+<span class="sourceLineNo">783</span>     * Option option = Option.builder("a")<a name="line.783"></a>
+<span class="sourceLineNo">784</span>     *     .required(true)<a name="line.784"></a>
+<span class="sourceLineNo">785</span>     *     .longOpt("arg-name")<a name="line.785"></a>
+<span class="sourceLineNo">786</span>     *     .build();<a name="line.786"></a>
+<span class="sourceLineNo">787</span>     * &lt;/pre&gt;<a name="line.787"></a>
+<span class="sourceLineNo">788</span>     * <a name="line.788"></a>
+<span class="sourceLineNo">789</span>     * @since 1.3<a name="line.789"></a>
+<span class="sourceLineNo">790</span>     */<a name="line.790"></a>
+<span class="sourceLineNo">791</span>    public static final class Builder <a name="line.791"></a>
+<span class="sourceLineNo">792</span>    {<a name="line.792"></a>
+<span class="sourceLineNo">793</span>        /** the name of the option */<a name="line.793"></a>
+<span class="sourceLineNo">794</span>        private final String opt;<a name="line.794"></a>
+<span class="sourceLineNo">795</span><a name="line.795"></a>
+<span class="sourceLineNo">796</span>        /** description of the option */<a name="line.796"></a>
+<span class="sourceLineNo">797</span>        private String description;<a name="line.797"></a>
+<span class="sourceLineNo">798</span><a name="line.798"></a>
+<span class="sourceLineNo">799</span>        /** the long representation of the option */<a name="line.799"></a>
+<span class="sourceLineNo">800</span>        private String longOpt;<a name="line.800"></a>
+<span class="sourceLineNo">801</span><a name="line.801"></a>
+<span class="sourceLineNo">802</span>        /** the name of the argument for this option */<a name="line.802"></a>
+<span class="sourceLineNo">803</span>        private String argName;<a name="line.803"></a>
+<span class="sourceLineNo">804</span><a name="line.804"></a>
+<span class="sourceLineNo">805</span>        /** specifies whether this option is required to be present */<a name="line.805"></a>
+<span class="sourceLineNo">806</span>        private boolean required;<a name="line.806"></a>
+<span class="sourceLineNo">807</span><a name="line.807"></a>
+<span class="sourceLineNo">808</span>        /** specifies whether the argument value of this Option is optional */<a name="line.808"></a>
+<span class="sourceLineNo">809</span>        private boolean optionalArg;<a name="line.809"></a>
+<span class="sourceLineNo">810</span><a name="line.810"></a>
+<span class="sourceLineNo">811</span>        /** the number of argument values this option can have */<a name="line.811"></a>
+<span class="sourceLineNo">812</span>        private int numberOfArgs = UNINITIALIZED;<a name="line.812"></a>
+<span class="sourceLineNo">813</span><a name="line.813"></a>
+<span class="sourceLineNo">814</span>        /** the type of this Option */<a name="line.814"></a>
+<span class="sourceLineNo">815</span>        private Class&lt;?&gt; type = String.class;<a name="line.815"></a>
+<span class="sourceLineNo">816</span><a name="line.816"></a>
+<span class="sourceLineNo">817</span>        /** the character that is the value separator */<a name="line.817"></a>
+<span class="sourceLineNo">818</span>        private char valuesep;<a name="line.818"></a>
+<span class="sourceLineNo">819</span><a name="line.819"></a>
+<span class="sourceLineNo">820</span>        /**<a name="line.820"></a>
+<span class="sourceLineNo">821</span>         * Constructs a new &lt;code&gt;Builder&lt;/code&gt; with the minimum<a name="line.821"></a>
+<span class="sourceLineNo">822</span>         * required parameters for an &lt;code&gt;Option&lt;/code&gt; instance.<a name="line.822"></a>
+<span class="sourceLineNo">823</span>         * <a name="line.823"></a>
+<span class="sourceLineNo">824</span>         * @param opt short representation of the option<a name="line.824"></a>
+<span class="sourceLineNo">825</span>         * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.825"></a>
+<span class="sourceLineNo">826</span>         */<a name="line.826"></a>
+<span class="sourceLineNo">827</span>        private Builder(final String opt) throws IllegalArgumentException<a name="line.827"></a>
+<span class="sourceLineNo">828</span>        {<a name="line.828"></a>
+<span class="sourceLineNo">829</span>            OptionValidator.validateOption(opt);<a name="line.829"></a>
+<span class="sourceLineNo">830</span>            this.opt = opt;<a name="line.830"></a>
+<span class="sourceLineNo">831</span>        }<a name="line.831"></a>
+<span class="sourceLineNo">832</span>        <a name="line.832"></a>
+<span class="sourceLineNo">833</span>        /**<a name="line.833"></a>
+<span class="sourceLineNo">834</span>         * Sets the display name for the argument value.<a name="line.834"></a>
+<span class="sourceLineNo">835</span>         *<a name="line.835"></a>
+<span class="sourceLineNo">836</span>         * @param argName the display name for the argument value.<a name="line.836"></a>
+<span class="sourceLineNo">837</span>         * @return this builder, to allow method chaining<a name="line.837"></a>
+<span class="sourceLineNo">838</span>         */<a name="line.838"></a>
+<span class="sourceLineNo">839</span>        public Builder argName(final String argName)<a name="line.839"></a>
+<span class="sourceLineNo">840</span>        {<a name="line.840"></a>
+<span class="sourceLineNo">841</span>            this.argName = argName;<a name="line.841"></a>
+<span class="sourceLineNo">842</span>            return this;<a name="line.842"></a>
+<span class="sourceLineNo">843</span>        }<a name="line.843"></a>
+<span class="sourceLineNo">844</span><a name="line.844"></a>
+<span class="sourceLineNo">845</span>        /**<a name="line.845"></a>
+<span class="sourceLineNo">846</span>         * Sets the description for this option.<a name="line.846"></a>
+<span class="sourceLineNo">847</span>         *<a name="line.847"></a>
+<span class="sourceLineNo">848</span>         * @param description the description of the option.<a name="line.848"></a>
+<span class="sourceLineNo">849</span>         * @return this builder, to allow method chaining<a name="line.849"></a>
+<span class="sourceLineNo">850</span>         */<a name="line.850"></a>
+<span class="sourceLineNo">851</span>        public Builder desc(final String description)<a name="line.851"></a>
+<span class="sourceLineNo">852</span>        {<a name="line.852"></a>
+<span class="sourceLineNo">853</span>            this.description = description;<a name="line.853"></a>
+<span class="sourceLineNo">854</span>            return this;<a name="line.854"></a>
+<span class="sourceLineNo">855</span>        }<a name="line.855"></a>
+<span class="sourceLineNo">856</span><a name="line.856"></a>
+<span class="sourceLineNo">857</span>        /**<a name="line.857"></a>
+<span class="sourceLineNo">858</span>         * Sets the long name of the Option.<a name="line.858"></a>
+<span class="sourceLineNo">859</span>         *<a name="line.859"></a>
+<span class="sourceLineNo">860</span>         * @param longOpt the long name of the Option<a name="line.860"></a>
+<span class="sourceLineNo">861</span>         * @return this builder, to allow method chaining<a name="line.861"></a>
+<span class="sourceLineNo">862</span>         */        <a name="line.862"></a>
+<span class="sourceLineNo">863</span>        public Builder longOpt(final String longOpt)<a name="line.863"></a>
+<span class="sourceLineNo">864</span>        {<a name="line.864"></a>
+<span class="sourceLineNo">865</span>            this.longOpt = longOpt;<a name="line.865"></a>
+<span class="sourceLineNo">866</span>            return this;<a name="line.866"></a>
+<span class="sourceLineNo">867</span>        }<a name="line.867"></a>
+<span class="sourceLineNo">868</span>        <a name="line.868"></a>
+<span class="sourceLineNo">869</span>        /** <a name="line.869"></a>
+<span class="sourceLineNo">870</span>         * Sets the number of argument values the Option can take.<a name="line.870"></a>
+<span class="sourceLineNo">871</span>         *<a name="line.871"></a>
+<span class="sourceLineNo">872</span>         * @param numberOfArgs the number of argument values<a name="line.872"></a>
+<span class="sourceLineNo">873</span>         * @return this builder, to allow method chaining<a name="line.873"></a>
+<span class="sourceLineNo">874</span>         */        <a name="line.874"></a>
+<span class="sourceLineNo">875</span>        public Builder numberOfArgs(final int numberOfArgs)<a name="line.875"></a>
+<span class="sourceLineNo">876</span>        {<a name="line.876"></a>
+<span class="sourceLineNo">877</span>            this.numberOfArgs = numberOfArgs;<a name="line.877"></a>
+<span class="sourceLineNo">878</span>            return this;<a name="line.878"></a>
+<span class="sourceLineNo">879</span>        }<a name="line.879"></a>
+<span class="sourceLineNo">880</span>        <a name="line.880"></a>
+<span class="sourceLineNo">881</span>        /**<a name="line.881"></a>
+<span class="sourceLineNo">882</span>         * Sets whether the Option can have an optional argument.<a name="line.882"></a>
+<span class="sourceLineNo">883</span>         *<a name="line.883"></a>
+<span class="sourceLineNo">884</span>         * @param isOptional specifies whether the Option can have<a name="line.884"></a>
+<span class="sourceLineNo">885</span>         * an optional argument.<a name="line.885"></a>
+<span class="sourceLineNo">886</span>         * @return this builder, to allow method chaining<a name="line.886"></a>
+<span class="sourceLineNo">887</span>         */<a name="line.887"></a>
+<span class="sourceLineNo">888</span>        public Builder optionalArg(final boolean isOptional)<a name="line.888"></a>
+<span class="sourceLineNo">889</span>        {<a name="line.889"></a>
+<span class="sourceLineNo">890</span>            this.optionalArg = isOptional;<a name="line.890"></a>
+<span class="sourceLineNo">891</span>            return this;<a name="line.891"></a>
+<span class="sourceLineNo">892</span>        }<a name="line.892"></a>
+<span class="sourceLineNo">893</span>        <a name="line.893"></a>
+<span class="sourceLineNo">894</span>        /**<a name="line.894"></a>
+<span class="sourceLineNo">895</span>         * Marks this Option as required.<a name="line.895"></a>
+<span class="sourceLineNo">896</span>         *<a name="line.896"></a>
+<span class="sourceLineNo">897</span>         * @return this builder, to allow method chaining<a name="line.897"></a>
+<span class="sourceLineNo">898</span>         */<a name="line.898"></a>
+<span class="sourceLineNo">899</span>        public Builder required()<a name="line.899"></a>
+<span class="sourceLineNo">900</span>        {<a name="line.900"></a>
+<span class="sourceLineNo">901</span>            return required(true);<a name="line.901"></a>
+<span class="sourceLineNo">902</span>        }<a name="line.902"></a>
+<span class="sourceLineNo">903</span><a name="line.903"></a>
+<span class="sourceLineNo">904</span>        /**<a name="line.904"></a>
+<span class="sourceLineNo">905</span>         * Sets whether the Option is mandatory.<a name="line.905"></a>
+<span class="sourceLineNo">906</span>         *<a name="line.906"></a>
+<span class="sourceLineNo">907</span>         * @param required specifies whether the Option is mandatory<a name="line.907"></a>
+<span class="sourceLineNo">908</span>         * @return this builder, to allow method chaining<a name="line.908"></a>
+<span class="sourceLineNo">909</span>         */<a name="line.909"></a>
+<span class="sourceLineNo">910</span>        public Builder required(final boolean required)<a name="line.910"></a>
+<span class="sourceLineNo">911</span>        {<a name="line.911"></a>
+<span class="sourceLineNo">912</span>            this.required = required;<a name="line.912"></a>
+<span class="sourceLineNo">913</span>            return this;<a name="line.913"></a>
+<span class="sourceLineNo">914</span>        }<a name="line.914"></a>
+<span class="sourceLineNo">915</span>        <a name="line.915"></a>
+<span class="sourceLineNo">916</span>        /**<a name="line.916"></a>
+<span class="sourceLineNo">917</span>         * Sets the type of the Option.<a name="line.917"></a>
+<span class="sourceLineNo">918</span>         *<a name="line.918"></a>
+<span class="sourceLineNo">919</span>         * @param type the type of the Option<a name="line.919"></a>
+<span class="sourceLineNo">920</span>         * @return this builder, to allow method chaining<a name="line.920"></a>
+<span class="sourceLineNo">921</span>         */<a name="line.921"></a>
+<span class="sourceLineNo">922</span>        public Builder type(final Class&lt;?&gt; type)<a name="line.922"></a>
+<span class="sourceLineNo">923</span>        {<a name="line.923"></a>
+<span class="sourceLineNo">924</span>            this.type = type;<a name="line.924"></a>
+<span class="sourceLineNo">925</span>            return this;<a name="line.925"></a>
+<span class="sourceLineNo">926</span>        }<a name="line.926"></a>
+<span class="sourceLineNo">927</span><a name="line.927"></a>
+<span class="sourceLineNo">928</span>        /**<a name="line.928"></a>
+<span class="sourceLineNo">929</span>         * The Option will use '=' as a means to separate argument value.<a name="line.929"></a>
+<span class="sourceLineNo">930</span>         *<a name="line.930"></a>
+<span class="sourceLineNo">931</span>         * @return this builder, to allow method chaining<a name="line.931"></a>
+<span class="sourceLineNo">932</span>         */<a name="line.932"></a>
+<span class="sourceLineNo">933</span>        public Builder valueSeparator()<a name="line.933"></a>
+<span class="sourceLineNo">934</span>        {<a name="line.934"></a>
+<span class="sourceLineNo">935</span>            return valueSeparator('=');<a name="line.935"></a>
+<span class="sourceLineNo">936</span>        }<a name="line.936"></a>
+<span class="sourceLineNo">937</span><a name="line.937"></a>
+<span class="sourceLineNo">938</span>        /**<a name="line.938"></a>
+<span class="sourceLineNo">939</span>         * The Option will use &lt;code&gt;sep&lt;/code&gt; as a means to<a name="line.939"></a>
+<span class="sourceLineNo">940</span>         * separate argument values.<a name="line.940"></a>
+<span class="sourceLineNo">941</span>         * &lt;p&gt;<a name="line.941"></a>
+<span class="sourceLineNo">942</span>         * &lt;b&gt;Example:&lt;/b&gt;<a name="line.942"></a>
+<span class="sourceLineNo">943</span>         * &lt;pre&gt;<a name="line.943"></a>
+<span class="sourceLineNo">944</span>         * Option opt = Option.builder("D").hasArgs()<a name="line.944"></a>
+<span class="sourceLineNo">945</span>         *                                 .valueSeparator('=')<a name="line.945"></a>
+<span class="sourceLineNo">946</span>         *                                 .build();<a name="line.946"></a>
+<span class="sourceLineNo">947</span>         * Options options = new Options();<a name="line.947"></a>
+<span class="sourceLineNo">948</span>         * options.addOption(opt);<a name="line.948"></a>
+<span class="sourceLineNo">949</span>         * String[] args = {"-Dkey=value"};<a name="line.949"></a>
+<span class="sourceLineNo">950</span>         * CommandLineParser parser = new DefaultParser();<a name="line.950"></a>
+<span class="sourceLineNo">951</span>         * CommandLine line = parser.parse(options, args);<a name="line.951"></a>
+<span class="sourceLineNo">952</span>         * String propertyName = line.getOptionValues("D")[0];  // will be "key"<a name="line.952"></a>
+<span class="sourceLineNo">953</span>         * String propertyValue = line.getOptionValues("D")[1]; // will be "value"<a name="line.953"></a>
+<span class="sourceLineNo">954</span>         * &lt;/pre&gt;<a name="line.954"></a>
+<span class="sourceLineNo">955</span>         *<a name="line.955"></a>
+<span class="sourceLineNo">956</span>         * @param sep The value separator.<a name="line.956"></a>
+<span class="sourceLineNo">957</span>         * @return this builder, to allow method chaining<a name="line.957"></a>
+<span class="sourceLineNo">958</span>         */<a name="line.958"></a>
+<span class="sourceLineNo">959</span>        public Builder valueSeparator(final char sep)<a name="line.959"></a>
+<span class="sourceLineNo">960</span>        {<a name="line.960"></a>
+<span class="sourceLineNo">961</span>            valuesep = sep;<a name="line.961"></a>
+<span class="sourceLineNo">962</span>            return this;<a name="line.962"></a>
+<span class="sourceLineNo">963</span>        }<a name="line.963"></a>
+<span class="sourceLineNo">964</span>        <a name="line.964"></a>
+<span class="sourceLineNo">965</span>        /**<a name="line.965"></a>
+<span class="sourceLineNo">966</span>         * Indicates that the Option will require an argument.<a name="line.966"></a>
+<span class="sourceLineNo">967</span>         * <a name="line.967"></a>
+<span class="sourceLineNo">968</span>         * @return this builder, to allow method chaining<a name="line.968"></a>
+<span class="sourceLineNo">969</span>         */<a name="line.969"></a>
+<span class="sourceLineNo">970</span>        public Builder hasArg()<a name="line.970"></a>
+<span class="sourceLineNo">971</span>        {<a name="line.971"></a>
+<span class="sourceLineNo">972</span>            return hasArg(true);<a name="line.972"></a>
+<span class="sourceLineNo">973</span>        }<a name="line.973"></a>
+<span class="sourceLineNo">974</span><a name="line.974"></a>
+<span class="sourceLineNo">975</span>        /**<a name="line.975"></a>
+<span class="sourceLineNo">976</span>         * Indicates if the Option has an argument or not.<a name="line.976"></a>
+<span class="sourceLineNo">977</span>         * <a name="line.977"></a>
+<span class="sourceLineNo">978</span>         * @param hasArg specifies whether the Option takes an argument or not<a name="line.978"></a>
+<span class="sourceLineNo">979</span>         * @return this builder, to allow method chaining<a name="line.979"></a>
+<span class="sourceLineNo">980</span>         */<a name="line.980"></a>
+<span class="sourceLineNo">981</span>        public Builder hasArg(final boolean hasArg)<a name="line.981"></a>
+<span class="sourceLineNo">982</span>        {<a name="line.982"></a>
+<span class="sourceLineNo">983</span>            // set to UNINITIALIZED when no arg is specified to be compatible with OptionBuilder<a name="line.983"></a>
+<span class="sourceLineNo">984</span>            numberOfArgs = hasArg ? 1 : Option.UNINITIALIZED;<a name="line.984"></a>
+<span class="sourceLineNo">985</span>            return this;<a name="line.985"></a>
+<span class="sourceLineNo">986</span>        }<a name="line.986"></a>
+<span class="sourceLineNo">987</span><a name="line.987"></a>
+<span class="sourceLineNo">988</span>        /**<a name="line.988"></a>
+<span class="sourceLineNo">989</span>         * Indicates that the Option can have unlimited argument values.<a name="line.989"></a>
+<span class="sourceLineNo">990</span>         * <a name="line.990"></a>
+<span class="sourceLineNo">991</span>         * @return this builder, to allow method chaining<a name="line.991"></a>
+<span class="sourceLineNo">992</span>         */<a name="line.992"></a>
+<span class="sourceLineNo">993</span>        public Builder hasArgs()<a name="line.993"></a>
+<span class="sourceLineNo">994</span>        {<a name="line.994"></a>
+<span class="sourceLineNo">995</span>            numberOfArgs = Option.UNLIMITED_VALUES;<a name="line.995"></a>
+<span class="sourceLineNo">996</span>            return this;<a name="line.996"></a>
+<span class="sourceLineNo">997</span>        }<a name="line.997"></a>
+<span class="sourceLineNo">998</span><a name="line.998"></a>
+<span class="sourceLineNo">999</span>        /**<a name="line.999"></a>
+<span class="sourceLineNo">1000</span>         * Constructs an Option with the values declared by this {@link Builder}.<a name="line.1000"></a>
+<span class="sourceLineNo">1001</span>         * <a name="line.1001"></a>
+<span class="sourceLineNo">1002</span>         * @return the new {@link Option}<a name="line.1002"></a>
+<span class="sourceLineNo">1003</span>         * @throws IllegalArgumentException if neither {@code opt} or {@code longOpt} has been set<a name="line.1003"></a>
+<span class="sourceLineNo">1004</span>         */<a name="line.1004"></a>
+<span class="sourceLineNo">1005</span>        public Option build()<a name="line.1005"></a>
+<span class="sourceLineNo">1006</span>        {<a name="line.1006"></a>
+<span class="sourceLineNo">1007</span>            if (opt == null &amp;&amp; longOpt == null)<a name="line.1007"></a>
+<span class="sourceLineNo">1008</span>            {<a name="line.1008"></a>
+<span class="sourceLineNo">1009</span>                throw new IllegalArgumentException("Either opt or longOpt must be specified");<a name="line.1009"></a>
+<span class="sourceLineNo">1010</span>            }<a name="line.1010"></a>
+<span class="sourceLineNo">1011</span>            return new Option(this);<a name="line.1011"></a>
+<span class="sourceLineNo">1012</span>        }<a name="line.1012"></a>
+<span class="sourceLineNo">1013</span>    }<a name="line.1013"></a>
+<span class="sourceLineNo">1014</span>}<a name="line.1014"></a>
 
 
 



Mime
View raw message