commons-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject svn commit: r1008235 [4/39] - in /websites/production/commons/content/proper/commons-cli: ./ apidocs/ apidocs/org/apache/commons/cli/ apidocs/org/apache/commons/cli/class-use/ apidocs/src-html/org/apache/commons/cli/ css/ images/ images/svg/ jacoco-agg...
Date Mon, 13 Mar 2017 09:49:55 GMT
Added: websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.Builder.html
==============================================================================
--- websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.Builder.html (added)
+++ websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.Builder.html Mon Mar 13 09:49:52 2017
@@ -0,0 +1,497 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="de">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span><a name="line.17"></a>
+<span class="sourceLineNo">018</span>package org.apache.commons.cli;<a name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import java.util.Iterator;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import java.util.LinkedList;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import java.util.Properties;<a name="line.26"></a>
+<span class="sourceLineNo">027</span><a name="line.27"></a>
+<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * Represents list of arguments parsed against a {@link Options} descriptor.<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * It allows querying of a boolean {@link #hasOption(String opt)},<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * in addition to retrieving the {@link #getOptionValue(String opt)}<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * for options requiring arguments.<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Additionally, any left-over or unrecognized arguments,<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * are available for further processing.<a name="line.36"></a>
+<span class="sourceLineNo">037</span> *<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * @version $Id: CommandLine.java 1786144 2017-03-09 11:34:57Z britter $<a name="line.38"></a>
+<span class="sourceLineNo">039</span> */<a name="line.39"></a>
+<span class="sourceLineNo">040</span>public class CommandLine implements Serializable<a name="line.40"></a>
+<span class="sourceLineNo">041</span>{<a name="line.41"></a>
+<span class="sourceLineNo">042</span>    /** The serial version UID. */<a name="line.42"></a>
+<span class="sourceLineNo">043</span>    private static final long serialVersionUID = 1L;<a name="line.43"></a>
+<span class="sourceLineNo">044</span><a name="line.44"></a>
+<span class="sourceLineNo">045</span>    /** the unrecognized options/arguments */<a name="line.45"></a>
+<span class="sourceLineNo">046</span>    private final List&lt;String&gt; args = new LinkedList&lt;String&gt;();<a name="line.46"></a>
+<span class="sourceLineNo">047</span><a name="line.47"></a>
+<span class="sourceLineNo">048</span>    /** the processed options */<a name="line.48"></a>
+<span class="sourceLineNo">049</span>    private final List&lt;Option&gt; options = new ArrayList&lt;Option&gt;();<a name="line.49"></a>
+<span class="sourceLineNo">050</span><a name="line.50"></a>
+<span class="sourceLineNo">051</span>    /**<a name="line.51"></a>
+<span class="sourceLineNo">052</span>     * Creates a command line.<a name="line.52"></a>
+<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
+<span class="sourceLineNo">054</span>    protected CommandLine()<a name="line.54"></a>
+<span class="sourceLineNo">055</span>    {<a name="line.55"></a>
+<span class="sourceLineNo">056</span>        // nothing to do<a name="line.56"></a>
+<span class="sourceLineNo">057</span>    }<a name="line.57"></a>
+<span class="sourceLineNo">058</span><a name="line.58"></a>
+<span class="sourceLineNo">059</span>    /** <a name="line.59"></a>
+<span class="sourceLineNo">060</span>     * Query to see if an option has been set.<a name="line.60"></a>
+<span class="sourceLineNo">061</span>     *<a name="line.61"></a>
+<span class="sourceLineNo">062</span>     * @param opt Short name of the option<a name="line.62"></a>
+<span class="sourceLineNo">063</span>     * @return true if set, false if not<a name="line.63"></a>
+<span class="sourceLineNo">064</span>     */<a name="line.64"></a>
+<span class="sourceLineNo">065</span>    public boolean hasOption(String opt)<a name="line.65"></a>
+<span class="sourceLineNo">066</span>    {<a name="line.66"></a>
+<span class="sourceLineNo">067</span>        return options.contains(resolveOption(opt));<a name="line.67"></a>
+<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
+<span class="sourceLineNo">069</span><a name="line.69"></a>
+<span class="sourceLineNo">070</span>    /** <a name="line.70"></a>
+<span class="sourceLineNo">071</span>     * Query to see if an option has been set.<a name="line.71"></a>
+<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
+<span class="sourceLineNo">073</span>     * @param opt character name of the option<a name="line.73"></a>
+<span class="sourceLineNo">074</span>     * @return true if set, false if not<a name="line.74"></a>
+<span class="sourceLineNo">075</span>     */<a name="line.75"></a>
+<span class="sourceLineNo">076</span>    public boolean hasOption(char opt)<a name="line.76"></a>
+<span class="sourceLineNo">077</span>    {<a name="line.77"></a>
+<span class="sourceLineNo">078</span>        return hasOption(String.valueOf(opt));<a name="line.78"></a>
+<span class="sourceLineNo">079</span>    }<a name="line.79"></a>
+<span class="sourceLineNo">080</span><a name="line.80"></a>
+<span class="sourceLineNo">081</span>    /**<a name="line.81"></a>
+<span class="sourceLineNo">082</span>     * Return the &lt;code&gt;Object&lt;/code&gt; type of this &lt;code&gt;Option&lt;/code&gt;.<a name="line.82"></a>
+<span class="sourceLineNo">083</span>     *<a name="line.83"></a>
+<span class="sourceLineNo">084</span>     * @param opt the name of the option<a name="line.84"></a>
+<span class="sourceLineNo">085</span>     * @return the type of this &lt;code&gt;Option&lt;/code&gt;<a name="line.85"></a>
+<span class="sourceLineNo">086</span>     * @deprecated due to System.err message. Instead use getParsedOptionValue(String)<a name="line.86"></a>
+<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
+<span class="sourceLineNo">088</span>    @Deprecated<a name="line.88"></a>
+<span class="sourceLineNo">089</span>    public Object getOptionObject(String opt)<a name="line.89"></a>
+<span class="sourceLineNo">090</span>    {<a name="line.90"></a>
+<span class="sourceLineNo">091</span>        try<a name="line.91"></a>
+<span class="sourceLineNo">092</span>        {<a name="line.92"></a>
+<span class="sourceLineNo">093</span>            return getParsedOptionValue(opt);<a name="line.93"></a>
+<span class="sourceLineNo">094</span>        }<a name="line.94"></a>
+<span class="sourceLineNo">095</span>        catch (ParseException pe)<a name="line.95"></a>
+<span class="sourceLineNo">096</span>        {<a name="line.96"></a>
+<span class="sourceLineNo">097</span>            System.err.println("Exception found converting " + opt + " to desired type: " + pe.getMessage());<a name="line.97"></a>
+<span class="sourceLineNo">098</span>            return null;<a name="line.98"></a>
+<span class="sourceLineNo">099</span>        }<a name="line.99"></a>
+<span class="sourceLineNo">100</span>    }<a name="line.100"></a>
+<span class="sourceLineNo">101</span><a name="line.101"></a>
+<span class="sourceLineNo">102</span>    /**<a name="line.102"></a>
+<span class="sourceLineNo">103</span>     * Return a version of this &lt;code&gt;Option&lt;/code&gt; converted to a particular type. <a name="line.103"></a>
+<span class="sourceLineNo">104</span>     *<a name="line.104"></a>
+<span class="sourceLineNo">105</span>     * @param opt the name of the option<a name="line.105"></a>
+<span class="sourceLineNo">106</span>     * @return the value parsed into a particular object<a name="line.106"></a>
+<span class="sourceLineNo">107</span>     * @throws ParseException if there are problems turning the option value into the desired type<a name="line.107"></a>
+<span class="sourceLineNo">108</span>     * @see PatternOptionBuilder<a name="line.108"></a>
+<span class="sourceLineNo">109</span>     * @since 1.2<a name="line.109"></a>
+<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
+<span class="sourceLineNo">111</span>    public Object getParsedOptionValue(String opt) throws ParseException<a name="line.111"></a>
+<span class="sourceLineNo">112</span>    {<a name="line.112"></a>
+<span class="sourceLineNo">113</span>        String res = getOptionValue(opt);<a name="line.113"></a>
+<span class="sourceLineNo">114</span>        Option option = resolveOption(opt);<a name="line.114"></a>
+<span class="sourceLineNo">115</span>        <a name="line.115"></a>
+<span class="sourceLineNo">116</span>        if (option == null || res == null)<a name="line.116"></a>
+<span class="sourceLineNo">117</span>        {<a name="line.117"></a>
+<span class="sourceLineNo">118</span>            return null;<a name="line.118"></a>
+<span class="sourceLineNo">119</span>        }<a name="line.119"></a>
+<span class="sourceLineNo">120</span>        <a name="line.120"></a>
+<span class="sourceLineNo">121</span>        return TypeHandler.createValue(res, option.getType());<a name="line.121"></a>
+<span class="sourceLineNo">122</span>    }<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span>     * Return the &lt;code&gt;Object&lt;/code&gt; type of this &lt;code&gt;Option&lt;/code&gt;.<a name="line.125"></a>
+<span class="sourceLineNo">126</span>     *<a name="line.126"></a>
+<span class="sourceLineNo">127</span>     * @param opt the name of the option<a name="line.127"></a>
+<span class="sourceLineNo">128</span>     * @return the type of opt<a name="line.128"></a>
+<span class="sourceLineNo">129</span>     */<a name="line.129"></a>
+<span class="sourceLineNo">130</span>    public Object getOptionObject(char opt)<a name="line.130"></a>
+<span class="sourceLineNo">131</span>    {<a name="line.131"></a>
+<span class="sourceLineNo">132</span>        return getOptionObject(String.valueOf(opt));<a name="line.132"></a>
+<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
+<span class="sourceLineNo">134</span><a name="line.134"></a>
+<span class="sourceLineNo">135</span>    /** <a name="line.135"></a>
+<span class="sourceLineNo">136</span>     * Retrieve the first argument, if any, of this option.<a name="line.136"></a>
+<span class="sourceLineNo">137</span>     *<a name="line.137"></a>
+<span class="sourceLineNo">138</span>     * @param opt the name of the option<a name="line.138"></a>
+<span class="sourceLineNo">139</span>     * @return Value of the argument if option is set, and has an argument,<a name="line.139"></a>
+<span class="sourceLineNo">140</span>     * otherwise null.<a name="line.140"></a>
+<span class="sourceLineNo">141</span>     */<a name="line.141"></a>
+<span class="sourceLineNo">142</span>    public String getOptionValue(String opt)<a name="line.142"></a>
+<span class="sourceLineNo">143</span>    {<a name="line.143"></a>
+<span class="sourceLineNo">144</span>        String[] values = getOptionValues(opt);<a name="line.144"></a>
+<span class="sourceLineNo">145</span><a name="line.145"></a>
+<span class="sourceLineNo">146</span>        return (values == null) ? null : values[0];<a name="line.146"></a>
+<span class="sourceLineNo">147</span>    }<a name="line.147"></a>
+<span class="sourceLineNo">148</span><a name="line.148"></a>
+<span class="sourceLineNo">149</span>    /** <a name="line.149"></a>
+<span class="sourceLineNo">150</span>     * Retrieve the first argument, if any, of this option.<a name="line.150"></a>
+<span class="sourceLineNo">151</span>     *<a name="line.151"></a>
+<span class="sourceLineNo">152</span>     * @param opt the character name of the option<a name="line.152"></a>
+<span class="sourceLineNo">153</span>     * @return Value of the argument if option is set, and has an argument,<a name="line.153"></a>
+<span class="sourceLineNo">154</span>     * otherwise null.<a name="line.154"></a>
+<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
+<span class="sourceLineNo">156</span>    public String getOptionValue(char opt)<a name="line.156"></a>
+<span class="sourceLineNo">157</span>    {<a name="line.157"></a>
+<span class="sourceLineNo">158</span>        return getOptionValue(String.valueOf(opt));<a name="line.158"></a>
+<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
+<span class="sourceLineNo">160</span><a name="line.160"></a>
+<span class="sourceLineNo">161</span>    /** <a name="line.161"></a>
+<span class="sourceLineNo">162</span>     * Retrieves the array of values, if any, of an option.<a name="line.162"></a>
+<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
+<span class="sourceLineNo">164</span>     * @param opt string name of the option<a name="line.164"></a>
+<span class="sourceLineNo">165</span>     * @return Values of the argument if option is set, and has an argument,<a name="line.165"></a>
+<span class="sourceLineNo">166</span>     * otherwise null.<a name="line.166"></a>
+<span class="sourceLineNo">167</span>     */<a name="line.167"></a>
+<span class="sourceLineNo">168</span>    public String[] getOptionValues(String opt)<a name="line.168"></a>
+<span class="sourceLineNo">169</span>    {<a name="line.169"></a>
+<span class="sourceLineNo">170</span>        List&lt;String&gt; values = new ArrayList&lt;String&gt;();<a name="line.170"></a>
+<span class="sourceLineNo">171</span><a name="line.171"></a>
+<span class="sourceLineNo">172</span>        for (Option option : options)<a name="line.172"></a>
+<span class="sourceLineNo">173</span>        {<a name="line.173"></a>
+<span class="sourceLineNo">174</span>            if (opt.equals(option.getOpt()) || opt.equals(option.getLongOpt()))<a name="line.174"></a>
+<span class="sourceLineNo">175</span>            {<a name="line.175"></a>
+<span class="sourceLineNo">176</span>                values.addAll(option.getValuesList());<a name="line.176"></a>
+<span class="sourceLineNo">177</span>            }<a name="line.177"></a>
+<span class="sourceLineNo">178</span>        }<a name="line.178"></a>
+<span class="sourceLineNo">179</span><a name="line.179"></a>
+<span class="sourceLineNo">180</span>        return values.isEmpty() ? null : values.toArray(new String[values.size()]);<a name="line.180"></a>
+<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
+<span class="sourceLineNo">182</span><a name="line.182"></a>
+<span class="sourceLineNo">183</span>    /**<a name="line.183"></a>
+<span class="sourceLineNo">184</span>     * Retrieves the option object given the long or short option as a String<a name="line.184"></a>
+<span class="sourceLineNo">185</span>     * <a name="line.185"></a>
+<span class="sourceLineNo">186</span>     * @param opt short or long name of the option<a name="line.186"></a>
+<span class="sourceLineNo">187</span>     * @return Canonicalized option<a name="line.187"></a>
+<span class="sourceLineNo">188</span>     */<a name="line.188"></a>
+<span class="sourceLineNo">189</span>    private Option resolveOption(String opt)<a name="line.189"></a>
+<span class="sourceLineNo">190</span>    {<a name="line.190"></a>
+<span class="sourceLineNo">191</span>        opt = Util.stripLeadingHyphens(opt);<a name="line.191"></a>
+<span class="sourceLineNo">192</span>        for (Option option : options)<a name="line.192"></a>
+<span class="sourceLineNo">193</span>        {<a name="line.193"></a>
+<span class="sourceLineNo">194</span>            if (opt.equals(option.getOpt()))<a name="line.194"></a>
+<span class="sourceLineNo">195</span>            {<a name="line.195"></a>
+<span class="sourceLineNo">196</span>                return option;<a name="line.196"></a>
+<span class="sourceLineNo">197</span>            }<a name="line.197"></a>
+<span class="sourceLineNo">198</span><a name="line.198"></a>
+<span class="sourceLineNo">199</span>            if (opt.equals(option.getLongOpt()))<a name="line.199"></a>
+<span class="sourceLineNo">200</span>            {<a name="line.200"></a>
+<span class="sourceLineNo">201</span>                return option;<a name="line.201"></a>
+<span class="sourceLineNo">202</span>            }<a name="line.202"></a>
+<span class="sourceLineNo">203</span><a name="line.203"></a>
+<span class="sourceLineNo">204</span>        }<a name="line.204"></a>
+<span class="sourceLineNo">205</span>        return null;<a name="line.205"></a>
+<span class="sourceLineNo">206</span>    }<a name="line.206"></a>
+<span class="sourceLineNo">207</span><a name="line.207"></a>
+<span class="sourceLineNo">208</span>    /** <a name="line.208"></a>
+<span class="sourceLineNo">209</span>     * Retrieves the array of values, if any, of an option.<a name="line.209"></a>
+<span class="sourceLineNo">210</span>     *<a name="line.210"></a>
+<span class="sourceLineNo">211</span>     * @param opt character name of the option<a name="line.211"></a>
+<span class="sourceLineNo">212</span>     * @return Values of the argument if option is set, and has an argument,<a name="line.212"></a>
+<span class="sourceLineNo">213</span>     * otherwise null.<a name="line.213"></a>
+<span class="sourceLineNo">214</span>     */<a name="line.214"></a>
+<span class="sourceLineNo">215</span>    public String[] getOptionValues(char opt)<a name="line.215"></a>
+<span class="sourceLineNo">216</span>    {<a name="line.216"></a>
+<span class="sourceLineNo">217</span>        return getOptionValues(String.valueOf(opt));<a name="line.217"></a>
+<span class="sourceLineNo">218</span>    }<a name="line.218"></a>
+<span class="sourceLineNo">219</span><a name="line.219"></a>
+<span class="sourceLineNo">220</span>    /** <a name="line.220"></a>
+<span class="sourceLineNo">221</span>     * Retrieve the first argument, if any, of an option.<a name="line.221"></a>
+<span class="sourceLineNo">222</span>     *<a name="line.222"></a>
+<span class="sourceLineNo">223</span>     * @param opt name of the option<a name="line.223"></a>
+<span class="sourceLineNo">224</span>     * @param defaultValue is the default value to be returned if the option<a name="line.224"></a>
+<span class="sourceLineNo">225</span>     * is not specified<a name="line.225"></a>
+<span class="sourceLineNo">226</span>     * @return Value of the argument if option is set, and has an argument,<a name="line.226"></a>
+<span class="sourceLineNo">227</span>     * otherwise &lt;code&gt;defaultValue&lt;/code&gt;.<a name="line.227"></a>
+<span class="sourceLineNo">228</span>     */<a name="line.228"></a>
+<span class="sourceLineNo">229</span>    public String getOptionValue(String opt, String defaultValue)<a name="line.229"></a>
+<span class="sourceLineNo">230</span>    {<a name="line.230"></a>
+<span class="sourceLineNo">231</span>        String answer = getOptionValue(opt);<a name="line.231"></a>
+<span class="sourceLineNo">232</span><a name="line.232"></a>
+<span class="sourceLineNo">233</span>        return (answer != null) ? answer : defaultValue;<a name="line.233"></a>
+<span class="sourceLineNo">234</span>    }<a name="line.234"></a>
+<span class="sourceLineNo">235</span><a name="line.235"></a>
+<span class="sourceLineNo">236</span>    /** <a name="line.236"></a>
+<span class="sourceLineNo">237</span>     * Retrieve the argument, if any, of an option.<a name="line.237"></a>
+<span class="sourceLineNo">238</span>     *<a name="line.238"></a>
+<span class="sourceLineNo">239</span>     * @param opt character name of the option<a name="line.239"></a>
+<span class="sourceLineNo">240</span>     * @param defaultValue is the default value to be returned if the option<a name="line.240"></a>
+<span class="sourceLineNo">241</span>     * is not specified<a name="line.241"></a>
+<span class="sourceLineNo">242</span>     * @return Value of the argument if option is set, and has an argument,<a name="line.242"></a>
+<span class="sourceLineNo">243</span>     * otherwise &lt;code&gt;defaultValue&lt;/code&gt;.<a name="line.243"></a>
+<span class="sourceLineNo">244</span>     */<a name="line.244"></a>
+<span class="sourceLineNo">245</span>    public String getOptionValue(char opt, String defaultValue)<a name="line.245"></a>
+<span class="sourceLineNo">246</span>    {<a name="line.246"></a>
+<span class="sourceLineNo">247</span>        return getOptionValue(String.valueOf(opt), defaultValue);<a name="line.247"></a>
+<span class="sourceLineNo">248</span>    }<a name="line.248"></a>
+<span class="sourceLineNo">249</span><a name="line.249"></a>
+<span class="sourceLineNo">250</span>    /**<a name="line.250"></a>
+<span class="sourceLineNo">251</span>     * Retrieve the map of values associated to the option. This is convenient<a name="line.251"></a>
+<span class="sourceLineNo">252</span>     * for options specifying Java properties like &lt;tt&gt;-Dparam1=value1<a name="line.252"></a>
+<span class="sourceLineNo">253</span>     * -Dparam2=value2&lt;/tt&gt;. The first argument of the option is the key, and<a name="line.253"></a>
+<span class="sourceLineNo">254</span>     * the 2nd argument is the value. If the option has only one argument<a name="line.254"></a>
+<span class="sourceLineNo">255</span>     * (&lt;tt&gt;-Dfoo&lt;/tt&gt;) it is considered as a boolean flag and the value is<a name="line.255"></a>
+<span class="sourceLineNo">256</span>     * &lt;tt&gt;"true"&lt;/tt&gt;.<a name="line.256"></a>
+<span class="sourceLineNo">257</span>     *<a name="line.257"></a>
+<span class="sourceLineNo">258</span>     * @param opt name of the option<a name="line.258"></a>
+<span class="sourceLineNo">259</span>     * @return The Properties mapped by the option, never &lt;tt&gt;null&lt;/tt&gt;<a name="line.259"></a>
+<span class="sourceLineNo">260</span>     *         even if the option doesn't exists<a name="line.260"></a>
+<span class="sourceLineNo">261</span>     * @since 1.2<a name="line.261"></a>
+<span class="sourceLineNo">262</span>     */<a name="line.262"></a>
+<span class="sourceLineNo">263</span>    public Properties getOptionProperties(String opt)<a name="line.263"></a>
+<span class="sourceLineNo">264</span>    {<a name="line.264"></a>
+<span class="sourceLineNo">265</span>        Properties props = new Properties();<a name="line.265"></a>
+<span class="sourceLineNo">266</span><a name="line.266"></a>
+<span class="sourceLineNo">267</span>        for (Option option : options)<a name="line.267"></a>
+<span class="sourceLineNo">268</span>        {<a name="line.268"></a>
+<span class="sourceLineNo">269</span>            if (opt.equals(option.getOpt()) || opt.equals(option.getLongOpt()))<a name="line.269"></a>
+<span class="sourceLineNo">270</span>            {<a name="line.270"></a>
+<span class="sourceLineNo">271</span>                List&lt;String&gt; values = option.getValuesList();<a name="line.271"></a>
+<span class="sourceLineNo">272</span>                if (values.size() &gt;= 2)<a name="line.272"></a>
+<span class="sourceLineNo">273</span>                {<a name="line.273"></a>
+<span class="sourceLineNo">274</span>                    // use the first 2 arguments as the key/value pair<a name="line.274"></a>
+<span class="sourceLineNo">275</span>                    props.put(values.get(0), values.get(1));<a name="line.275"></a>
+<span class="sourceLineNo">276</span>                }<a name="line.276"></a>
+<span class="sourceLineNo">277</span>                else if (values.size() == 1)<a name="line.277"></a>
+<span class="sourceLineNo">278</span>                {<a name="line.278"></a>
+<span class="sourceLineNo">279</span>                    // no explicit value, handle it as a boolean<a name="line.279"></a>
+<span class="sourceLineNo">280</span>                    props.put(values.get(0), "true");<a name="line.280"></a>
+<span class="sourceLineNo">281</span>                }<a name="line.281"></a>
+<span class="sourceLineNo">282</span>            }<a name="line.282"></a>
+<span class="sourceLineNo">283</span>        }<a name="line.283"></a>
+<span class="sourceLineNo">284</span><a name="line.284"></a>
+<span class="sourceLineNo">285</span>        return props;<a name="line.285"></a>
+<span class="sourceLineNo">286</span>    }<a name="line.286"></a>
+<span class="sourceLineNo">287</span><a name="line.287"></a>
+<span class="sourceLineNo">288</span>    /** <a name="line.288"></a>
+<span class="sourceLineNo">289</span>     * Retrieve any left-over non-recognized options and arguments<a name="line.289"></a>
+<span class="sourceLineNo">290</span>     *<a name="line.290"></a>
+<span class="sourceLineNo">291</span>     * @return remaining items passed in but not parsed as an array<a name="line.291"></a>
+<span class="sourceLineNo">292</span>     */<a name="line.292"></a>
+<span class="sourceLineNo">293</span>    public String[] getArgs()<a name="line.293"></a>
+<span class="sourceLineNo">294</span>    {<a name="line.294"></a>
+<span class="sourceLineNo">295</span>        String[] answer = new String[args.size()];<a name="line.295"></a>
+<span class="sourceLineNo">296</span><a name="line.296"></a>
+<span class="sourceLineNo">297</span>        args.toArray(answer);<a name="line.297"></a>
+<span class="sourceLineNo">298</span><a name="line.298"></a>
+<span class="sourceLineNo">299</span>        return answer;<a name="line.299"></a>
+<span class="sourceLineNo">300</span>    }<a name="line.300"></a>
+<span class="sourceLineNo">301</span><a name="line.301"></a>
+<span class="sourceLineNo">302</span>    /** <a name="line.302"></a>
+<span class="sourceLineNo">303</span>     * Retrieve any left-over non-recognized options and arguments<a name="line.303"></a>
+<span class="sourceLineNo">304</span>     *<a name="line.304"></a>
+<span class="sourceLineNo">305</span>     * @return remaining items passed in but not parsed as a &lt;code&gt;List&lt;/code&gt;.<a name="line.305"></a>
+<span class="sourceLineNo">306</span>     */<a name="line.306"></a>
+<span class="sourceLineNo">307</span>    public List&lt;String&gt; getArgList()<a name="line.307"></a>
+<span class="sourceLineNo">308</span>    {<a name="line.308"></a>
+<span class="sourceLineNo">309</span>        return args;<a name="line.309"></a>
+<span class="sourceLineNo">310</span>    }<a name="line.310"></a>
+<span class="sourceLineNo">311</span><a name="line.311"></a>
+<span class="sourceLineNo">312</span>    /** <a name="line.312"></a>
+<span class="sourceLineNo">313</span>     * jkeyes<a name="line.313"></a>
+<span class="sourceLineNo">314</span>     * - commented out until it is implemented properly<a name="line.314"></a>
+<span class="sourceLineNo">315</span>     * &lt;p&gt;Dump state, suitable for debugging.&lt;/p&gt;<a name="line.315"></a>
+<span class="sourceLineNo">316</span>     *<a name="line.316"></a>
+<span class="sourceLineNo">317</span>     * @return Stringified form of this object<a name="line.317"></a>
+<span class="sourceLineNo">318</span>     */<a name="line.318"></a>
+<span class="sourceLineNo">319</span><a name="line.319"></a>
+<span class="sourceLineNo">320</span>    /*<a name="line.320"></a>
+<span class="sourceLineNo">321</span>    public String toString() {<a name="line.321"></a>
+<span class="sourceLineNo">322</span>        StringBuilder buf = new StringBuilder();<a name="line.322"></a>
+<span class="sourceLineNo">323</span>            <a name="line.323"></a>
+<span class="sourceLineNo">324</span>        buf.append("[ CommandLine: [ options: ");<a name="line.324"></a>
+<span class="sourceLineNo">325</span>        buf.append(options.toString());<a name="line.325"></a>
+<span class="sourceLineNo">326</span>        buf.append(" ] [ args: ");<a name="line.326"></a>
+<span class="sourceLineNo">327</span>        buf.append(args.toString());<a name="line.327"></a>
+<span class="sourceLineNo">328</span>        buf.append(" ] ]");<a name="line.328"></a>
+<span class="sourceLineNo">329</span>            <a name="line.329"></a>
+<span class="sourceLineNo">330</span>        return buf.toString();<a name="line.330"></a>
+<span class="sourceLineNo">331</span>    }<a name="line.331"></a>
+<span class="sourceLineNo">332</span>    */<a name="line.332"></a>
+<span class="sourceLineNo">333</span><a name="line.333"></a>
+<span class="sourceLineNo">334</span>    /**<a name="line.334"></a>
+<span class="sourceLineNo">335</span>     * Add left-over unrecognized option/argument.<a name="line.335"></a>
+<span class="sourceLineNo">336</span>     *<a name="line.336"></a>
+<span class="sourceLineNo">337</span>     * @param arg the unrecognized option/argument.<a name="line.337"></a>
+<span class="sourceLineNo">338</span>     */<a name="line.338"></a>
+<span class="sourceLineNo">339</span>    protected void addArg(String arg)<a name="line.339"></a>
+<span class="sourceLineNo">340</span>    {<a name="line.340"></a>
+<span class="sourceLineNo">341</span>        args.add(arg);<a name="line.341"></a>
+<span class="sourceLineNo">342</span>    }<a name="line.342"></a>
+<span class="sourceLineNo">343</span><a name="line.343"></a>
+<span class="sourceLineNo">344</span>    /**<a name="line.344"></a>
+<span class="sourceLineNo">345</span>     * Add an option to the command line.  The values of the option are stored.<a name="line.345"></a>
+<span class="sourceLineNo">346</span>     *<a name="line.346"></a>
+<span class="sourceLineNo">347</span>     * @param opt the processed option<a name="line.347"></a>
+<span class="sourceLineNo">348</span>     */<a name="line.348"></a>
+<span class="sourceLineNo">349</span>    protected void addOption(Option opt)<a name="line.349"></a>
+<span class="sourceLineNo">350</span>    {<a name="line.350"></a>
+<span class="sourceLineNo">351</span>        options.add(opt);<a name="line.351"></a>
+<span class="sourceLineNo">352</span>    }<a name="line.352"></a>
+<span class="sourceLineNo">353</span><a name="line.353"></a>
+<span class="sourceLineNo">354</span>    /**<a name="line.354"></a>
+<span class="sourceLineNo">355</span>     * Returns an iterator over the Option members of CommandLine.<a name="line.355"></a>
+<span class="sourceLineNo">356</span>     *<a name="line.356"></a>
+<span class="sourceLineNo">357</span>     * @return an &lt;code&gt;Iterator&lt;/code&gt; over the processed {@link Option}<a name="line.357"></a>
+<span class="sourceLineNo">358</span>     * members of this {@link CommandLine}<a name="line.358"></a>
+<span class="sourceLineNo">359</span>     */<a name="line.359"></a>
+<span class="sourceLineNo">360</span>    public Iterator&lt;Option&gt; iterator()<a name="line.360"></a>
+<span class="sourceLineNo">361</span>    {<a name="line.361"></a>
+<span class="sourceLineNo">362</span>        return options.iterator();<a name="line.362"></a>
+<span class="sourceLineNo">363</span>    }<a name="line.363"></a>
+<span class="sourceLineNo">364</span><a name="line.364"></a>
+<span class="sourceLineNo">365</span>    /**<a name="line.365"></a>
+<span class="sourceLineNo">366</span>     * Returns an array of the processed {@link Option}s.<a name="line.366"></a>
+<span class="sourceLineNo">367</span>     *<a name="line.367"></a>
+<span class="sourceLineNo">368</span>     * @return an array of the processed {@link Option}s.<a name="line.368"></a>
+<span class="sourceLineNo">369</span>     */<a name="line.369"></a>
+<span class="sourceLineNo">370</span>    public Option[] getOptions()<a name="line.370"></a>
+<span class="sourceLineNo">371</span>    {<a name="line.371"></a>
+<span class="sourceLineNo">372</span>        Collection&lt;Option&gt; processed = options;<a name="line.372"></a>
+<span class="sourceLineNo">373</span><a name="line.373"></a>
+<span class="sourceLineNo">374</span>        // reinitialise array<a name="line.374"></a>
+<span class="sourceLineNo">375</span>        Option[] optionsArray = new Option[processed.size()];<a name="line.375"></a>
+<span class="sourceLineNo">376</span><a name="line.376"></a>
+<span class="sourceLineNo">377</span>        // return the array<a name="line.377"></a>
+<span class="sourceLineNo">378</span>        return processed.toArray(optionsArray);<a name="line.378"></a>
+<span class="sourceLineNo">379</span>    }<a name="line.379"></a>
+<span class="sourceLineNo">380</span><a name="line.380"></a>
+<span class="sourceLineNo">381</span>    /**<a name="line.381"></a>
+<span class="sourceLineNo">382</span>     * A nested builder class to create &lt;code&gt;CommandLine&lt;/code&gt; instance<a name="line.382"></a>
+<span class="sourceLineNo">383</span>     * using descriptive methods.<a name="line.383"></a>
+<span class="sourceLineNo">384</span>     * <a name="line.384"></a>
+<span class="sourceLineNo">385</span>     * @since 1.4<a name="line.385"></a>
+<span class="sourceLineNo">386</span>     */<a name="line.386"></a>
+<span class="sourceLineNo">387</span>    public static final class Builder<a name="line.387"></a>
+<span class="sourceLineNo">388</span>    {<a name="line.388"></a>
+<span class="sourceLineNo">389</span>        /**<a name="line.389"></a>
+<span class="sourceLineNo">390</span>         * CommandLine that is being build by this Builder.<a name="line.390"></a>
+<span class="sourceLineNo">391</span>         */<a name="line.391"></a>
+<span class="sourceLineNo">392</span>        private final CommandLine commandLine = new CommandLine();<a name="line.392"></a>
+<span class="sourceLineNo">393</span><a name="line.393"></a>
+<span class="sourceLineNo">394</span>        /**<a name="line.394"></a>
+<span class="sourceLineNo">395</span>         * Add an option to the command line. The values of the option are stored.<a name="line.395"></a>
+<span class="sourceLineNo">396</span>         *<a name="line.396"></a>
+<span class="sourceLineNo">397</span>         * @param opt the processed option<a name="line.397"></a>
+<span class="sourceLineNo">398</span>         *<a name="line.398"></a>
+<span class="sourceLineNo">399</span>         * @return this Builder instance for method chaining.<a name="line.399"></a>
+<span class="sourceLineNo">400</span>         */<a name="line.400"></a>
+<span class="sourceLineNo">401</span>        public Builder addOption(Option opt)<a name="line.401"></a>
+<span class="sourceLineNo">402</span>        {<a name="line.402"></a>
+<span class="sourceLineNo">403</span>            commandLine.addOption(opt);<a name="line.403"></a>
+<span class="sourceLineNo">404</span>            return this;<a name="line.404"></a>
+<span class="sourceLineNo">405</span>        }<a name="line.405"></a>
+<span class="sourceLineNo">406</span><a name="line.406"></a>
+<span class="sourceLineNo">407</span>        /**<a name="line.407"></a>
+<span class="sourceLineNo">408</span>         * Add left-over unrecognized option/argument.<a name="line.408"></a>
+<span class="sourceLineNo">409</span>         *<a name="line.409"></a>
+<span class="sourceLineNo">410</span>         * @param arg the unrecognized option/argument.<a name="line.410"></a>
+<span class="sourceLineNo">411</span>         *<a name="line.411"></a>
+<span class="sourceLineNo">412</span>         * @return this Builder instance for method chaining.<a name="line.412"></a>
+<span class="sourceLineNo">413</span>         */<a name="line.413"></a>
+<span class="sourceLineNo">414</span>        public Builder addArg(String arg)<a name="line.414"></a>
+<span class="sourceLineNo">415</span>        {<a name="line.415"></a>
+<span class="sourceLineNo">416</span>            commandLine.addArg(arg);<a name="line.416"></a>
+<span class="sourceLineNo">417</span>            return this;<a name="line.417"></a>
+<span class="sourceLineNo">418</span>        }<a name="line.418"></a>
+<span class="sourceLineNo">419</span><a name="line.419"></a>
+<span class="sourceLineNo">420</span>        public CommandLine build()<a name="line.420"></a>
+<span class="sourceLineNo">421</span>        {<a name="line.421"></a>
+<span class="sourceLineNo">422</span>            return commandLine;<a name="line.422"></a>
+<span class="sourceLineNo">423</span>        }<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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file

Modified: websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.html
==============================================================================
--- websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.html (original)
+++ websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLine.html Mon Mar 13 09:49:52 2017
@@ -43,14 +43,14 @@
 <span class="sourceLineNo">035</span> * Additionally, any left-over or unrecognized arguments,<a name="line.35"></a>
 <span class="sourceLineNo">036</span> * are available for further processing.<a name="line.36"></a>
 <span class="sourceLineNo">037</span> *<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * @version $Id: CommandLine.java 1444365 2013-02-09 14:21:27Z tn $<a name="line.38"></a>
+<span class="sourceLineNo">038</span> * @version $Id: CommandLine.java 1786144 2017-03-09 11:34:57Z britter $<a name="line.38"></a>
 <span class="sourceLineNo">039</span> */<a name="line.39"></a>
 <span class="sourceLineNo">040</span>public class CommandLine implements Serializable<a name="line.40"></a>
 <span class="sourceLineNo">041</span>{<a name="line.41"></a>
 <span class="sourceLineNo">042</span>    /** The serial version UID. */<a name="line.42"></a>
 <span class="sourceLineNo">043</span>    private static final long serialVersionUID = 1L;<a name="line.43"></a>
 <span class="sourceLineNo">044</span><a name="line.44"></a>
-<span class="sourceLineNo">045</span>    /** the unrecognised options/arguments */<a name="line.45"></a>
+<span class="sourceLineNo">045</span>    /** the unrecognized options/arguments */<a name="line.45"></a>
 <span class="sourceLineNo">046</span>    private final List&lt;String&gt; args = new LinkedList&lt;String&gt;();<a name="line.46"></a>
 <span class="sourceLineNo">047</span><a name="line.47"></a>
 <span class="sourceLineNo">048</span>    /** the processed options */<a name="line.48"></a>
@@ -342,7 +342,7 @@
 <span class="sourceLineNo">334</span>    /**<a name="line.334"></a>
 <span class="sourceLineNo">335</span>     * Add left-over unrecognized option/argument.<a name="line.335"></a>
 <span class="sourceLineNo">336</span>     *<a name="line.336"></a>
-<span class="sourceLineNo">337</span>     * @param arg the unrecognised option/argument.<a name="line.337"></a>
+<span class="sourceLineNo">337</span>     * @param arg the unrecognized option/argument.<a name="line.337"></a>
 <span class="sourceLineNo">338</span>     */<a name="line.338"></a>
 <span class="sourceLineNo">339</span>    protected void addArg(String arg)<a name="line.339"></a>
 <span class="sourceLineNo">340</span>    {<a name="line.340"></a>
@@ -385,7 +385,52 @@
 <span class="sourceLineNo">377</span>        // return the array<a name="line.377"></a>
 <span class="sourceLineNo">378</span>        return processed.toArray(optionsArray);<a name="line.378"></a>
 <span class="sourceLineNo">379</span>    }<a name="line.379"></a>
-<span class="sourceLineNo">380</span>}<a name="line.380"></a>
+<span class="sourceLineNo">380</span><a name="line.380"></a>
+<span class="sourceLineNo">381</span>    /**<a name="line.381"></a>
+<span class="sourceLineNo">382</span>     * A nested builder class to create &lt;code&gt;CommandLine&lt;/code&gt; instance<a name="line.382"></a>
+<span class="sourceLineNo">383</span>     * using descriptive methods.<a name="line.383"></a>
+<span class="sourceLineNo">384</span>     * <a name="line.384"></a>
+<span class="sourceLineNo">385</span>     * @since 1.4<a name="line.385"></a>
+<span class="sourceLineNo">386</span>     */<a name="line.386"></a>
+<span class="sourceLineNo">387</span>    public static final class Builder<a name="line.387"></a>
+<span class="sourceLineNo">388</span>    {<a name="line.388"></a>
+<span class="sourceLineNo">389</span>        /**<a name="line.389"></a>
+<span class="sourceLineNo">390</span>         * CommandLine that is being build by this Builder.<a name="line.390"></a>
+<span class="sourceLineNo">391</span>         */<a name="line.391"></a>
+<span class="sourceLineNo">392</span>        private final CommandLine commandLine = new CommandLine();<a name="line.392"></a>
+<span class="sourceLineNo">393</span><a name="line.393"></a>
+<span class="sourceLineNo">394</span>        /**<a name="line.394"></a>
+<span class="sourceLineNo">395</span>         * Add an option to the command line. The values of the option are stored.<a name="line.395"></a>
+<span class="sourceLineNo">396</span>         *<a name="line.396"></a>
+<span class="sourceLineNo">397</span>         * @param opt the processed option<a name="line.397"></a>
+<span class="sourceLineNo">398</span>         *<a name="line.398"></a>
+<span class="sourceLineNo">399</span>         * @return this Builder instance for method chaining.<a name="line.399"></a>
+<span class="sourceLineNo">400</span>         */<a name="line.400"></a>
+<span class="sourceLineNo">401</span>        public Builder addOption(Option opt)<a name="line.401"></a>
+<span class="sourceLineNo">402</span>        {<a name="line.402"></a>
+<span class="sourceLineNo">403</span>            commandLine.addOption(opt);<a name="line.403"></a>
+<span class="sourceLineNo">404</span>            return this;<a name="line.404"></a>
+<span class="sourceLineNo">405</span>        }<a name="line.405"></a>
+<span class="sourceLineNo">406</span><a name="line.406"></a>
+<span class="sourceLineNo">407</span>        /**<a name="line.407"></a>
+<span class="sourceLineNo">408</span>         * Add left-over unrecognized option/argument.<a name="line.408"></a>
+<span class="sourceLineNo">409</span>         *<a name="line.409"></a>
+<span class="sourceLineNo">410</span>         * @param arg the unrecognized option/argument.<a name="line.410"></a>
+<span class="sourceLineNo">411</span>         *<a name="line.411"></a>
+<span class="sourceLineNo">412</span>         * @return this Builder instance for method chaining.<a name="line.412"></a>
+<span class="sourceLineNo">413</span>         */<a name="line.413"></a>
+<span class="sourceLineNo">414</span>        public Builder addArg(String arg)<a name="line.414"></a>
+<span class="sourceLineNo">415</span>        {<a name="line.415"></a>
+<span class="sourceLineNo">416</span>            commandLine.addArg(arg);<a name="line.416"></a>
+<span class="sourceLineNo">417</span>            return this;<a name="line.417"></a>
+<span class="sourceLineNo">418</span>        }<a name="line.418"></a>
+<span class="sourceLineNo">419</span><a name="line.419"></a>
+<span class="sourceLineNo">420</span>        public CommandLine build()<a name="line.420"></a>
+<span class="sourceLineNo">421</span>        {<a name="line.421"></a>
+<span class="sourceLineNo">422</span>            return commandLine;<a name="line.422"></a>
+<span class="sourceLineNo">423</span>        }<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>
 
 
 
@@ -449,4 +494,4 @@
 </pre>
 </div>
 </body>
-</html>
+</html>
\ No newline at end of file

Modified: websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLineParser.html
==============================================================================
--- websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLineParser.html (original)
+++ websites/production/commons/content/proper/commons-cli/apidocs/src-html/org/apache/commons/cli/CommandLineParser.html Mon Mar 13 09:49:52 2017
@@ -167,4 +167,4 @@
 </pre>
 </div>
 </body>
-</html>
+</html>
\ No newline at end of file



Mime
View raw message