/usr/share/doc/libcobertura-java/api/src-html/net/sourceforge/cobertura/util/CommandLineBuilder.html is in libcobertura-java-doc 1.9.4.1+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<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> * Cobertura - http://cobertura.sourceforge.net/<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Copyright (C) 2005 Grzegorz Lukasik<a name="line.4"></a>
<span class="sourceLineNo">005</span> *<a name="line.5"></a>
<span class="sourceLineNo">006</span> * Note: This file is dual licensed under the GPL and the Apache<a name="line.6"></a>
<span class="sourceLineNo">007</span> * Source License (so that it can be used from both the main<a name="line.7"></a>
<span class="sourceLineNo">008</span> * Cobertura classes and the ant tasks).<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Cobertura is free software; you can redistribute it and/or modify<a name="line.10"></a>
<span class="sourceLineNo">011</span> * it under the terms of the GNU General Public License as published<a name="line.11"></a>
<span class="sourceLineNo">012</span> * by the Free Software Foundation; either version 2 of the License,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * or (at your option) any later version.<a name="line.13"></a>
<span class="sourceLineNo">014</span> *<a name="line.14"></a>
<span class="sourceLineNo">015</span> * Cobertura is distributed in the hope that it will be useful, but<a name="line.15"></a>
<span class="sourceLineNo">016</span> * WITHOUT ANY WARRANTY; without even the implied warranty of<a name="line.16"></a>
<span class="sourceLineNo">017</span> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU<a name="line.17"></a>
<span class="sourceLineNo">018</span> * General Public License for more details.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * You should have received a copy of the GNU General Public License<a name="line.20"></a>
<span class="sourceLineNo">021</span> * along with Cobertura; if not, write to the Free Software<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307<a name="line.22"></a>
<span class="sourceLineNo">023</span> * USA<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>package net.sourceforge.cobertura.util;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.BufferedReader;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.io.File;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.io.FileReader;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.io.FileWriter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.io.IOException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.ArrayList;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.List;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.log4j.Logger;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Helper class for storing long command lines inside temporary file.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * <p><a name="line.40"></a>
<span class="sourceLineNo">041</span> * Typical usage:<a name="line.41"></a>
<span class="sourceLineNo">042</span> * <a name="line.42"></a>
<span class="sourceLineNo">043</span> * <pre><a name="line.43"></a>
<span class="sourceLineNo">044</span> * builder = new CommandLineBuilder();<a name="line.44"></a>
<span class="sourceLineNo">045</span> * builder.addArg(&quot;--someoption&quot;);<a name="line.45"></a>
<span class="sourceLineNo">046</span> * builder.addArg(&quot;optionValue&quot;);<a name="line.46"></a>
<span class="sourceLineNo">047</span> * ...<a name="line.47"></a>
<span class="sourceLineNo">048</span> * builder.saveArgs();<a name="line.48"></a>
<span class="sourceLineNo">049</span> * doSomething(builder.getCommandLineFile());<a name="line.49"></a>
<span class="sourceLineNo">050</span> * builder.dispose();<a name="line.50"></a>
<span class="sourceLineNo">051</span> * </pre><a name="line.51"></a>
<span class="sourceLineNo">052</span> * <a name="line.52"></a>
<span class="sourceLineNo">053</span> * It will save options in <code>builder.getCommandLineFile()</code>. Options<a name="line.53"></a>
<span class="sourceLineNo">054</span> * will be stored one in a line. To retrieve options from file helper method can<a name="line.54"></a>
<span class="sourceLineNo">055</span> * be used (see documentation):<a name="line.55"></a>
<span class="sourceLineNo">056</span> * <a name="line.56"></a>
<span class="sourceLineNo">057</span> * <pre><a name="line.57"></a>
<span class="sourceLineNo">058</span> * String[] args = CommandLineBuilder.preprocessCommandLineArguments(args);<a name="line.58"></a>
<span class="sourceLineNo">059</span> * </pre><a name="line.59"></a>
<span class="sourceLineNo">060</span> * <a name="line.60"></a>
<span class="sourceLineNo">061</span> * </p><a name="line.61"></a>
<span class="sourceLineNo">062</span> * <a name="line.62"></a>
<span class="sourceLineNo">063</span> * <p><a name="line.63"></a>
<span class="sourceLineNo">064</span> * NOTICE: No protection against line separators in arguments, should be OK for<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Cobertura needs.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * </p><a name="line.66"></a>
<span class="sourceLineNo">067</span> * <p><a name="line.67"></a>
<span class="sourceLineNo">068</span> * NOTICE: This class depends on local machine settings (line separator, default<a name="line.68"></a>
<span class="sourceLineNo">069</span> * encoding). If arguments are saved on different machine than they are loaded,<a name="line.69"></a>
<span class="sourceLineNo">070</span> * results are unspecified. No problem in Cobertura.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * </p><a name="line.71"></a>
<span class="sourceLineNo">072</span> * <a name="line.72"></a>
<span class="sourceLineNo">073</span> * @author Grzegorz Lukasik<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span>public class CommandLineBuilder {<a name="line.75"></a>
<span class="sourceLineNo">076</span> private static final Logger logger = Logger<a name="line.76"></a>
<span class="sourceLineNo">077</span> .getLogger(CommandLineBuilder.class);<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> private static final String LINESEP = System.getProperty("line.separator");<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> // File that will be used to store arguments<a name="line.81"></a>
<span class="sourceLineNo">082</span> private File commandLineFile = null;<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> // Writer that will be used to write arguments to the file<a name="line.84"></a>
<span class="sourceLineNo">085</span> private FileWriter commandLineWriter = null;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Creates a new instance of the builder. Instances of this class should not<a name="line.88"></a>
<span class="sourceLineNo">089</span> * be reused to create many command lines.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * <a name="line.90"></a>
<span class="sourceLineNo">091</span> * @throws IOException<a name="line.91"></a>
<span class="sourceLineNo">092</span> * if problems with creating temporary file for storing command<a name="line.92"></a>
<span class="sourceLineNo">093</span> * line occur<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> public CommandLineBuilder() throws IOException {<a name="line.95"></a>
<span class="sourceLineNo">096</span> commandLineFile = File.createTempFile("cobertura.", ".cmdline");<a name="line.96"></a>
<span class="sourceLineNo">097</span> commandLineFile.deleteOnExit();<a name="line.97"></a>
<span class="sourceLineNo">098</span> commandLineWriter = new FileWriter(commandLineFile);<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> * Adds command line argument. Each argument can be thought as a single cell<a name="line.102"></a>
<span class="sourceLineNo">103</span> * in array passed to main method. This method should not be used after<a name="line.103"></a>
<span class="sourceLineNo">104</span> * arguments were saved.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * <a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param arg command line argument to save<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @throws IOException<a name="line.107"></a>
<span class="sourceLineNo">108</span> * if problems with temporary file occur<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @throws NullPointerException <a name="line.109"></a>
<span class="sourceLineNo">110</span> * if <code>arg</code> is <code>null</code> <a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public void addArg(String arg) throws IOException {<a name="line.112"></a>
<span class="sourceLineNo">113</span> if( arg==null)<a name="line.113"></a>
<span class="sourceLineNo">114</span> throw new NullPointerException();<a name="line.114"></a>
<span class="sourceLineNo">115</span> commandLineWriter.write(arg + LINESEP);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> <a name="line.118"></a>
<span class="sourceLineNo">119</span> /**<a name="line.119"></a>
<span class="sourceLineNo">120</span> * Adds two command line arguments. Convienience function, calls<a name="line.120"></a>
<span class="sourceLineNo">121</span> * {@link #addArg(String)} two times. <a name="line.121"></a>
<span class="sourceLineNo">122</span> * <a name="line.122"></a>
<span class="sourceLineNo">123</span> * @param arg1 first command line argument to save<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param arg2 second command line argument to save<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @throws IOException<a name="line.125"></a>
<span class="sourceLineNo">126</span> * if problems with temporary file occur<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @throws NullPointerException <a name="line.127"></a>
<span class="sourceLineNo">128</span> * if any <code>arg</code> is <code>null</code> <a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public void addArg(String arg1, String arg2) throws IOException {<a name="line.130"></a>
<span class="sourceLineNo">131</span> addArg(arg1);<a name="line.131"></a>
<span class="sourceLineNo">132</span> addArg(arg2);<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> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Saves options and made file available to use. Use method<a name="line.137"></a>
<span class="sourceLineNo">138</span> * {@link #getCommandLineFile} to get the file the arguments are saved in.<a name="line.138"></a>
<span class="sourceLineNo">139</span> * <a name="line.139"></a>
<span class="sourceLineNo">140</span> * @throws IOException<a name="line.140"></a>
<span class="sourceLineNo">141</span> * if problems with temporary file occur<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public void saveArgs() throws IOException {<a name="line.143"></a>
<span class="sourceLineNo">144</span> commandLineWriter.flush();<a name="line.144"></a>
<span class="sourceLineNo">145</span> commandLineWriter.close();<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<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> * Gets absolute path to the file with saved arguments. Notice, that however<a name="line.149"></a>
<span class="sourceLineNo">150</span> * this method can be used as soon as an instance of this class is created,<a name="line.150"></a>
<span class="sourceLineNo">151</span> * arguments should be read from the file after a call to<a name="line.151"></a>
<span class="sourceLineNo">152</span> * {@link #saveArgs} method.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * <a name="line.153"></a>
<span class="sourceLineNo">154</span> * @return absolute path to the file with arguments<a name="line.154"></a>
<span class="sourceLineNo">155</span> */<a name="line.155"></a>
<span class="sourceLineNo">156</span> public String getCommandLineFile() {<a name="line.156"></a>
<span class="sourceLineNo">157</span> return commandLineFile.getAbsolutePath();<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<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> * Explicity frees all resources associated with this instance. Result of<a name="line.161"></a>
<span class="sourceLineNo">162</span> * any other method call after disposing an instance of this class is<a name="line.162"></a>
<span class="sourceLineNo">163</span> * unspecified.<a name="line.163"></a>
<span class="sourceLineNo">164</span> */<a name="line.164"></a>
<span class="sourceLineNo">165</span> public void dispose() {<a name="line.165"></a>
<span class="sourceLineNo">166</span> commandLineFile.delete();<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Loads arguments from file if <code>--commandsfile</code> option is used. Checks<a name="line.170"></a>
<span class="sourceLineNo">171</span> * if passed array contains <code>--commandsfile</code> String, and if<a name="line.171"></a>
<span class="sourceLineNo">172</span> * so arguments from file specified in the very next array cell are read. If<a name="line.172"></a>
<span class="sourceLineNo">173</span> * there are more then one <code>--commandsfile</code> the result is unspecified. <a name="line.173"></a>
<span class="sourceLineNo">174</span> *<a name="line.174"></a>
<span class="sourceLineNo">175</span> * @return The list of arguments read from commandsfile, or<a name="line.175"></a>
<span class="sourceLineNo">176</span> * <code>args</code> if commandsfile option was not specified<a name="line.176"></a>
<span class="sourceLineNo">177</span> * or the file cannot be read.<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @throws NullPointerException if args is null, or any argument is null<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @throws IllegalArgumentException if --commandsfile is specified as last option<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @throws IOException if I/O related error with temporary command line file occur<a name="line.180"></a>
<span class="sourceLineNo">181</span> */<a name="line.181"></a>
<span class="sourceLineNo">182</span> public static String[] preprocessCommandLineArguments(String[] args) throws IOException {<a name="line.182"></a>
<span class="sourceLineNo">183</span> boolean hasCommandsFile = false;<a name="line.183"></a>
<span class="sourceLineNo">184</span> String commandsFileName = null;<a name="line.184"></a>
<span class="sourceLineNo">185</span> for (int i = 0; i < args.length; i++) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> if ( args[i].equals( "--commandsfile")) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> if( i==args.length-1) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> throw new IllegalArgumentException("'--commandsfile' specified as last option.");<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> hasCommandsFile = true;<a name="line.190"></a>
<span class="sourceLineNo">191</span> commandsFileName = args[++i];<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> if (hasCommandsFile) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> List arglist = new ArrayList();<a name="line.196"></a>
<span class="sourceLineNo">197</span> BufferedReader bufferedReader = null;<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> try {<a name="line.199"></a>
<span class="sourceLineNo">200</span> bufferedReader = new BufferedReader(new FileReader(<a name="line.200"></a>
<span class="sourceLineNo">201</span> commandsFileName));<a name="line.201"></a>
<span class="sourceLineNo">202</span> String line;<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> while ((line = bufferedReader.readLine()) != null)<a name="line.204"></a>
<span class="sourceLineNo">205</span> arglist.add(line);<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> } catch (IOException e) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> logger.info( "I/O error when reading temporary commands file", e);<a name="line.208"></a>
<span class="sourceLineNo">209</span> throw new IOException( "Unable to read temporary commands file "<a name="line.209"></a>
<span class="sourceLineNo">210</span> + commandsFileName + ".");<a name="line.210"></a>
<span class="sourceLineNo">211</span> } finally {<a name="line.211"></a>
<span class="sourceLineNo">212</span> if (bufferedReader != null) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> try {<a name="line.213"></a>
<span class="sourceLineNo">214</span> bufferedReader.close();<a name="line.214"></a>
<span class="sourceLineNo">215</span> } catch (IOException e) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<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> args = (String[]) arglist.toArray(new String[arglist.size()]);<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span> return args;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span>}<a name="line.224"></a>
</pre>
</div>
</body>
</html>
|