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 Mon Mar 13 09:49:52 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 1677406 2015-05-03 14:27:31Z britter $<a name="line.40"></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">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> @@ -423,595 +423,604 @@ <span class="sourceLineNo">415</span><a name="line.415"></a> <span class="sourceLineNo">416</span> /** <a name="line.416"></a> <span class="sourceLineNo">417</span> * Returns the number of argument values this Option can take.<a name="line.417"></a> -<span class="sourceLineNo">418</span> *<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @return num the number of argument values<a name="line.419"></a> -<span class="sourceLineNo">420</span> */<a name="line.420"></a> -<span class="sourceLineNo">421</span> public int getArgs()<a name="line.421"></a> -<span class="sourceLineNo">422</span> {<a name="line.422"></a> -<span class="sourceLineNo">423</span> return numberOfArgs;<a name="line.423"></a> -<span class="sourceLineNo">424</span> }<a name="line.424"></a> -<span class="sourceLineNo">425</span><a name="line.425"></a> -<span class="sourceLineNo">426</span> /**<a name="line.426"></a> -<span class="sourceLineNo">427</span> * Adds the specified value to this Option.<a name="line.427"></a> -<span class="sourceLineNo">428</span> * <a name="line.428"></a> -<span class="sourceLineNo">429</span> * @param value is a/the value of this Option<a name="line.429"></a> -<span class="sourceLineNo">430</span> */<a name="line.430"></a> -<span class="sourceLineNo">431</span> void addValueForProcessing(String value)<a name="line.431"></a> -<span class="sourceLineNo">432</span> {<a name="line.432"></a> -<span class="sourceLineNo">433</span> if (numberOfArgs == UNINITIALIZED)<a name="line.433"></a> -<span class="sourceLineNo">434</span> {<a name="line.434"></a> -<span class="sourceLineNo">435</span> throw new RuntimeException("NO_ARGS_ALLOWED");<a name="line.435"></a> -<span class="sourceLineNo">436</span> }<a name="line.436"></a> -<span class="sourceLineNo">437</span> processValue(value);<a name="line.437"></a> -<span class="sourceLineNo">438</span> }<a name="line.438"></a> -<span class="sourceLineNo">439</span><a name="line.439"></a> -<span class="sourceLineNo">440</span> /**<a name="line.440"></a> -<span class="sourceLineNo">441</span> * Processes the value. If this Option has a value separator<a name="line.441"></a> -<span class="sourceLineNo">442</span> * the value will have to be parsed into individual tokens. When<a name="line.442"></a> -<span class="sourceLineNo">443</span> * n-1 tokens have been processed and there are more value separators<a name="line.443"></a> -<span class="sourceLineNo">444</span> * in the value, parsing is ceased and the remaining characters are<a name="line.444"></a> -<span class="sourceLineNo">445</span> * added as a single token.<a name="line.445"></a> -<span class="sourceLineNo">446</span> *<a name="line.446"></a> -<span class="sourceLineNo">447</span> * @param value The String to be processed.<a name="line.447"></a> -<span class="sourceLineNo">448</span> *<a name="line.448"></a> -<span class="sourceLineNo">449</span> * @since 1.0.1<a name="line.449"></a> -<span class="sourceLineNo">450</span> */<a name="line.450"></a> -<span class="sourceLineNo">451</span> private void processValue(String value)<a name="line.451"></a> -<span class="sourceLineNo">452</span> {<a name="line.452"></a> -<span class="sourceLineNo">453</span> // this Option has a separator character<a name="line.453"></a> -<span class="sourceLineNo">454</span> if (hasValueSeparator())<a name="line.454"></a> -<span class="sourceLineNo">455</span> {<a name="line.455"></a> -<span class="sourceLineNo">456</span> // get the separator character<a name="line.456"></a> -<span class="sourceLineNo">457</span> char sep = getValueSeparator();<a name="line.457"></a> -<span class="sourceLineNo">458</span><a name="line.458"></a> -<span class="sourceLineNo">459</span> // store the index for the value separator<a name="line.459"></a> -<span class="sourceLineNo">460</span> int index = value.indexOf(sep);<a name="line.460"></a> -<span class="sourceLineNo">461</span><a name="line.461"></a> -<span class="sourceLineNo">462</span> // while there are more value separators<a name="line.462"></a> -<span class="sourceLineNo">463</span> while (index != -1)<a name="line.463"></a> -<span class="sourceLineNo">464</span> {<a name="line.464"></a> -<span class="sourceLineNo">465</span> // next value to be added <a name="line.465"></a> -<span class="sourceLineNo">466</span> if (values.size() == numberOfArgs - 1)<a name="line.466"></a> -<span class="sourceLineNo">467</span> {<a name="line.467"></a> -<span class="sourceLineNo">468</span> break;<a name="line.468"></a> -<span class="sourceLineNo">469</span> }<a name="line.469"></a> +<span class="sourceLineNo">418</span> * <a name="line.418"></a> +<span class="sourceLineNo">419</span> * <p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * A value equal to the constant {@link #UNINITIALIZED} (= -1) indicates<a name="line.420"></a> +<span class="sourceLineNo">421</span> * the number of arguments has not been specified.<a name="line.421"></a> +<span class="sourceLineNo">422</span> * A value equal to the constant {@link #UNLIMITED_VALUES} (= -2) indicates<a name="line.422"></a> +<span class="sourceLineNo">423</span> * that this options takes an unlimited amount of values.<a name="line.423"></a> +<span class="sourceLineNo">424</span> * </p><a name="line.424"></a> +<span class="sourceLineNo">425</span> *<a name="line.425"></a> +<span class="sourceLineNo">426</span> * @return num the number of argument values<a name="line.426"></a> +<span class="sourceLineNo">427</span> * @see #UNINITIALIZED<a name="line.427"></a> +<span class="sourceLineNo">428</span> * @see #UNLIMITED_VALUES<a name="line.428"></a> +<span class="sourceLineNo">429</span> */<a name="line.429"></a> +<span class="sourceLineNo">430</span> public int getArgs()<a name="line.430"></a> +<span class="sourceLineNo">431</span> {<a name="line.431"></a> +<span class="sourceLineNo">432</span> return numberOfArgs;<a name="line.432"></a> +<span class="sourceLineNo">433</span> }<a name="line.433"></a> +<span class="sourceLineNo">434</span><a name="line.434"></a> +<span class="sourceLineNo">435</span> /**<a name="line.435"></a> +<span class="sourceLineNo">436</span> * Adds the specified value to this Option.<a name="line.436"></a> +<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">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> +<span class="sourceLineNo">444</span> throw new RuntimeException("NO_ARGS_ALLOWED");<a name="line.444"></a> +<span class="sourceLineNo">445</span> }<a name="line.445"></a> +<span class="sourceLineNo">446</span> processValue(value);<a name="line.446"></a> +<span class="sourceLineNo">447</span> }<a name="line.447"></a> +<span class="sourceLineNo">448</span><a name="line.448"></a> +<span class="sourceLineNo">449</span> /**<a name="line.449"></a> +<span class="sourceLineNo">450</span> * Processes the value. If this Option has a value separator<a name="line.450"></a> +<span class="sourceLineNo">451</span> * the value will have to be parsed into individual tokens. When<a name="line.451"></a> +<span class="sourceLineNo">452</span> * n-1 tokens have been processed and there are more value separators<a name="line.452"></a> +<span class="sourceLineNo">453</span> * in the value, parsing is ceased and the remaining characters are<a name="line.453"></a> +<span class="sourceLineNo">454</span> * added as a single token.<a name="line.454"></a> +<span class="sourceLineNo">455</span> *<a name="line.455"></a> +<span class="sourceLineNo">456</span> * @param value The String to be processed.<a name="line.456"></a> +<span class="sourceLineNo">457</span> *<a name="line.457"></a> +<span class="sourceLineNo">458</span> * @since 1.0.1<a name="line.458"></a> +<span class="sourceLineNo">459</span> */<a name="line.459"></a> +<span class="sourceLineNo">460</span> private void processValue(String value)<a name="line.460"></a> +<span class="sourceLineNo">461</span> {<a name="line.461"></a> +<span class="sourceLineNo">462</span> // this Option has a separator character<a name="line.462"></a> +<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">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> <span class="sourceLineNo">470</span><a name="line.470"></a> -<span class="sourceLineNo">471</span> // store<a name="line.471"></a> -<span class="sourceLineNo">472</span> add(value.substring(0, index));<a name="line.472"></a> -<span class="sourceLineNo">473</span><a name="line.473"></a> -<span class="sourceLineNo">474</span> // parse<a name="line.474"></a> -<span class="sourceLineNo">475</span> value = value.substring(index + 1);<a name="line.475"></a> -<span class="sourceLineNo">476</span><a name="line.476"></a> -<span class="sourceLineNo">477</span> // get new index<a name="line.477"></a> -<span class="sourceLineNo">478</span> index = value.indexOf(sep);<a name="line.478"></a> -<span class="sourceLineNo">479</span> }<a name="line.479"></a> -<span class="sourceLineNo">480</span> }<a name="line.480"></a> -<span class="sourceLineNo">481</span><a name="line.481"></a> -<span class="sourceLineNo">482</span> // store the actual value or the last value that has been parsed<a name="line.482"></a> -<span class="sourceLineNo">483</span> add(value);<a name="line.483"></a> -<span class="sourceLineNo">484</span> }<a name="line.484"></a> +<span class="sourceLineNo">471</span> // while there are more value separators<a name="line.471"></a> +<span class="sourceLineNo">472</span> while (index != -1)<a name="line.472"></a> +<span class="sourceLineNo">473</span> {<a name="line.473"></a> +<span class="sourceLineNo">474</span> // next value to be added <a name="line.474"></a> +<span class="sourceLineNo">475</span> if (values.size() == numberOfArgs - 1)<a name="line.475"></a> +<span class="sourceLineNo">476</span> {<a name="line.476"></a> +<span class="sourceLineNo">477</span> break;<a name="line.477"></a> +<span class="sourceLineNo">478</span> }<a name="line.478"></a> +<span class="sourceLineNo">479</span><a name="line.479"></a> +<span class="sourceLineNo">480</span> // store<a name="line.480"></a> +<span class="sourceLineNo">481</span> add(value.substring(0, index));<a name="line.481"></a> +<span class="sourceLineNo">482</span><a name="line.482"></a> +<span class="sourceLineNo">483</span> // parse<a name="line.483"></a> +<span class="sourceLineNo">484</span> value = value.substring(index + 1);<a name="line.484"></a> <span class="sourceLineNo">485</span><a name="line.485"></a> -<span class="sourceLineNo">486</span> /**<a name="line.486"></a> -<span class="sourceLineNo">487</span> * Add the value to this Option. If the number of arguments<a name="line.487"></a> -<span class="sourceLineNo">488</span> * is greater than zero and there is enough space in the list then<a name="line.488"></a> -<span class="sourceLineNo">489</span> * add the value. Otherwise, throw a runtime exception.<a name="line.489"></a> -<span class="sourceLineNo">490</span> *<a name="line.490"></a> -<span class="sourceLineNo">491</span> * @param value The value to be added to this Option<a name="line.491"></a> -<span class="sourceLineNo">492</span> *<a name="line.492"></a> -<span class="sourceLineNo">493</span> * @since 1.0.1<a name="line.493"></a> -<span class="sourceLineNo">494</span> */<a name="line.494"></a> -<span class="sourceLineNo">495</span> private void add(String value)<a name="line.495"></a> -<span class="sourceLineNo">496</span> {<a name="line.496"></a> -<span class="sourceLineNo">497</span> if (!acceptsArg())<a name="line.497"></a> -<span class="sourceLineNo">498</span> {<a name="line.498"></a> -<span class="sourceLineNo">499</span> throw new RuntimeException("Cannot add value, list full.");<a name="line.499"></a> -<span class="sourceLineNo">500</span> }<a name="line.500"></a> -<span class="sourceLineNo">501</span><a name="line.501"></a> -<span class="sourceLineNo">502</span> // store value<a name="line.502"></a> -<span class="sourceLineNo">503</span> values.add(value);<a name="line.503"></a> -<span class="sourceLineNo">504</span> }<a name="line.504"></a> -<span class="sourceLineNo">505</span><a name="line.505"></a> -<span class="sourceLineNo">506</span> /**<a name="line.506"></a> -<span class="sourceLineNo">507</span> * Returns the specified value of this Option or <a name="line.507"></a> -<span class="sourceLineNo">508</span> * <code>null</code> if there is no value.<a name="line.508"></a> -<span class="sourceLineNo">509</span> *<a name="line.509"></a> -<span class="sourceLineNo">510</span> * @return the value/first value of this Option or <a name="line.510"></a> -<span class="sourceLineNo">511</span> * <code>null</code> if there is no value.<a name="line.511"></a> -<span class="sourceLineNo">512</span> */<a name="line.512"></a> -<span class="sourceLineNo">513</span> public String getValue()<a name="line.513"></a> -<span class="sourceLineNo">514</span> {<a name="line.514"></a> -<span class="sourceLineNo">515</span> return hasNoValues() ? null : values.get(0);<a name="line.515"></a> -<span class="sourceLineNo">516</span> }<a name="line.516"></a> -<span class="sourceLineNo">517</span><a name="line.517"></a> -<span class="sourceLineNo">518</span> /**<a name="line.518"></a> -<span class="sourceLineNo">519</span> * Returns the specified value of this Option or <a name="line.519"></a> +<span class="sourceLineNo">486</span> // get new index<a name="line.486"></a> +<span class="sourceLineNo">487</span> index = value.indexOf(sep);<a name="line.487"></a> +<span class="sourceLineNo">488</span> }<a name="line.488"></a> +<span class="sourceLineNo">489</span> }<a name="line.489"></a> +<span class="sourceLineNo">490</span><a name="line.490"></a> +<span class="sourceLineNo">491</span> // store the actual value or the last value that has been parsed<a name="line.491"></a> +<span class="sourceLineNo">492</span> add(value);<a name="line.492"></a> +<span class="sourceLineNo">493</span> }<a name="line.493"></a> +<span class="sourceLineNo">494</span><a name="line.494"></a> +<span class="sourceLineNo">495</span> /**<a name="line.495"></a> +<span class="sourceLineNo">496</span> * Add the value to this Option. If the number of arguments<a name="line.496"></a> +<span class="sourceLineNo">497</span> * is greater than zero and there is enough space in the list then<a name="line.497"></a> +<span class="sourceLineNo">498</span> * add the value. Otherwise, throw a runtime exception.<a name="line.498"></a> +<span class="sourceLineNo">499</span> *<a name="line.499"></a> +<span class="sourceLineNo">500</span> * @param value The value to be added to this Option<a name="line.500"></a> +<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">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> +<span class="sourceLineNo">508</span> throw new RuntimeException("Cannot add value, list full.");<a name="line.508"></a> +<span class="sourceLineNo">509</span> }<a name="line.509"></a> +<span class="sourceLineNo">510</span><a name="line.510"></a> +<span class="sourceLineNo">511</span> // store value<a name="line.511"></a> +<span class="sourceLineNo">512</span> values.add(value);<a name="line.512"></a> +<span class="sourceLineNo">513</span> }<a name="line.513"></a> +<span class="sourceLineNo">514</span><a name="line.514"></a> +<span class="sourceLineNo">515</span> /**<a name="line.515"></a> +<span class="sourceLineNo">516</span> * Returns the specified value of this Option or <a name="line.516"></a> +<span class="sourceLineNo">517</span> * <code>null</code> if there is no value.<a name="line.517"></a> +<span class="sourceLineNo">518</span> *<a name="line.518"></a> +<span class="sourceLineNo">519</span> * @return the value/first value of this Option or <a name="line.519"></a> <span class="sourceLineNo">520</span> * <code>null</code> if there is no value.<a name="line.520"></a> -<span class="sourceLineNo">521</span> *<a name="line.521"></a> -<span class="sourceLineNo">522</span> * @param index The index of the value to be returned.<a name="line.522"></a> -<span class="sourceLineNo">523</span> *<a name="line.523"></a> -<span class="sourceLineNo">524</span> * @return the specified value of this Option or <a name="line.524"></a> -<span class="sourceLineNo">525</span> * <code>null</code> if there is no value.<a name="line.525"></a> -<span class="sourceLineNo">526</span> *<a name="line.526"></a> -<span class="sourceLineNo">527</span> * @throws IndexOutOfBoundsException if index is less than 1<a name="line.527"></a> -<span class="sourceLineNo">528</span> * or greater than the number of the values for this Option.<a name="line.528"></a> -<span class="sourceLineNo">529</span> */<a name="line.529"></a> -<span class="sourceLineNo">530</span> public String getValue(int index) throws IndexOutOfBoundsException<a name="line.530"></a> -<span class="sourceLineNo">531</span> {<a name="line.531"></a> -<span class="sourceLineNo">532</span> return hasNoValues() ? null : values.get(index);<a name="line.532"></a> -<span class="sourceLineNo">533</span> }<a name="line.533"></a> -<span class="sourceLineNo">534</span><a name="line.534"></a> -<span class="sourceLineNo">535</span> /**<a name="line.535"></a> -<span class="sourceLineNo">536</span> * Returns the value/first value of this Option or the <a name="line.536"></a> -<span class="sourceLineNo">537</span> * <code>defaultValue</code> if there is no value.<a name="line.537"></a> -<span class="sourceLineNo">538</span> *<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @param defaultValue The value to be returned if there<a name="line.539"></a> -<span class="sourceLineNo">540</span> * is no value.<a name="line.540"></a> -<span class="sourceLineNo">541</span> *<a name="line.541"></a> -<span class="sourceLineNo">542</span> * @return the value/first value of this Option or the <a name="line.542"></a> -<span class="sourceLineNo">543</span> * <code>defaultValue</code> if there are no values.<a name="line.543"></a> -<span class="sourceLineNo">544</span> */<a name="line.544"></a> -<span class="sourceLineNo">545</span> public String getValue(String defaultValue)<a name="line.545"></a> -<span class="sourceLineNo">546</span> {<a name="line.546"></a> -<span class="sourceLineNo">547</span> String value = getValue();<a name="line.547"></a> -<span class="sourceLineNo">548</span><a name="line.548"></a> -<span class="sourceLineNo">549</span> return (value != null) ? value : defaultValue;<a name="line.549"></a> -<span class="sourceLineNo">550</span> }<a name="line.550"></a> -<span class="sourceLineNo">551</span><a name="line.551"></a> -<span class="sourceLineNo">552</span> /**<a name="line.552"></a> -<span class="sourceLineNo">553</span> * Return the values of this Option as a String array <a name="line.553"></a> -<span class="sourceLineNo">554</span> * or null if there are no values<a name="line.554"></a> -<span class="sourceLineNo">555</span> *<a name="line.555"></a> -<span class="sourceLineNo">556</span> * @return the values of this Option as a String array <a name="line.556"></a> -<span class="sourceLineNo">557</span> * or null if there are no values<a name="line.557"></a> -<span class="sourceLineNo">558</span> */<a name="line.558"></a> -<span class="sourceLineNo">559</span> public String[] getValues()<a name="line.559"></a> -<span class="sourceLineNo">560</span> {<a name="line.560"></a> -<span class="sourceLineNo">561</span> return hasNoValues() ? null : values.toArray(new String[values.size()]);<a name="line.561"></a> -<span class="sourceLineNo">562</span> }<a name="line.562"></a> -<span class="sourceLineNo">563</span><a name="line.563"></a> -<span class="sourceLineNo">564</span> /**<a name="line.564"></a> -<span class="sourceLineNo">565</span> * @return the values of this Option as a List<a name="line.565"></a> +<span class="sourceLineNo">521</span> */<a name="line.521"></a> +<span class="sourceLineNo">522</span> public String getValue()<a name="line.522"></a> +<span class="sourceLineNo">523</span> {<a name="line.523"></a> +<span class="sourceLineNo">524</span> return hasNoValues() ? null : values.get(0);<a name="line.524"></a> +<span class="sourceLineNo">525</span> }<a name="line.525"></a> +<span class="sourceLineNo">526</span><a name="line.526"></a> +<span class="sourceLineNo">527</span> /**<a name="line.527"></a> +<span class="sourceLineNo">528</span> * Returns the specified value of this Option or <a name="line.528"></a> +<span class="sourceLineNo">529</span> * <code>null</code> if there is no value.<a name="line.529"></a> +<span class="sourceLineNo">530</span> *<a name="line.530"></a> +<span class="sourceLineNo">531</span> * @param index The index of the value to be returned.<a name="line.531"></a> +<span class="sourceLineNo">532</span> *<a name="line.532"></a> +<span class="sourceLineNo">533</span> * @return the specified value of this Option or <a name="line.533"></a> +<span class="sourceLineNo">534</span> * <code>null</code> if there is no value.<a name="line.534"></a> +<span class="sourceLineNo">535</span> *<a name="line.535"></a> +<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">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> +<span class="sourceLineNo">543</span><a name="line.543"></a> +<span class="sourceLineNo">544</span> /**<a name="line.544"></a> +<span class="sourceLineNo">545</span> * Returns the value/first value of this Option or the <a name="line.545"></a> +<span class="sourceLineNo">546</span> * <code>defaultValue</code> if there is no value.<a name="line.546"></a> +<span class="sourceLineNo">547</span> *<a name="line.547"></a> +<span class="sourceLineNo">548</span> * @param defaultValue The value to be returned if there<a name="line.548"></a> +<span class="sourceLineNo">549</span> * is no value.<a name="line.549"></a> +<span class="sourceLineNo">550</span> *<a name="line.550"></a> +<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> * <code>defaultValue</code> 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">555</span> {<a name="line.555"></a> +<span class="sourceLineNo">556</span> 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> +<span class="sourceLineNo">560</span><a name="line.560"></a> +<span class="sourceLineNo">561</span> /**<a name="line.561"></a> +<span class="sourceLineNo">562</span> * Return the values of this Option as a String array <a name="line.562"></a> +<span class="sourceLineNo">563</span> * or null if there are no values<a name="line.563"></a> +<span class="sourceLineNo">564</span> *<a name="line.564"></a> +<span class="sourceLineNo">565</span> * @return the values of this Option as a String array <a name="line.565"></a> <span class="sourceLineNo">566</span> * or null if there are no values<a name="line.566"></a> <span class="sourceLineNo">567</span> */<a name="line.567"></a> -<span class="sourceLineNo">568</span> public List<String> getValuesList()<a name="line.568"></a> +<span class="sourceLineNo">568</span> public String[] getValues()<a name="line.568"></a> <span class="sourceLineNo">569</span> {<a name="line.569"></a> -<span class="sourceLineNo">570</span> return values;<a name="line.570"></a> +<span class="sourceLineNo">570</span> return hasNoValues() ? null : values.toArray(new String[values.size()]);<a name="line.570"></a> <span class="sourceLineNo">571</span> }<a name="line.571"></a> <span class="sourceLineNo">572</span><a name="line.572"></a> -<span class="sourceLineNo">573</span> /** <a name="line.573"></a> -<span class="sourceLineNo">574</span> * Dump state, suitable for debugging.<a name="line.574"></a> -<span class="sourceLineNo">575</span> *<a name="line.575"></a> -<span class="sourceLineNo">576</span> * @return Stringified form of this object<a name="line.576"></a> -<span class="sourceLineNo">577</span> */<a name="line.577"></a> -<span class="sourceLineNo">578</span> @Override<a name="line.578"></a> -<span class="sourceLineNo">579</span> public String toString()<a name="line.579"></a> -<span class="sourceLineNo">580</span> {<a name="line.580"></a> -<span class="sourceLineNo">581</span> StringBuilder buf = new StringBuilder().append("[ option: ");<a name="line.581"></a> -<span class="sourceLineNo">582</span><a name="line.582"></a> -<span class="sourceLineNo">583</span> buf.append(opt);<a name="line.583"></a> -<span class="sourceLineNo">584</span><a name="line.584"></a> -<span class="sourceLineNo">585</span> if (longOpt != null)<a name="line.585"></a> -<span class="sourceLineNo">586</span> {<a name="line.586"></a> -<span class="sourceLineNo">587</span> buf.append(" ").append(longOpt);<a name="line.587"></a> -<span class="sourceLineNo">588</span> }<a name="line.588"></a> -<span class="sourceLineNo">589</span><a name="line.589"></a> -<span class="sourceLineNo">590</span> buf.append(" ");<a name="line.590"></a> +<span class="sourceLineNo">573</span> /**<a name="line.573"></a> +<span class="sourceLineNo">574</span> * @return the values of this Option as a List<a name="line.574"></a> +<span class="sourceLineNo">575</span> * or null if there are no values<a name="line.575"></a> +<span class="sourceLineNo">576</span> */<a name="line.576"></a> +<span class="sourceLineNo">577</span> public List<String> getValuesList()<a name="line.577"></a> +<span class="sourceLineNo">578</span> {<a name="line.578"></a> +<span class="sourceLineNo">579</span> return values;<a name="line.579"></a> +<span class="sourceLineNo">580</span> }<a name="line.580"></a> +<span class="sourceLineNo">581</span><a name="line.581"></a> +<span class="sourceLineNo">582</span> /** <a name="line.582"></a> +<span class="sourceLineNo">583</span> * Dump state, suitable for debugging.<a name="line.583"></a> +<span class="sourceLineNo">584</span> *<a name="line.584"></a> +<span class="sourceLineNo">585</span> * @return Stringified form of this object<a name="line.585"></a> +<span class="sourceLineNo">586</span> */<a name="line.586"></a> +<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">591</span><a name="line.591"></a> -<span class="sourceLineNo">592</span> if (hasArgs())<a name="line.592"></a> -<span class="sourceLineNo">593</span> {<a name="line.593"></a> -<span class="sourceLineNo">594</span> buf.append("[ARG...]");<a name="line.594"></a> -<span class="sourceLineNo">595</span> }<a name="line.595"></a> -<span class="sourceLineNo">596</span> else if (hasArg())<a name="line.596"></a> -<span class="sourceLineNo">597</span> {<a name="line.597"></a> -<span class="sourceLineNo">598</span> buf.append(" [ARG]");<a name="line.598"></a> -<span class="sourceLineNo">599</span> }<a name="line.599"></a> +<span class="sourceLineNo">592</span> buf.append(opt);<a name="line.592"></a> +<span class="sourceLineNo">593</span><a name="line.593"></a> +<span class="sourceLineNo">594</span> if (longOpt != null)<a name="line.594"></a> +<span class="sourceLineNo">595</span> {<a name="line.595"></a> +<span class="sourceLineNo">596</span> buf.append(" ").append(longOpt);<a name="line.596"></a> +<span class="sourceLineNo">597</span> }<a name="line.597"></a> +<span class="sourceLineNo">598</span><a name="line.598"></a> +<span class="sourceLineNo">599</span> buf.append(" ");<a name="line.599"></a> <span class="sourceLineNo">600</span><a name="line.600"></a> -<span class="sourceLineNo">601</span> buf.append(" :: ").append(description);<a name="line.601"></a> -<span class="sourceLineNo">602</span><a name="line.602"></a> -<span class="sourceLineNo">603</span> if (type != null)<a name="line.603"></a> -<span class="sourceLineNo">604</span> {<a name="line.604"></a> -<span class="sourceLineNo">605</span> buf.append(" :: ").append(type);<a name="line.605"></a> -<span class="sourceLineNo">606</span> }<a name="line.606"></a> -<span class="sourceLineNo">607</span><a name="line.607"></a> -<span class="sourceLineNo">608</span> buf.append(" ]");<a name="line.608"></a> +<span class="sourceLineNo">601</span> if (hasArgs())<a name="line.601"></a> +<span class="sourceLineNo">602</span> {<a name="line.602"></a> +<span class="sourceLineNo">603</span> buf.append("[ARG...]");<a name="line.603"></a> +<span class="sourceLineNo">604</span> }<a name="line.604"></a> +<span class="sourceLineNo">605</span> else if (hasArg())<a name="line.605"></a> +<span class="sourceLineNo">606</span> {<a name="line.606"></a> +<span class="sourceLineNo">607</span> buf.append(" [ARG]");<a name="line.607"></a> +<span class="sourceLineNo">608</span> }<a name="line.608"></a> <span class="sourceLineNo">609</span><a name="line.609"></a> -<span class="sourceLineNo">610</span> return buf.toString();<a name="line.610"></a> -<span class="sourceLineNo">611</span> }<a name="line.611"></a> -<span class="sourceLineNo">612</span><a name="line.612"></a> -<span class="sourceLineNo">613</span> /**<a name="line.613"></a> -<span class="sourceLineNo">614</span> * Returns whether this Option has any values.<a name="line.614"></a> -<span class="sourceLineNo">615</span> *<a name="line.615"></a> -<span class="sourceLineNo">616</span> * @return whether this Option has any values.<a name="line.616"></a> -<span class="sourceLineNo">617</span> */<a name="line.617"></a> -<span class="sourceLineNo">618</span> private boolean hasNoValues()<a name="line.618"></a> -<span class="sourceLineNo">619</span> {<a name="line.619"></a> -<span class="sourceLineNo">620</span> return values.isEmpty();<a name="line.620"></a> -<span class="sourceLineNo">621</span> }<a name="line.621"></a> -<span class="sourceLineNo">622</span><a name="line.622"></a> -<span class="sourceLineNo">623</span> @Override<a name="line.623"></a> -<span class="sourceLineNo">624</span> public boolean equals(Object o)<a name="line.624"></a> -<span class="sourceLineNo">625</span> {<a name="line.625"></a> -<span class="sourceLineNo">626</span> if (this == o)<a name="line.626"></a> -<span class="sourceLineNo">627</span> {<a name="line.627"></a> -<span class="sourceLineNo">628</span> return true;<a name="line.628"></a> -<span class="sourceLineNo">629</span> }<a name="line.629"></a> -<span class="sourceLineNo">630</span> if (o == null || getClass() != o.getClass())<a name="line.630"></a> -<span class="sourceLineNo">631</span> {<a name="line.631"></a> -<span class="sourceLineNo">632</span> return false;<a name="line.632"></a> -<span class="sourceLineNo">633</span> }<a name="line.633"></a> -<span class="sourceLineNo">634</span><a name="line.634"></a> -<span class="sourceLineNo">635</span> Option option = (Option) o;<a name="line.635"></a> -<span class="sourceLineNo">636</span><a name="line.636"></a> -<span class="sourceLineNo">637</span><a name="line.637"></a> -<span class="sourceLineNo">638</span> if (opt != null ? !opt.equals(option.opt) : option.opt != null)<a name="line.638"></a> -<span class="sourceLineNo">639</span> {<a name="line.639"></a> -<span class="sourceLineNo">640</span> return false;<a name="line.640"></a> -<span class="sourceLineNo">641</span> }<a name="line.641"></a> -<span class="sourceLineNo">642</span> if (longOpt != null ? !longOpt.equals(option.longOpt) : option.longOpt != null)<a name="line.642"></a> -<span class="sourceLineNo">643</span> {<a name="line.643"></a> -<span class="sourceLineNo">644</span> return false;<a name="line.644"></a> -<span class="sourceLineNo">645</span> }<a name="line.645"></a> +<span class="sourceLineNo">610</span> buf.append(" :: ").append(description);<a name="line.610"></a> +<span class="sourceLineNo">611</span><a name="line.611"></a> +<span class="sourceLineNo">612</span> if (type != null)<a name="line.612"></a> +<span class="sourceLineNo">613</span> {<a name="line.613"></a> +<span class="sourceLineNo">614</span> buf.append(" :: ").append(type);<a name="line.614"></a> +<span class="sourceLineNo">615</span> }<a name="line.615"></a> +<span class="sourceLineNo">616</span><a name="line.616"></a> +<span class="sourceLineNo">617</span> buf.append(" ]");<a name="line.617"></a> +<span class="sourceLineNo">618</span><a name="line.618"></a> +<span class="sourceLineNo">619</span> return buf.toString();<a name="line.619"></a> +<span class="sourceLineNo">620</span> }<a name="line.620"></a> +<span class="sourceLineNo">621</span><a name="line.621"></a> +<span class="sourceLineNo">622</span> /**<a name="line.622"></a> +<span class="sourceLineNo">623</span> * Returns whether this Option has any values.<a name="line.623"></a> +<span class="sourceLineNo">624</span> *<a name="line.624"></a> +<span class="sourceLineNo">625</span> * @return whether this Option has any values.<a name="line.625"></a> +<span class="sourceLineNo">626</span> */<a name="line.626"></a> +<span class="sourceLineNo">627</span> private boolean hasNoValues()<a name="line.627"></a> +<span class="sourceLineNo">628</span> {<a name="line.628"></a> +<span class="sourceLineNo">629</span> return values.isEmpty();<a name="line.629"></a> +<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">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> +<span class="sourceLineNo">637</span> return true;<a name="line.637"></a> +<span class="sourceLineNo">638</span> }<a name="line.638"></a> +<span class="sourceLineNo">639</span> if (o == null || getClass() != o.getClass())<a name="line.639"></a> +<span class="sourceLineNo">640</span> {<a name="line.640"></a> +<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">645</span><a name="line.645"></a> <span class="sourceLineNo">646</span><a name="line.646"></a> -<span class="sourceLineNo">647</span> return true;<a name="line.647"></a> -<span class="sourceLineNo">648</span> }<a name="line.648"></a> -<span class="sourceLineNo">649</span><a name="line.649"></a> -<span class="sourceLineNo">650</span> @Override<a name="line.650"></a> -<span class="sourceLineNo">651</span> public int hashCode()<a name="line.651"></a> -<span class="sourceLineNo">652</span> {<a name="line.652"></a> -<span class="sourceLineNo">653</span> int result;<a name="line.653"></a> -<span class="sourceLineNo">654</span> result = opt != null ? opt.hashCode() : 0;<a name="line.654"></a> -<span class="sourceLineNo">655</span> result = 31 * result + (longOpt != null ? longOpt.hashCode() : 0);<a name="line.655"></a> -<span class="sourceLineNo">656</span> return result;<a name="line.656"></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> /**<a name="line.659"></a> -<span class="sourceLineNo">660</span> * A rather odd clone method - due to incorrect code in 1.0 it is public <a name="line.660"></a> -<span class="sourceLineNo">661</span> * and in 1.1 rather than throwing a CloneNotSupportedException it throws <a name="line.661"></a> -<span class="sourceLineNo">662</span> * a RuntimeException so as to maintain backwards compat at the API level. <a name="line.662"></a> -<span class="sourceLineNo">663</span> *<a name="line.663"></a> -<span class="sourceLineNo">664</span> * After calling this method, it is very likely you will want to call <a name="line.664"></a> -<span class="sourceLineNo">665</span> * clearValues(). <a name="line.665"></a> -<span class="sourceLineNo">666</span> *<a name="line.666"></a> -<span class="sourceLineNo">667</span> * @return a clone of this Option instance<a name="line.667"></a> -<span class="sourceLineNo">668</span> * @throws RuntimeException if a {@link CloneNotSupportedException} has been thrown<a name="line.668"></a> -<span class="sourceLineNo">669</span> * by {@code super.clone()}<a name="line.669"></a> -<span class="sourceLineNo">670</span> */<a name="line.670"></a> -<span class="sourceLineNo">671</span> @Override<a name="line.671"></a> -<span class="sourceLineNo">672</span> public Object clone()<a name="line.672"></a> -<span class="sourceLineNo">673</span> {<a name="line.673"></a> -<span class="sourceLineNo">674</span> try<a name="line.674"></a> -<span class="sourceLineNo">675</span> {<a name="line.675"></a> -<span class="sourceLineNo">676</span> Option option = (Option) super.clone();<a name="line.676"></a> -<span class="sourceLineNo">677</span> option.values = new ArrayList<String>(values);<a name="line.677"></a> -<span class="sourceLineNo">678</span> return option;<a name="line.678"></a> -<span class="sourceLineNo">679</span> }<a name="line.679"></a> -<span class="sourceLineNo">680</span> catch (CloneNotSupportedException cnse)<a name="line.680"></a> -<span class="sourceLineNo">681</span> {<a name="line.681"></a> -<span class="sourceLineNo">682</span> throw new RuntimeException("A CloneNotSupportedException was thrown: " + cnse.getMessage());<a name="line.682"></a> -<span class="sourceLineNo">683</span> }<a name="line.683"></a> -<span class="sourceLineNo">684</span> }<a name="line.684"></a> -<span class="sourceLineNo">685</span><a name="line.685"></a> -<span class="sourceLineNo">686</span> /**<a name="line.686"></a> -<span class="sourceLineNo">687</span> * Clear the Option values. After a parse is complete, these are left with<a name="line.687"></a> -<span class="sourceLineNo">688</span> * data in them and they need clearing if another parse is done.<a name="line.688"></a> -<span class="sourceLineNo">689</span> *<a name="line.689"></a> -<span class="sourceLineNo">690</span> * See: <a href="https://issues.apache.org/jira/browse/CLI-71">CLI-71</a><a name="line.690"></a> -<span class="sourceLineNo">691</span> */<a name="line.691"></a> -<span class="sourceLineNo">692</span> void clearValues()<a name="line.692"></a> -<span class="sourceLineNo">693</span> {<a name="line.693"></a> -<span class="sourceLineNo">694</span> values.clear();<a name="line.694"></a> -<span class="sourceLineNo">695</span> }<a name="line.695"></a> -<span class="sourceLineNo">696</span><a name="line.696"></a> -<span class="sourceLineNo">697</span> /**<a name="line.697"></a> -<span class="sourceLineNo">698</span> * This method is not intended to be used. It was a piece of internal <a name="line.698"></a> -<span class="sourceLineNo">699</span> * API that was made public in 1.0. It currently throws an UnsupportedOperationException.<a name="line.699"></a> -<span class="sourceLineNo">700</span> *<a name="line.700"></a> -<span class="sourceLineNo">701</span> * @param value the value to add<a name="line.701"></a> -<span class="sourceLineNo">702</span> * @return always throws an {@link UnsupportedOperationException}<a name="line.702"></a> -<span class="sourceLineNo">703</span> * @throws UnsupportedOperationException always<a name="line.703"></a> -<span class="sourceLineNo">704</span> * @deprecated<a name="line.704"></a> -<span class="sourceLineNo">705</span> */<a name="line.705"></a> -<span class="sourceLineNo">706</span> @Deprecated<a name="line.706"></a> -<span class="sourceLineNo">707</span> public boolean addValue(String value)<a name="line.707"></a> -<span class="sourceLineNo">708</span> {<a name="line.708"></a> -<span class="sourceLineNo">709</span> throw new UnsupportedOperationException("The addValue method is not intended for client use. "<a name="line.709"></a> -<span class="sourceLineNo">710</span> + "Subclasses should use the addValueForProcessing method instead. ");<a name="line.710"></a> -<span class="sourceLineNo">711</span> }<a name="line.711"></a> -<span class="sourceLineNo">712</span><a name="line.712"></a> -<span class="sourceLineNo">713</span> /**<a name="line.713"></a> -<span class="sourceLineNo">714</span> * Tells if the option can accept more arguments.<a name="line.714"></a> -<span class="sourceLineNo">715</span> * <a name="line.715"></a> -<span class="sourceLineNo">716</span> * @return false if the maximum number of arguments is reached<a name="line.716"></a> -<span class="sourceLineNo">717</span> * @since 1.3<a name="line.717"></a> -<span class="sourceLineNo">718</span> */<a name="line.718"></a> -<span class="sourceLineNo">719</span> boolean acceptsArg()<a name="line.719"></a> -<span class="sourceLineNo">720</span> {<a name="line.720"></a> -<span class="sourceLineNo">721</span> return (hasArg() || hasArgs() || hasOptionalArg()) && (numberOfArgs <= 0 || values.size() < numberOfArgs);<a name="line.721"></a> -<span class="sourceLineNo">722</span> }<a name="line.722"></a> -<span class="sourceLineNo">723</span><a name="line.723"></a> -<span class="sourceLineNo">724</span> /**<a name="line.724"></a> -<span class="sourceLineNo">725</span> * Tells if the option requires more arguments to be valid.<a name="line.725"></a> -<span class="sourceLineNo">726</span> * <a name="line.726"></a> -<span class="sourceLineNo">727</span> * @return false if the option doesn't require more arguments<a name="line.727"></a> -<span class="sourceLineNo">728</span> * @since 1.3<a name="line.728"></a> -<span class="sourceLineNo">729</span> */<a name="line.729"></a> -<span class="sourceLineNo">730</span> boolean requiresArg()<a name="line.730"></a> -<span class="sourceLineNo">731</span> {<a name="line.731"></a> -<span class="sourceLineNo">732</span> if (optionalArg)<a name="line.732"></a> -<span class="sourceLineNo">733</span> {<a name="line.733"></a> -<span class="sourceLineNo">734</span> return false;<a name="line.734"></a> -<span class="sourceLineNo">735</span> }<a name="line.735"></a> -<span class="sourceLineNo">736</span> if (numberOfArgs == UNLIMITED_VALUES)<a name="line.736"></a> -<span class="sourceLineNo">737</span> {<a name="line.737"></a> -<span class="sourceLineNo">738</span> return values.isEmpty();<a name="line.738"></a> -<span class="sourceLineNo">739</span> }<a name="line.739"></a> -<span class="sourceLineNo">740</span> return acceptsArg();<a name="line.740"></a> -<span class="sourceLineNo">741</span> }<a name="line.741"></a> -<span class="sourceLineNo">742</span> <a name="line.742"></a> -<span class="sourceLineNo">743</span> /**<a name="line.743"></a> -<span class="sourceLineNo">744</span> * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.744"></a> -<span class="sourceLineNo">745</span> * methods. <a name="line.745"></a> -<span class="sourceLineNo">746</span> * <a name="line.746"></a> -<span class="sourceLineNo">747</span> * @return a new {@link Builder} instance<a name="line.747"></a> -<span class="sourceLineNo">748</span> * @since 1.3<a name="line.748"></a> -<span class="sourceLineNo">749</span> */<a name="line.749"></a> -<span class="sourceLineNo">750</span> public static Builder builder()<a name="line.750"></a> -<span class="sourceLineNo">751</span> {<a name="line.751"></a> -<span class="sourceLineNo">752</span> return builder(null);<a name="line.752"></a> -<span class="sourceLineNo">753</span> }<a name="line.753"></a> -<span class="sourceLineNo">754</span> <a name="line.754"></a> -<span class="sourceLineNo">755</span> /**<a name="line.755"></a> -<span class="sourceLineNo">756</span> * Returns a {@link Builder} to create an {@link Option} using descriptive<a name="line.756"></a> -<span class="sourceLineNo">757</span> * methods. <a name="line.757"></a> -<span class="sourceLineNo">758</span> *<a name="line.758"></a> -<span class="sourceLineNo">759</span> * @param opt short representation of the option<a name="line.759"></a> -<span class="sourceLineNo">760</span> * @return a new {@link Builder} instance<a name="line.760"></a> -<span class="sourceLineNo">761</span> * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.761"></a> -<span class="sourceLineNo">762</span> * @since 1.3<a name="line.762"></a> -<span class="sourceLineNo">763</span> */<a name="line.763"></a> -<span class="sourceLineNo">764</span> public static Builder builder(final String opt)<a name="line.764"></a> -<span class="sourceLineNo">765</span> {<a name="line.765"></a> -<span class="sourceLineNo">766</span> return new Builder(opt);<a name="line.766"></a> -<span class="sourceLineNo">767</span> }<a name="line.767"></a> -<span class="sourceLineNo">768</span> <a name="line.768"></a> -<span class="sourceLineNo">769</span> /**<a name="line.769"></a> -<span class="sourceLineNo">770</span> * A nested builder class to create <code>Option</code> instances<a name="line.770"></a> -<span class="sourceLineNo">771</span> * using descriptive methods.<a name="line.771"></a> -<span class="sourceLineNo">772</span> * <p><a name="line.772"></a> -<span class="sourceLineNo">773</span> * Example usage:<a name="line.773"></a> -<span class="sourceLineNo">774</span> * <pre><a name="line.774"></a> -<span class="sourceLineNo">775</span> * Option option = Option.builder("a")<a name="line.775"></a> -<span class="sourceLineNo">776</span> * .required(true)<a name="line.776"></a> -<span class="sourceLineNo">777</span> * .longOpt("arg-name")<a name="line.777"></a> -<span class="sourceLineNo">778</span> * .build();<a name="line.778"></a> -<span class="sourceLineNo">779</span> * </pre><a name="line.779"></a> -<span class="sourceLineNo">780</span> * <a name="line.780"></a> -<span class="sourceLineNo">781</span> * @since 1.3<a name="line.781"></a> -<span class="sourceLineNo">782</span> */<a name="line.782"></a> -<span class="sourceLineNo">783</span> public static final class Builder <a name="line.783"></a> -<span class="sourceLineNo">784</span> {<a name="line.784"></a> -<span class="sourceLineNo">785</span> /** the name of the option */<a name="line.785"></a> -<span class="sourceLineNo">786</span> private final String opt;<a name="line.786"></a> -<span class="sourceLineNo">787</span><a name="line.787"></a> -<span class="sourceLineNo">788</span> /** description of the option */<a name="line.788"></a> -<span class="sourceLineNo">789</span> private String description;<a name="line.789"></a> -<span class="sourceLineNo">790</span><a name="line.790"></a> -<span class="sourceLineNo">791</span> /** the long representation of the option */<a name="line.791"></a> -<span class="sourceLineNo">792</span> private String longOpt;<a name="line.792"></a> -<span class="sourceLineNo">793</span><a name="line.793"></a> -<span class="sourceLineNo">794</span> /** the name of the argument for this option */<a name="line.794"></a> -<span class="sourceLineNo">795</span> private String argName;<a name="line.795"></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<String>(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: <a href="https://issues.apache.org/jira/browse/CLI-71">CLI-71</a><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()) && (numberOfArgs <= 0 || values.size() < 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 <code>Option</code> instances<a name="line.779"></a> +<span class="sourceLineNo">780</span> * using descriptive methods.<a name="line.780"></a> +<span class="sourceLineNo">781</span> * <p><a name="line.781"></a> +<span class="sourceLineNo">782</span> * Example usage:<a name="line.782"></a> +<span class="sourceLineNo">783</span> * <pre><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> * </pre><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> /** specifies whether this option is required to be present */<a name="line.797"></a> -<span class="sourceLineNo">798</span> private boolean required;<a name="line.798"></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> /** specifies whether the argument value of this Option is optional */<a name="line.800"></a> -<span class="sourceLineNo">801</span> private boolean optionalArg;<a name="line.801"></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 number of argument values this option can have */<a name="line.803"></a> -<span class="sourceLineNo">804</span> private int numberOfArgs = UNINITIALIZED;<a name="line.804"></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> /** the type of this Option */<a name="line.806"></a> -<span class="sourceLineNo">807</span> private Class<?> type = String.class;<a name="line.807"></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> /** the character that is the value separator */<a name="line.809"></a> -<span class="sourceLineNo">810</span> private char valuesep;<a name="line.810"></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> /**<a name="line.812"></a> -<span class="sourceLineNo">813</span> * Constructs a new <code>Builder</code> with the minimum<a name="line.813"></a> -<span class="sourceLineNo">814</span> * required parameters for an <code>Option</code> instance.<a name="line.814"></a> -<span class="sourceLineNo">815</span> * <a name="line.815"></a> -<span class="sourceLineNo">816</span> * @param opt short representation of the option<a name="line.816"></a> -<span class="sourceLineNo">817</span> * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt}<a name="line.817"></a> -<span class="sourceLineNo">818</span> */<a name="line.818"></a> -<span class="sourceLineNo">819</span> private Builder(final String opt) throws IllegalArgumentException<a name="line.819"></a> -<span class="sourceLineNo">820</span> {<a name="line.820"></a> -<span class="sourceLineNo">821</span> OptionValidator.validateOption(opt);<a name="line.821"></a> -<span class="sourceLineNo">822</span> this.opt = opt;<a name="line.822"></a> -<span class="sourceLineNo">823</span> }<a name="line.823"></a> -<span class="sourceLineNo">824</span> <a name="line.824"></a> -<span class="sourceLineNo">825</span> /**<a name="line.825"></a> -<span class="sourceLineNo">826</span> * Sets the display name for the argument value.<a name="line.826"></a> -<span class="sourceLineNo">827</span> *<a name="line.827"></a> -<span class="sourceLineNo">828</span> * @param argName the display name for the argument value.<a name="line.828"></a> -<span class="sourceLineNo">829</span> * @return this builder, to allow method chaining<a name="line.829"></a> -<span class="sourceLineNo">830</span> */<a name="line.830"></a> -<span class="sourceLineNo">831</span> public Builder argName(final String argName)<a name="line.831"></a> -<span class="sourceLineNo">832</span> {<a name="line.832"></a> -<span class="sourceLineNo">833</span> this.argName = argName;<a name="line.833"></a> -<span class="sourceLineNo">834</span> return this;<a name="line.834"></a> -<span class="sourceLineNo">835</span> }<a name="line.835"></a> -<span class="sourceLineNo">836</span><a name="line.836"></a> -<span class="sourceLineNo">837</span> /**<a name="line.837"></a> -<span class="sourceLineNo">838</span> * Sets the description for this option.<a name="line.838"></a> -<span class="sourceLineNo">839</span> *<a name="line.839"></a> -<span class="sourceLineNo">840</span> * @param description the description of the option.<a name="line.840"></a> -<span class="sourceLineNo">841</span> * @return this builder, to allow method chaining<a name="line.841"></a> -<span class="sourceLineNo">842</span> */<a name="line.842"></a> -<span class="sourceLineNo">843</span> public Builder desc(final String description)<a name="line.843"></a> -<span class="sourceLineNo">844</span> {<a name="line.844"></a> -<span class="sourceLineNo">845</span> this.description = description;<a name="line.845"></a> -<span class="sourceLineNo">846</span> return this;<a name="line.846"></a> -<span class="sourceLineNo">847</span> }<a name="line.847"></a> -<span class="sourceLineNo">848</span><a name="line.848"></a> -<span class="sourceLineNo">849</span> /**<a name="line.849"></a> -<span class="sourceLineNo">850</span> * Sets the long name of the Option.<a name="line.850"></a> -<span class="sourceLineNo">851</span> *<a name="line.851"></a> -<span class="sourceLineNo">852</span> * @param longOpt the long name of the Option<a name="line.852"></a> -<span class="sourceLineNo">853</span> * @return this builder, to allow method chaining<a name="line.853"></a> -<span class="sourceLineNo">854</span> */ <a name="line.854"></a> -<span class="sourceLineNo">855</span> public Builder longOpt(final String longOpt)<a name="line.855"></a> -<span class="sourceLineNo">856</span> {<a name="line.856"></a> -<span class="sourceLineNo">857</span> this.longOpt = longOpt;<a name="line.857"></a> -<span class="sourceLineNo">858</span> return this;<a name="line.858"></a> -<span class="sourceLineNo">859</span> }<a name="line.859"></a> -<span class="sourceLineNo">860</span> <a name="line.860"></a> -<span class="sourceLineNo">861</span> /** <a name="line.861"></a> -<span class="sourceLineNo">862</span> * Sets the number of argument values the Option can take.<a name="line.862"></a> -<span class="sourceLineNo">863</span> *<a name="line.863"></a> -<span class="sourceLineNo">864</span> * @param numberOfArgs the number of argument values<a name="line.864"></a> -<span class="sourceLineNo">865</span> * @return this builder, to allow method chaining<a name="line.865"></a> -<span class="sourceLineNo">866</span> */ <a name="line.866"></a> -<span class="sourceLineNo">867</span> public Builder numberOfArgs(final int numberOfArgs)<a name="line.867"></a> -<span class="sourceLineNo">868</span> {<a name="line.868"></a> -<span class="sourceLineNo">869</span> this.numberOfArgs = numberOfArgs;<a name="line.869"></a> -<span class="sourceLineNo">870</span> return this;<a name="line.870"></a> -<span class="sourceLineNo">871</span> }<a name="line.871"></a> -<span class="sourceLineNo">872</span> <a name="line.872"></a> -<span class="sourceLineNo">873</span> /**<a name="line.873"></a> -<span class="sourceLineNo">874</span> * Sets whether the Option can have an optional argument.<a name="line.874"></a> -<span class="sourceLineNo">875</span> *<a name="line.875"></a> -<span class="sourceLineNo">876</span> * @param isOptional specifies whether the Option can have<a name="line.876"></a> -<span class="sourceLineNo">877</span> * an optional argument.<a name="line.877"></a> -<span class="sourceLineNo">878</span> * @return this builder, to allow method chaining<a name="line.878"></a> -<span class="sourceLineNo">879</span> */<a name="line.879"></a> -<span class="sourceLineNo">880</span> public Builder optionalArg(final boolean isOptional)<a name="line.880"></a> -<span class="sourceLineNo">881</span> {<a name="line.881"></a> -<span class="sourceLineNo">882</span> this.optionalArg = isOptional;<a name="line.882"></a> -<span class="sourceLineNo">883</span> return this;<a name="line.883"></a> -<span class="sourceLineNo">884</span> }<a name="line.884"></a> -<span class="sourceLineNo">885</span> <a name="line.885"></a> -<span class="sourceLineNo">886</span> /**<a name="line.886"></a> -<span class="sourceLineNo">887</span> * Marks this Option as required.<a name="line.887"></a> -<span class="sourceLineNo">888</span> *<a name="line.888"></a> -<span class="sourceLineNo">889</span> * @return this builder, to allow method chaining<a name="line.889"></a> -<span class="sourceLineNo">890</span> */<a name="line.890"></a> -<span class="sourceLineNo">891</span> public Builder required()<a name="line.891"></a> -<span class="sourceLineNo">892</span> {<a name="line.892"></a> -<span class="sourceLineNo">893</span> return required(true);<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> /**<a name="line.896"></a> -<span class="sourceLineNo">897</span> * Sets whether the Option is mandatory.<a name="line.897"></a> -<span class="sourceLineNo">898</span> *<a name="line.898"></a> -<span class="sourceLineNo">899</span> * @param required specifies whether the Option is mandatory<a name="line.899"></a> -<span class="sourceLineNo">900</span> * @return this builder, to allow method chaining<a name="line.900"></a> -<span class="sourceLineNo">901</span> */<a name="line.901"></a> -<span class="sourceLineNo">902</span> public Builder required(final boolean required)<a name="line.902"></a> -<span class="sourceLineNo">903</span> {<a name="line.903"></a> -<span class="sourceLineNo">904</span> this.required = required;<a name="line.904"></a> -<span class="sourceLineNo">905</span> return this;<a name="line.905"></a> -<span class="sourceLineNo">906</span> }<a name="line.906"></a> -<span class="sourceLineNo">907</span> <a name="line.907"></a> -<span class="sourceLineNo">908</span> /**<a name="line.908"></a> -<span class="sourceLineNo">909</span> * Sets the type of the Option.<a name="line.909"></a> -<span class="sourceLineNo">910</span> *<a name="line.910"></a> -<span class="sourceLineNo">911</span> * @param type the type of the Option<a name="line.911"></a> -<span class="sourceLineNo">912</span> * @return this builder, to allow method chaining<a name="line.912"></a> -<span class="sourceLineNo">913</span> */<a name="line.913"></a> -<span class="sourceLineNo">914</span> public Builder type(final Class<?> type)<a name="line.914"></a> -<span class="sourceLineNo">915</span> {<a name="line.915"></a> -<span class="sourceLineNo">916</span> this.type = type;<a name="line.916"></a> -<span class="sourceLineNo">917</span> return this;<a name="line.917"></a> -<span class="sourceLineNo">918</span> }<a name="line.918"></a> -<span class="sourceLineNo">919</span><a name="line.919"></a> -<span class="sourceLineNo">920</span> /**<a name="line.920"></a> -<span class="sourceLineNo">921</span> * The Option will use '=' as a means to separate argument value.<a name="line.921"></a> -<span class="sourceLineNo">922</span> *<a name="line.922"></a> -<span class="sourceLineNo">923</span> * @return this builder, to allow method chaining<a name="line.923"></a> -<span class="sourceLineNo">924</span> */<a name="line.924"></a> -<span class="sourceLineNo">925</span> public Builder valueSeparator()<a name="line.925"></a> -<span class="sourceLineNo">926</span> {<a name="line.926"></a> -<span class="sourceLineNo">927</span> return valueSeparator('=');<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> /**<a name="line.930"></a> -<span class="sourceLineNo">931</span> * The Option will use <code>sep</code> as a means to<a name="line.931"></a> -<span class="sourceLineNo">932</span> * separate argument values.<a name="line.932"></a> -<span class="sourceLineNo">933</span> * <p><a name="line.933"></a> -<span class="sourceLineNo">934</span> * <b>Example:</b><a name="line.934"></a> -<span class="sourceLineNo">935</span> * <pre><a name="line.935"></a> -<span class="sourceLineNo">936</span> * Option opt = Option.builder("D").hasArgs()<a name="line.936"></a> -<span class="sourceLineNo">937</span> * .valueSeparator('=')<a name="line.937"></a> -<span class="sourceLineNo">938</span> * .build();<a name="line.938"></a> -<span class="sourceLineNo">939</span> * Options options = new Options();<a name="line.939"></a> -<span class="sourceLineNo">940</span> * options.addOption(opt);<a name="line.940"></a> -<span class="sourceLineNo">941</span> * String[] args = {"-Dkey=value"};<a name="line.941"></a> -<span class="sourceLineNo">942</span> * CommandLineParser parser = new DefaultParser();<a name="line.942"></a> -<span class="sourceLineNo">943</span> * CommandLine line = parser.parse(options, args);<a name="line.943"></a> -<span class="sourceLineNo">944</span> * String propertyName = line.getOptionValues("D")[0]; // will be "key"<a name="line.944"></a> -<span class="sourceLineNo">945</span> * String propertyValue = line.getOptionValues("D")[1]; // will be "value"<a name="line.945"></a> -<span class="sourceLineNo">946</span> * </pre><a name="line.946"></a> -<span class="sourceLineNo">947</span> *<a name="line.947"></a> -<span class="sourceLineNo">948</span> * @param sep The value separator.<a name="line.948"></a> -<span class="sourceLineNo">949</span> * @return this builder, to allow method chaining<a name="line.949"></a> -<span class="sourceLineNo">950</span> */<a name="line.950"></a> -<span class="sourceLineNo">951</span> public Builder valueSeparator(final char sep)<a name="line.951"></a> -<span class="sourceLineNo">952</span> {<a name="line.952"></a> -<span class="sourceLineNo">953</span> valuesep = sep;<a name="line.953"></a> -<span class="sourceLineNo">954</span> return this;<a name="line.954"></a> -<span class="sourceLineNo">955</span> }<a name="line.955"></a> -<span class="sourceLineNo">956</span> <a name="line.956"></a> -<span class="sourceLineNo">957</span> /**<a name="line.957"></a> -<span class="sourceLineNo">958</span> * Indicates that the Option will require an argument.<a name="line.958"></a> -<span class="sourceLineNo">959</span> * <a name="line.959"></a> -<span class="sourceLineNo">960</span> * @return this builder, to allow method chaining<a name="line.960"></a> -<span class="sourceLineNo">961</span> */<a name="line.961"></a> -<span class="sourceLineNo">962</span> public Builder hasArg()<a name="line.962"></a> -<span class="sourceLineNo">963</span> {<a name="line.963"></a> -<span class="sourceLineNo">964</span> return hasArg(true);<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> /**<a name="line.967"></a> -<span class="sourceLineNo">968</span> * Indicates if the Option has an argument or not.<a name="line.968"></a> -<span class="sourceLineNo">969</span> * <a name="line.969"></a> -<span class="sourceLineNo">970</span> * @param hasArg specifies whether the Option takes an argument or not<a name="line.970"></a> -<span class="sourceLineNo">971</span> * @return this builder, to allow method chaining<a name="line.971"></a> -<span class="sourceLineNo">972</span> */<a name="line.972"></a> -<span class="sourceLineNo">973</span> public Builder hasArg(final boolean hasArg)<a name="line.973"></a> -<span class="sourceLineNo">974</span> {<a name="line.974"></a> -<span class="sourceLineNo">975</span> // set to UNINITIALIZED when no arg is specified to be compatible with OptionBuilder<a name="line.975"></a> -<span class="sourceLineNo">976</span> numberOfArgs = hasArg ? 1 : Option.UNINITIALIZED;<a name="line.976"></a> -<span class="sourceLineNo">977</span> return this;<a name="line.977"></a> -<span class="sourceLineNo">978</span> }<a name="line.978"></a> -<span class="sourceLineNo">979</span><a name="line.979"></a> -<span class="sourceLineNo">980</span> /**<a name="line.980"></a> -<span class="sourceLineNo">981</span> * Indicates that the Option can have unlimited argument values.<a name="line.981"></a> -<span class="sourceLineNo">982</span> * <a name="line.982"></a> -<span class="sourceLineNo">983</span> * @return this builder, to allow method chaining<a name="line.983"></a> -<span class="sourceLineNo">984</span> */<a name="line.984"></a> -<span class="sourceLineNo">985</span> public Builder hasArgs()<a name="line.985"></a> -<span class="sourceLineNo">986</span> {<a name="line.986"></a> -<span class="sourceLineNo">987</span> numberOfArgs = Option.UNLIMITED_VALUES;<a name="line.987"></a> -<span class="sourceLineNo">988</span> return this;<a name="line.988"></a> -<span class="sourceLineNo">989</span> }<a name="line.989"></a> -<span class="sourceLineNo">990</span><a name="line.990"></a> -<span class="sourceLineNo">991</span> /**<a name="line.991"></a> -<span class="sourceLineNo">992</span> * Constructs an Option with the values declared by this {@link Builder}.<a name="line.992"></a> -<span class="sourceLineNo">993</span> * <a name="line.993"></a> -<span class="sourceLineNo">994</span> * @return the new {@link Option}<a name="line.994"></a> -<span class="sourceLineNo">995</span> * @throws IllegalArgumentException if neither {@code opt} or {@code longOpt} has been set<a name="line.995"></a> -<span class="sourceLineNo">996</span> */<a name="line.996"></a> -<span class="sourceLineNo">997</span> public Option build()<a name="line.997"></a> -<span class="sourceLineNo">998</span> {<a name="line.998"></a> -<span class="sourceLineNo">999</span> if (opt == null && longOpt == null)<a name="line.999"></a> -<span class="sourceLineNo">1000</span> {<a name="line.1000"></a> -<span class="sourceLineNo">1001</span> throw new IllegalArgumentException("Either opt or longOpt must be specified");<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> }<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> return new Option(this);<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> }<a name="line.1004"></a> -<span class="sourceLineNo">1005</span> }<a name="line.1005"></a> -<span class="sourceLineNo">1006</span>}<a name="line.1006"></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<?> 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 <code>Builder</code> with the minimum<a name="line.822"></a> +<span class="sourceLineNo">823</span> * required parameters for an <code>Option</code> 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>
[... 192 lines stripped ...]