Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FileContent.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FileContent.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FileContent.html Thu Aug 15 20:56:06 2019 @@ -127,269 +127,266 @@ <span class="sourceLineNo">119</span> /**<a name="line.119"></a> <span class="sourceLineNo">120</span> * Returns the content of a file as a byte array.<a name="line.120"></a> <span class="sourceLineNo">121</span> *<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @param file The file to get the content of.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return The content as a byte array.<a name="line.123"></a> -<span class="sourceLineNo">124</span> * @throws IOException if the file content cannot be accessed.<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @since 2.4<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> default byte[] getByteArray() throws IOException {<a name="line.127"></a> -<span class="sourceLineNo">128</span> final long sizeL = getSize();<a name="line.128"></a> -<span class="sourceLineNo">129</span> if (sizeL > Integer.MAX_VALUE) {<a name="line.129"></a> -<span class="sourceLineNo">130</span> throw new IllegalStateException(String.format("File content is too large for a byte array: %,d", sizeL));<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span> final int size = (int) sizeL;<a name="line.132"></a> -<span class="sourceLineNo">133</span> final byte[] buf = new byte[size];<a name="line.133"></a> -<span class="sourceLineNo">134</span> try (final InputStream in = getInputStream(size)) {<a name="line.134"></a> -<span class="sourceLineNo">135</span> int read = 0;<a name="line.135"></a> -<span class="sourceLineNo">136</span> for (int pos = 0; pos < size && read >= 0; pos += read) {<a name="line.136"></a> -<span class="sourceLineNo">137</span> read = in.read(buf, pos, size - pos);<a name="line.137"></a> -<span class="sourceLineNo">138</span> }<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span> return buf;<a name="line.140"></a> -<span class="sourceLineNo">141</span> }<a name="line.141"></a> -<span class="sourceLineNo">142</span><a name="line.142"></a> -<span class="sourceLineNo">143</span> /**<a name="line.143"></a> -<span class="sourceLineNo">144</span> * Returns an input stream for reading the file's content.<a name="line.144"></a> -<span class="sourceLineNo">145</span> * <p><a name="line.145"></a> -<span class="sourceLineNo">146</span> * There may only be a single input or output stream open for the file at any time.<a name="line.146"></a> -<span class="sourceLineNo">147</span> * </p><a name="line.147"></a> -<span class="sourceLineNo">148</span> *<a name="line.148"></a> -<span class="sourceLineNo">149</span> * @param bufferSize The buffer size to use.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @return An input stream to read the file's content from. The input stream is buffered, so there is no need to<a name="line.150"></a> -<span class="sourceLineNo">151</span> * wrap it in a {@code BufferedInputStream}.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @throws FileSystemException If the file does not exist, or is being read, or is being written, or on error<a name="line.152"></a> -<span class="sourceLineNo">153</span> * opening the stream.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * @since 2.4<a name="line.154"></a> -<span class="sourceLineNo">155</span> */<a name="line.155"></a> -<span class="sourceLineNo">156</span> default InputStream getInputStream(int bufferSize) throws FileSystemException {<a name="line.156"></a> -<span class="sourceLineNo">157</span> return getInputStream();<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> * Determines the last-modified timestamp of the file.<a name="line.161"></a> -<span class="sourceLineNo">162</span> *<a name="line.162"></a> -<span class="sourceLineNo">163</span> * @return The last-modified timestamp.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @throws FileSystemException If the file does not exist, or is being written to, or on error determining the<a name="line.164"></a> -<span class="sourceLineNo">165</span> * last-modified timestamp.<a name="line.165"></a> -<span class="sourceLineNo">166</span> */<a name="line.166"></a> -<span class="sourceLineNo">167</span> long getLastModifiedTime() throws FileSystemException;<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> * Returns an output stream for writing the file's content.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * <p><a name="line.171"></a> -<span class="sourceLineNo">172</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.172"></a> -<span class="sourceLineNo">173</span> * it is replaced with whatever is written to the output stream.<a name="line.173"></a> -<span class="sourceLineNo">174</span> * </p><a name="line.174"></a> -<span class="sourceLineNo">175</span> * <p><a name="line.175"></a> -<span class="sourceLineNo">176</span> * There may only be a single input or output stream open for the file at any time.<a name="line.176"></a> -<span class="sourceLineNo">177</span> * </p><a name="line.177"></a> -<span class="sourceLineNo">178</span> *<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.179"></a> -<span class="sourceLineNo">180</span> * in a {@code BufferedOutputStream}.<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or on error opening<a name="line.181"></a> -<span class="sourceLineNo">182</span> * the stream.<a name="line.182"></a> -<span class="sourceLineNo">183</span> */<a name="line.183"></a> -<span class="sourceLineNo">184</span> OutputStream getOutputStream() throws FileSystemException;<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Returns an output stream for writing the file's content.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * <p><a name="line.188"></a> -<span class="sourceLineNo">189</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.189"></a> -<span class="sourceLineNo">190</span> * it is replaced with whatever is written to the output stream.<a name="line.190"></a> -<span class="sourceLineNo">191</span> * </p><a name="line.191"></a> -<span class="sourceLineNo">192</span> * <p><a name="line.192"></a> -<span class="sourceLineNo">193</span> * There may only be a single input or output stream open for the file at any time.<a name="line.193"></a> -<span class="sourceLineNo">194</span> * </p><a name="line.194"></a> -<span class="sourceLineNo">195</span> *<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @param bAppend true if you would like to append to the file. This may not be supported by all implementations.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.197"></a> -<span class="sourceLineNo">198</span> * in a {@code BufferedOutputStream}.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.199"></a> -<span class="sourceLineNo">200</span> * and the implementation does not support it, or on error opening the stream.<a name="line.200"></a> -<span class="sourceLineNo">201</span> */<a name="line.201"></a> -<span class="sourceLineNo">202</span> OutputStream getOutputStream(boolean bAppend) throws FileSystemException;<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> * Returns an output stream for writing the file's content.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> -<span class="sourceLineNo">207</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.207"></a> -<span class="sourceLineNo">208</span> * it is replaced with whatever is written to the output stream.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * </p><a name="line.209"></a> -<span class="sourceLineNo">210</span> * <p><a name="line.210"></a> -<span class="sourceLineNo">211</span> * There may only be a single input or output stream open for the file at any time.<a name="line.211"></a> -<span class="sourceLineNo">212</span> * </p><a name="line.212"></a> -<span class="sourceLineNo">213</span> *<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @param bAppend true if you would like to append to the file. This may not be supported by all implementations.<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @param bufferSize The buffer size to use.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.216"></a> -<span class="sourceLineNo">217</span> * in a {@code BufferedOutputStream}.<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.218"></a> -<span class="sourceLineNo">219</span> * and the implementation does not support it, or on error opening the stream.<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @since 2.4<a name="line.220"></a> -<span class="sourceLineNo">221</span> */<a name="line.221"></a> -<span class="sourceLineNo">222</span> default OutputStream getOutputStream(boolean bAppend, int bufferSize) throws FileSystemException {<a name="line.222"></a> -<span class="sourceLineNo">223</span> return getOutputStream(bAppend);<a name="line.223"></a> -<span class="sourceLineNo">224</span> }<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Returns an output stream for writing the file's content.<a name="line.227"></a> -<span class="sourceLineNo">228</span> * <p><a name="line.228"></a> -<span class="sourceLineNo">229</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.229"></a> -<span class="sourceLineNo">230</span> * it is replaced with whatever is written to the output stream.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * </p><a name="line.231"></a> -<span class="sourceLineNo">232</span> * <p><a name="line.232"></a> -<span class="sourceLineNo">233</span> * There may only be a single input or output stream open for the file at any time.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * </p><a name="line.234"></a> -<span class="sourceLineNo">235</span> *<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @param bufferSize The buffer size to use.<a name="line.236"></a> -<span class="sourceLineNo">237</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.237"></a> -<span class="sourceLineNo">238</span> * in a {@code BufferedOutputStream}.<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.239"></a> -<span class="sourceLineNo">240</span> * and the implementation does not support it, or on error opening the stream.<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @since 2.4<a name="line.241"></a> -<span class="sourceLineNo">242</span> */<a name="line.242"></a> -<span class="sourceLineNo">243</span> default OutputStream getOutputStream(int bufferSize) throws FileSystemException {<a name="line.243"></a> -<span class="sourceLineNo">244</span> return getOutputStream();<a name="line.244"></a> -<span class="sourceLineNo">245</span> }<a name="line.245"></a> -<span class="sourceLineNo">246</span><a name="line.246"></a> -<span class="sourceLineNo">247</span> /**<a name="line.247"></a> -<span class="sourceLineNo">248</span> * Returns an stream for reading/writing the file's content.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * <p><a name="line.249"></a> -<span class="sourceLineNo">250</span> * If the file does not exist, and you use one of the write* methods, this method creates it, and the parent folder,<a name="line.250"></a> -<span class="sourceLineNo">251</span> * if necessary. If the file does exist, parts of the file are replaced with whatever is written at a given<a name="line.251"></a> -<span class="sourceLineNo">252</span> * position.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * </p><a name="line.253"></a> -<span class="sourceLineNo">254</span> * <p><a name="line.254"></a> -<span class="sourceLineNo">255</span> * There may only be a single input or output stream open for the file at any time.<a name="line.255"></a> -<span class="sourceLineNo">256</span> * </p><a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @param mode The mode to use to access the file.<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @return the stream for reading and writing the file's content.<a name="line.259"></a> -<span class="sourceLineNo">260</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or on error opening<a name="line.260"></a> -<span class="sourceLineNo">261</span> * the stream.<a name="line.261"></a> -<span class="sourceLineNo">262</span> */<a name="line.262"></a> -<span class="sourceLineNo">263</span> RandomAccessContent getRandomAccessContent(final RandomAccessMode mode) throws FileSystemException;<a name="line.263"></a> -<span class="sourceLineNo">264</span><a name="line.264"></a> -<span class="sourceLineNo">265</span> /**<a name="line.265"></a> -<span class="sourceLineNo">266</span> * Determines the size of the file, in bytes.<a name="line.266"></a> -<span class="sourceLineNo">267</span> *<a name="line.267"></a> -<span class="sourceLineNo">268</span> * @return The size of the file, in bytes.<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @throws FileSystemException If the file does not exist, or is being written to, or on error determining the size.<a name="line.269"></a> -<span class="sourceLineNo">270</span> */<a name="line.270"></a> -<span class="sourceLineNo">271</span> long getSize() throws FileSystemException;<a name="line.271"></a> -<span class="sourceLineNo">272</span><a name="line.272"></a> -<span class="sourceLineNo">273</span> /**<a name="line.273"></a> -<span class="sourceLineNo">274</span> * Returns the content of a file as a String.<a name="line.274"></a> -<span class="sourceLineNo">275</span> *<a name="line.275"></a> -<span class="sourceLineNo">276</span> * @param file The file to get the content of.<a name="line.276"></a> -<span class="sourceLineNo">277</span> * @param charset The file character set, may be null.<a name="line.277"></a> -<span class="sourceLineNo">278</span> * @return The content as a byte array.<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @throws IOException if the file content cannot be accessed.<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @since 2.4<a name="line.280"></a> -<span class="sourceLineNo">281</span> */<a name="line.281"></a> -<span class="sourceLineNo">282</span> default String getString(final Charset charset) throws IOException {<a name="line.282"></a> -<span class="sourceLineNo">283</span> return new String(getByteArray(), charset == null ? Charset.defaultCharset() : charset);<a name="line.283"></a> -<span class="sourceLineNo">284</span> }<a name="line.284"></a> -<span class="sourceLineNo">285</span><a name="line.285"></a> -<span class="sourceLineNo">286</span> /**<a name="line.286"></a> -<span class="sourceLineNo">287</span> * Returns the content of a file as a String.<a name="line.287"></a> -<span class="sourceLineNo">288</span> *<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @param file The file to get the content of.<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param charset The file character set, may be null.<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @return The content as a byte array.<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @throws IOException if the file content cannot be accessed.<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @since 2.4<a name="line.293"></a> -<span class="sourceLineNo">294</span> */<a name="line.294"></a> -<span class="sourceLineNo">295</span> default String getString(final String charset) throws IOException {<a name="line.295"></a> -<span class="sourceLineNo">296</span> return new String(getByteArray(), charset == null ? Charset.defaultCharset().name() : charset);<a name="line.296"></a> -<span class="sourceLineNo">297</span> }<a name="line.297"></a> -<span class="sourceLineNo">298</span><a name="line.298"></a> -<span class="sourceLineNo">299</span> /**<a name="line.299"></a> -<span class="sourceLineNo">300</span> * Checks if an attribute of the file's content exists.<a name="line.300"></a> -<span class="sourceLineNo">301</span> *<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @param attrName The name of the attribute.<a name="line.302"></a> -<span class="sourceLineNo">303</span> * @return true if the attribute exists, false otherwise.<a name="line.303"></a> -<span class="sourceLineNo">304</span> * @throws FileSystemException If the file does not exist, or does not support attributes.<a name="line.304"></a> -<span class="sourceLineNo">305</span> */<a name="line.305"></a> -<span class="sourceLineNo">306</span> boolean hasAttribute(String attrName) throws FileSystemException;<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> /**<a name="line.308"></a> -<span class="sourceLineNo">309</span> * check if this file has open streams.<a name="line.309"></a> -<span class="sourceLineNo">310</span> *<a name="line.310"></a> -<span class="sourceLineNo">311</span> * @return true if the file is open, false otherwise.<a name="line.311"></a> -<span class="sourceLineNo">312</span> */<a name="line.312"></a> -<span class="sourceLineNo">313</span> boolean isOpen();<a name="line.313"></a> -<span class="sourceLineNo">314</span><a name="line.314"></a> -<span class="sourceLineNo">315</span> /**<a name="line.315"></a> -<span class="sourceLineNo">316</span> * Removes the value of an attribute of the file's content.<a name="line.316"></a> -<span class="sourceLineNo">317</span> *<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @param attrName The name of the attribute.<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @throws FileSystemException If the file does not exist, or is read-only, or does not support attributes, or on<a name="line.319"></a> -<span class="sourceLineNo">320</span> * error removing the attribute.<a name="line.320"></a> -<span class="sourceLineNo">321</span> */<a name="line.321"></a> -<span class="sourceLineNo">322</span> void removeAttribute(String attrName) throws FileSystemException;<a name="line.322"></a> -<span class="sourceLineNo">323</span><a name="line.323"></a> -<span class="sourceLineNo">324</span> /**<a name="line.324"></a> -<span class="sourceLineNo">325</span> * Sets the value of an attribute of the file's content. Creates the file if it does not exist.<a name="line.325"></a> -<span class="sourceLineNo">326</span> *<a name="line.326"></a> -<span class="sourceLineNo">327</span> * @param attrName The name of the attribute.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * @param value The value of the attribute.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @throws FileSystemException If the file does not exist, or is read-only, or does not support attributes, or on<a name="line.329"></a> -<span class="sourceLineNo">330</span> * error setting the attribute.<a name="line.330"></a> -<span class="sourceLineNo">331</span> */<a name="line.331"></a> -<span class="sourceLineNo">332</span> void setAttribute(String attrName, Object value) throws FileSystemException;<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> * Sets the last-modified timestamp of the file. Creates the file if it does not exist.<a name="line.335"></a> -<span class="sourceLineNo">336</span> *<a name="line.336"></a> -<span class="sourceLineNo">337</span> * @param modTime The time to set the last-modified timestamp to.<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @throws FileSystemException If the file is read-only, or is being written to, or on error setting the<a name="line.338"></a> -<span class="sourceLineNo">339</span> * last-modified timestamp.<a name="line.339"></a> -<span class="sourceLineNo">340</span> */<a name="line.340"></a> -<span class="sourceLineNo">341</span> void setLastModifiedTime(long modTime) throws FileSystemException;<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> * Writes this content to another FileContent.<a name="line.344"></a> -<span class="sourceLineNo">345</span> *<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @param output The target OutputStream.<a name="line.346"></a> -<span class="sourceLineNo">347</span> * @throws IOException if an error occurs writing the content.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @return the total number of bytes written<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @since 2.1<a name="line.349"></a> -<span class="sourceLineNo">350</span> */<a name="line.350"></a> -<span class="sourceLineNo">351</span> long write(FileContent output) throws IOException;<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> * Writes this content to another FileObject.<a name="line.354"></a> -<span class="sourceLineNo">355</span> *<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @param file The target FileObject.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @throws IOException if an error occurs writing the content.<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @return the total number of bytes written<a name="line.358"></a> -<span class="sourceLineNo">359</span> * @since 2.1<a name="line.359"></a> -<span class="sourceLineNo">360</span> */<a name="line.360"></a> -<span class="sourceLineNo">361</span> long write(FileObject file) throws IOException;<a name="line.361"></a> -<span class="sourceLineNo">362</span><a name="line.362"></a> -<span class="sourceLineNo">363</span> /**<a name="line.363"></a> -<span class="sourceLineNo">364</span> * Writes this content to an OutputStream.<a name="line.364"></a> -<span class="sourceLineNo">365</span> *<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @param output The target OutputStream.<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @return the total number of bytes written<a name="line.367"></a> -<span class="sourceLineNo">368</span> * @throws IOException if an error occurs writing the content.<a name="line.368"></a> -<span class="sourceLineNo">369</span> * @since 2.1<a name="line.369"></a> -<span class="sourceLineNo">370</span> */<a name="line.370"></a> -<span class="sourceLineNo">371</span> long write(OutputStream output) throws IOException;<a name="line.371"></a> -<span class="sourceLineNo">372</span><a name="line.372"></a> -<span class="sourceLineNo">373</span> /**<a name="line.373"></a> -<span class="sourceLineNo">374</span> * Writes this content to an OutputStream.<a name="line.374"></a> -<span class="sourceLineNo">375</span> *<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @param output The target OutputStream.<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @param bufferSize The buffer size to write data chunks.<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @return the total number of bytes written<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @throws IOException if an error occurs writing the file.<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @since 2.1<a name="line.380"></a> -<span class="sourceLineNo">381</span> */<a name="line.381"></a> -<span class="sourceLineNo">382</span> long write(OutputStream output, int bufferSize) throws IOException;<a name="line.382"></a> -<span class="sourceLineNo">383</span><a name="line.383"></a> -<span class="sourceLineNo">384</span>}<a name="line.384"></a> +<span class="sourceLineNo">122</span> * @return The content as a byte array.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @throws IOException if the file content cannot be accessed.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @since 2.4<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> default byte[] getByteArray() throws IOException {<a name="line.126"></a> +<span class="sourceLineNo">127</span> final long sizeL = getSize();<a name="line.127"></a> +<span class="sourceLineNo">128</span> if (sizeL > Integer.MAX_VALUE) {<a name="line.128"></a> +<span class="sourceLineNo">129</span> throw new IllegalStateException(String.format("File content is too large for a byte array: %,d", sizeL));<a name="line.129"></a> +<span class="sourceLineNo">130</span> }<a name="line.130"></a> +<span class="sourceLineNo">131</span> final int size = (int) sizeL;<a name="line.131"></a> +<span class="sourceLineNo">132</span> final byte[] buf = new byte[size];<a name="line.132"></a> +<span class="sourceLineNo">133</span> try (final InputStream in = getInputStream(size)) {<a name="line.133"></a> +<span class="sourceLineNo">134</span> int read = 0;<a name="line.134"></a> +<span class="sourceLineNo">135</span> for (int pos = 0; pos < size && read >= 0; pos += read) {<a name="line.135"></a> +<span class="sourceLineNo">136</span> read = in.read(buf, pos, size - pos);<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span> }<a name="line.138"></a> +<span class="sourceLineNo">139</span> return buf;<a name="line.139"></a> +<span class="sourceLineNo">140</span> }<a name="line.140"></a> +<span class="sourceLineNo">141</span><a name="line.141"></a> +<span class="sourceLineNo">142</span> /**<a name="line.142"></a> +<span class="sourceLineNo">143</span> * Returns an input stream for reading the file's content.<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <p><a name="line.144"></a> +<span class="sourceLineNo">145</span> * There may only be a single input or output stream open for the file at any time.<a name="line.145"></a> +<span class="sourceLineNo">146</span> * </p><a name="line.146"></a> +<span class="sourceLineNo">147</span> *<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @param bufferSize The buffer size to use.<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @return An input stream to read the file's content from. The input stream is buffered, so there is no need to<a name="line.149"></a> +<span class="sourceLineNo">150</span> * wrap it in a {@code BufferedInputStream}.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @throws FileSystemException If the file does not exist, or is being read, or is being written, or on error<a name="line.151"></a> +<span class="sourceLineNo">152</span> * opening the stream.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @since 2.4<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> default InputStream getInputStream(int bufferSize) throws FileSystemException {<a name="line.155"></a> +<span class="sourceLineNo">156</span> return getInputStream();<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<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> * Determines the last-modified timestamp of the file.<a name="line.160"></a> +<span class="sourceLineNo">161</span> *<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @return The last-modified timestamp.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @throws FileSystemException If the file does not exist, or is being written to, or on error determining the<a name="line.163"></a> +<span class="sourceLineNo">164</span> * last-modified timestamp.<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> long getLastModifiedTime() throws FileSystemException;<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> * Returns an output stream for writing the file's content.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * <p><a name="line.170"></a> +<span class="sourceLineNo">171</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.171"></a> +<span class="sourceLineNo">172</span> * it is replaced with whatever is written to the output stream.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * </p><a name="line.173"></a> +<span class="sourceLineNo">174</span> * <p><a name="line.174"></a> +<span class="sourceLineNo">175</span> * There may only be a single input or output stream open for the file at any time.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * </p><a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.178"></a> +<span class="sourceLineNo">179</span> * in a {@code BufferedOutputStream}.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or on error opening<a name="line.180"></a> +<span class="sourceLineNo">181</span> * the stream.<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> OutputStream getOutputStream() throws FileSystemException;<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Returns an output stream for writing the file's content.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * <p><a name="line.187"></a> +<span class="sourceLineNo">188</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.188"></a> +<span class="sourceLineNo">189</span> * it is replaced with whatever is written to the output stream.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * </p><a name="line.190"></a> +<span class="sourceLineNo">191</span> * <p><a name="line.191"></a> +<span class="sourceLineNo">192</span> * There may only be a single input or output stream open for the file at any time.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * </p><a name="line.193"></a> +<span class="sourceLineNo">194</span> *<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param bAppend true if you would like to append to the file. This may not be supported by all implementations.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.196"></a> +<span class="sourceLineNo">197</span> * in a {@code BufferedOutputStream}.<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.198"></a> +<span class="sourceLineNo">199</span> * and the implementation does not support it, or on error opening the stream.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> OutputStream getOutputStream(boolean bAppend) throws FileSystemException;<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> * Returns an output stream for writing the file's content.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * <p><a name="line.205"></a> +<span class="sourceLineNo">206</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.206"></a> +<span class="sourceLineNo">207</span> * it is replaced with whatever is written to the output stream.<a name="line.207"></a> +<span class="sourceLineNo">208</span> * </p><a name="line.208"></a> +<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> +<span class="sourceLineNo">210</span> * There may only be a single input or output stream open for the file at any time.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * </p><a name="line.211"></a> +<span class="sourceLineNo">212</span> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param bAppend true if you would like to append to the file. This may not be supported by all implementations.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param bufferSize The buffer size to use.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.215"></a> +<span class="sourceLineNo">216</span> * in a {@code BufferedOutputStream}.<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.217"></a> +<span class="sourceLineNo">218</span> * and the implementation does not support it, or on error opening the stream.<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @since 2.4<a name="line.219"></a> +<span class="sourceLineNo">220</span> */<a name="line.220"></a> +<span class="sourceLineNo">221</span> default OutputStream getOutputStream(boolean bAppend, int bufferSize) throws FileSystemException {<a name="line.221"></a> +<span class="sourceLineNo">222</span> return getOutputStream(bAppend);<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> +<span class="sourceLineNo">225</span> /**<a name="line.225"></a> +<span class="sourceLineNo">226</span> * Returns an output stream for writing the file's content.<a name="line.226"></a> +<span class="sourceLineNo">227</span> * <p><a name="line.227"></a> +<span class="sourceLineNo">228</span> * If the file does not exist, this method creates it, and the parent folder, if necessary. If the file does exist,<a name="line.228"></a> +<span class="sourceLineNo">229</span> * it is replaced with whatever is written to the output stream.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * </p><a name="line.230"></a> +<span class="sourceLineNo">231</span> * <p><a name="line.231"></a> +<span class="sourceLineNo">232</span> * There may only be a single input or output stream open for the file at any time.<a name="line.232"></a> +<span class="sourceLineNo">233</span> * </p><a name="line.233"></a> +<span class="sourceLineNo">234</span> *<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param bufferSize The buffer size to use.<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @return An output stream to write the file's content to. The stream is buffered, so there is no need to wrap it<a name="line.236"></a> +<span class="sourceLineNo">237</span> * in a {@code BufferedOutputStream}.<a name="line.237"></a> +<span class="sourceLineNo">238</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or bAppend is true<a name="line.238"></a> +<span class="sourceLineNo">239</span> * and the implementation does not support it, or on error opening the stream.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @since 2.4<a name="line.240"></a> +<span class="sourceLineNo">241</span> */<a name="line.241"></a> +<span class="sourceLineNo">242</span> default OutputStream getOutputStream(int bufferSize) throws FileSystemException {<a name="line.242"></a> +<span class="sourceLineNo">243</span> return getOutputStream();<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * Returns an stream for reading/writing the file's content.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * <p><a name="line.248"></a> +<span class="sourceLineNo">249</span> * If the file does not exist, and you use one of the write* methods, this method creates it, and the parent folder,<a name="line.249"></a> +<span class="sourceLineNo">250</span> * if necessary. If the file does exist, parts of the file are replaced with whatever is written at a given<a name="line.250"></a> +<span class="sourceLineNo">251</span> * position.<a name="line.251"></a> +<span class="sourceLineNo">252</span> * </p><a name="line.252"></a> +<span class="sourceLineNo">253</span> * <p><a name="line.253"></a> +<span class="sourceLineNo">254</span> * There may only be a single input or output stream open for the file at any time.<a name="line.254"></a> +<span class="sourceLineNo">255</span> * </p><a name="line.255"></a> +<span class="sourceLineNo">256</span> *<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param mode The mode to use to access the file.<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @return the stream for reading and writing the file's content.<a name="line.258"></a> +<span class="sourceLineNo">259</span> * @throws FileSystemException If the file is read-only, or is being read, or is being written, or on error opening<a name="line.259"></a> +<span class="sourceLineNo">260</span> * the stream.<a name="line.260"></a> +<span class="sourceLineNo">261</span> */<a name="line.261"></a> +<span class="sourceLineNo">262</span> RandomAccessContent getRandomAccessContent(final RandomAccessMode mode) throws FileSystemException;<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> /**<a name="line.264"></a> +<span class="sourceLineNo">265</span> * Determines the size of the file, in bytes.<a name="line.265"></a> +<span class="sourceLineNo">266</span> *<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @return The size of the file, in bytes.<a name="line.267"></a> +<span class="sourceLineNo">268</span> * @throws FileSystemException If the file does not exist, or is being written to, or on error determining the size.<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> long getSize() throws FileSystemException;<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Returns the content of a file as a String.<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @param charset The file character set, may be null.<a name="line.275"></a> +<span class="sourceLineNo">276</span> * @return The content as a byte array.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * @throws IOException if the file content cannot be accessed.<a name="line.277"></a> +<span class="sourceLineNo">278</span> * @since 2.4<a name="line.278"></a> +<span class="sourceLineNo">279</span> */<a name="line.279"></a> +<span class="sourceLineNo">280</span> default String getString(final Charset charset) throws IOException {<a name="line.280"></a> +<span class="sourceLineNo">281</span> return new String(getByteArray(), charset == null ? Charset.defaultCharset() : charset);<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> * Returns the content of a file as a String.<a name="line.285"></a> +<span class="sourceLineNo">286</span> *<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @param charset The file character set, may be null.<a name="line.287"></a> +<span class="sourceLineNo">288</span> * @return The content as a byte array.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @throws IOException if the file content cannot be accessed.<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @since 2.4<a name="line.290"></a> +<span class="sourceLineNo">291</span> */<a name="line.291"></a> +<span class="sourceLineNo">292</span> default String getString(final String charset) throws IOException {<a name="line.292"></a> +<span class="sourceLineNo">293</span> return new String(getByteArray(), charset == null ? Charset.defaultCharset().name() : charset);<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span><a name="line.295"></a> +<span class="sourceLineNo">296</span> /**<a name="line.296"></a> +<span class="sourceLineNo">297</span> * Checks if an attribute of the file's content exists.<a name="line.297"></a> +<span class="sourceLineNo">298</span> *<a name="line.298"></a> +<span class="sourceLineNo">299</span> * @param attrName The name of the attribute.<a name="line.299"></a> +<span class="sourceLineNo">300</span> * @return true if the attribute exists, false otherwise.<a name="line.300"></a> +<span class="sourceLineNo">301</span> * @throws FileSystemException If the file does not exist, or does not support attributes.<a name="line.301"></a> +<span class="sourceLineNo">302</span> */<a name="line.302"></a> +<span class="sourceLineNo">303</span> boolean hasAttribute(String attrName) throws FileSystemException;<a name="line.303"></a> +<span class="sourceLineNo">304</span><a name="line.304"></a> +<span class="sourceLineNo">305</span> /**<a name="line.305"></a> +<span class="sourceLineNo">306</span> * check if this file has open streams.<a name="line.306"></a> +<span class="sourceLineNo">307</span> *<a name="line.307"></a> +<span class="sourceLineNo">308</span> * @return true if the file is open, false otherwise.<a name="line.308"></a> +<span class="sourceLineNo">309</span> */<a name="line.309"></a> +<span class="sourceLineNo">310</span> boolean isOpen();<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> * Removes the value of an attribute of the file's content.<a name="line.313"></a> +<span class="sourceLineNo">314</span> *<a name="line.314"></a> +<span class="sourceLineNo">315</span> * @param attrName The name of the attribute.<a name="line.315"></a> +<span class="sourceLineNo">316</span> * @throws FileSystemException If the file does not exist, or is read-only, or does not support attributes, or on<a name="line.316"></a> +<span class="sourceLineNo">317</span> * error removing the attribute.<a name="line.317"></a> +<span class="sourceLineNo">318</span> */<a name="line.318"></a> +<span class="sourceLineNo">319</span> void removeAttribute(String attrName) throws FileSystemException;<a name="line.319"></a> +<span class="sourceLineNo">320</span><a name="line.320"></a> +<span class="sourceLineNo">321</span> /**<a name="line.321"></a> +<span class="sourceLineNo">322</span> * Sets the value of an attribute of the file's content. Creates the file if it does not exist.<a name="line.322"></a> +<span class="sourceLineNo">323</span> *<a name="line.323"></a> +<span class="sourceLineNo">324</span> * @param attrName The name of the attribute.<a name="line.324"></a> +<span class="sourceLineNo">325</span> * @param value The value of the attribute.<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @throws FileSystemException If the file does not exist, or is read-only, or does not support attributes, or on<a name="line.326"></a> +<span class="sourceLineNo">327</span> * error setting the attribute.<a name="line.327"></a> +<span class="sourceLineNo">328</span> */<a name="line.328"></a> +<span class="sourceLineNo">329</span> void setAttribute(String attrName, Object value) throws FileSystemException;<a name="line.329"></a> +<span class="sourceLineNo">330</span><a name="line.330"></a> +<span class="sourceLineNo">331</span> /**<a name="line.331"></a> +<span class="sourceLineNo">332</span> * Sets the last-modified timestamp of the file. Creates the file if it does not exist.<a name="line.332"></a> +<span class="sourceLineNo">333</span> *<a name="line.333"></a> +<span class="sourceLineNo">334</span> * @param modTime The time to set the last-modified timestamp to.<a name="line.334"></a> +<span class="sourceLineNo">335</span> * @throws FileSystemException If the file is read-only, or is being written to, or on error setting the<a name="line.335"></a> +<span class="sourceLineNo">336</span> * last-modified timestamp.<a name="line.336"></a> +<span class="sourceLineNo">337</span> */<a name="line.337"></a> +<span class="sourceLineNo">338</span> void setLastModifiedTime(long modTime) throws FileSystemException;<a name="line.338"></a> +<span class="sourceLineNo">339</span><a name="line.339"></a> +<span class="sourceLineNo">340</span> /**<a name="line.340"></a> +<span class="sourceLineNo">341</span> * Writes this content to another FileContent.<a name="line.341"></a> +<span class="sourceLineNo">342</span> *<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @param output The target OutputStream.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @throws IOException if an error occurs writing the content.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * @return the total number of bytes written<a name="line.345"></a> +<span class="sourceLineNo">346</span> * @since 2.1<a name="line.346"></a> +<span class="sourceLineNo">347</span> */<a name="line.347"></a> +<span class="sourceLineNo">348</span> long write(FileContent output) throws IOException;<a name="line.348"></a> +<span class="sourceLineNo">349</span><a name="line.349"></a> +<span class="sourceLineNo">350</span> /**<a name="line.350"></a> +<span class="sourceLineNo">351</span> * Writes this content to another FileObject.<a name="line.351"></a> +<span class="sourceLineNo">352</span> *<a name="line.352"></a> +<span class="sourceLineNo">353</span> * @param file The target FileObject.<a name="line.353"></a> +<span class="sourceLineNo">354</span> * @throws IOException if an error occurs writing the content.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @return the total number of bytes written<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @since 2.1<a name="line.356"></a> +<span class="sourceLineNo">357</span> */<a name="line.357"></a> +<span class="sourceLineNo">358</span> long write(FileObject file) throws IOException;<a name="line.358"></a> +<span class="sourceLineNo">359</span><a name="line.359"></a> +<span class="sourceLineNo">360</span> /**<a name="line.360"></a> +<span class="sourceLineNo">361</span> * Writes this content to an OutputStream.<a name="line.361"></a> +<span class="sourceLineNo">362</span> *<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @param output The target OutputStream.<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @return the total number of bytes written<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @throws IOException if an error occurs writing the content.<a name="line.365"></a> +<span class="sourceLineNo">366</span> * @since 2.1<a name="line.366"></a> +<span class="sourceLineNo">367</span> */<a name="line.367"></a> +<span class="sourceLineNo">368</span> long write(OutputStream output) throws IOException;<a name="line.368"></a> +<span class="sourceLineNo">369</span><a name="line.369"></a> +<span class="sourceLineNo">370</span> /**<a name="line.370"></a> +<span class="sourceLineNo">371</span> * Writes this content to an OutputStream.<a name="line.371"></a> +<span class="sourceLineNo">372</span> *<a name="line.372"></a> +<span class="sourceLineNo">373</span> * @param output The target OutputStream.<a name="line.373"></a> +<span class="sourceLineNo">374</span> * @param bufferSize The buffer size to write data chunks.<a name="line.374"></a> +<span class="sourceLineNo">375</span> * @return the total number of bytes written<a name="line.375"></a> +<span class="sourceLineNo">376</span> * @throws IOException if an error occurs writing the file.<a name="line.376"></a> +<span class="sourceLineNo">377</span> * @since 2.1<a name="line.377"></a> +<span class="sourceLineNo">378</span> */<a name="line.378"></a> +<span class="sourceLineNo">379</span> long write(OutputStream output, int bufferSize) throws IOException;<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>
Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FilesCache.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FilesCache.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/FilesCache.html Thu Aug 15 20:56:06 2019 @@ -47,11 +47,11 @@ <span class="sourceLineNo">039</span> /**<a name="line.39"></a> <span class="sourceLineNo">040</span> * Retrieves a FileObject from the cache by name.<a name="line.40"></a> <span class="sourceLineNo">041</span> *<a name="line.41"></a> -<span class="sourceLineNo">042</span> * @param file system The FileSystem.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * @param name the name<a name="line.43"></a> +<span class="sourceLineNo">042</span> * @param fileSystem The FileSystem.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * @param fileName the name<a name="line.43"></a> <span class="sourceLineNo">044</span> * @return the file object or null if file is not cached<a name="line.44"></a> <span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> FileObject getFile(final FileSystem fileSystem, final FileName name);<a name="line.46"></a> +<span class="sourceLineNo">046</span> FileObject getFile(final FileSystem fileSystem, final FileName fileName);<a name="line.46"></a> <span class="sourceLineNo">047</span><a name="line.47"></a> <span class="sourceLineNo">048</span> /**<a name="line.48"></a> <span class="sourceLineNo">049</span> * Purges the entries corresponding to the FileSystem.<a name="line.49"></a> Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/impl/VirtualFileSystem.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/impl/VirtualFileSystem.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/impl/VirtualFileSystem.html Thu Aug 15 20:56:06 2019 @@ -43,7 +43,7 @@ <span class="sourceLineNo">035</span> * A logical file system, made up of set of junctions, or links, to files from other file systems.<a name="line.35"></a> <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> <span class="sourceLineNo">037</span> * TODO - Handle nested junctions.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">038</span> * </p><a name="line.38"></a> <span class="sourceLineNo">039</span> */<a name="line.39"></a> <span class="sourceLineNo">040</span>public class VirtualFileSystem extends AbstractFileSystem {<a name="line.40"></a> <span class="sourceLineNo">041</span> private final Map<FileName, FileObject> junctions = new HashMap<>();<a name="line.41"></a> Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/DefaultFileContent.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/DefaultFileContent.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/DefaultFileContent.html Thu Aug 15 20:56:06 2019 @@ -348,7 +348,7 @@ <span class="sourceLineNo">340</span> */<a name="line.340"></a> <span class="sourceLineNo">341</span> @Override<a name="line.341"></a> <span class="sourceLineNo">342</span> public InputStream getInputStream() throws FileSystemException {<a name="line.342"></a> -<span class="sourceLineNo">343</span> return buildInputStream(null);<a name="line.343"></a> +<span class="sourceLineNo">343</span> return buildInputStream(0);<a name="line.343"></a> <span class="sourceLineNo">344</span> }<a name="line.344"></a> <span class="sourceLineNo">345</span><a name="line.345"></a> <span class="sourceLineNo">346</span> /**<a name="line.346"></a> @@ -409,7 +409,7 @@ <span class="sourceLineNo">401</span> */<a name="line.401"></a> <span class="sourceLineNo">402</span> @Override<a name="line.402"></a> <span class="sourceLineNo">403</span> public OutputStream getOutputStream(final boolean bAppend) throws FileSystemException {<a name="line.403"></a> -<span class="sourceLineNo">404</span> return buildOutputStream(bAppend, null);<a name="line.404"></a> +<span class="sourceLineNo">404</span> return buildOutputStream(bAppend, 0);<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> @@ -493,7 +493,7 @@ <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><a name="line.487"></a> -<span class="sourceLineNo">488</span> private InputStream buildInputStream(final Integer bufferSize) throws FileSystemException {<a name="line.488"></a> +<span class="sourceLineNo">488</span> private InputStream buildInputStream(final int bufferSize) throws FileSystemException {<a name="line.488"></a> <span class="sourceLineNo">489</span> /*<a name="line.489"></a> <span class="sourceLineNo">490</span> * if (getThreadData().getState() == STATE_WRITING || getThreadData().getState() == STATE_RANDOM_ACCESS) { throw<a name="line.490"></a> <span class="sourceLineNo">491</span> * new FileSystemException("vfs.provider/read-in-use.error", file); }<a name="line.491"></a> @@ -502,7 +502,7 @@ <span class="sourceLineNo">494</span> // Get the raw input stream<a name="line.494"></a> <span class="sourceLineNo">495</span> final InputStream inputStream = fileObject.getInputStream();<a name="line.495"></a> <span class="sourceLineNo">496</span><a name="line.496"></a> -<span class="sourceLineNo">497</span> final InputStream wrappedInputStream = bufferSize == null ?<a name="line.497"></a> +<span class="sourceLineNo">497</span> final InputStream wrappedInputStream = bufferSize == 0 ?<a name="line.497"></a> <span class="sourceLineNo">498</span> new FileContentInputStream(fileObject, inputStream) :<a name="line.498"></a> <span class="sourceLineNo">499</span> new FileContentInputStream(fileObject, inputStream, bufferSize);<a name="line.499"></a> <span class="sourceLineNo">500</span><a name="line.500"></a> @@ -512,7 +512,7 @@ <span class="sourceLineNo">504</span> return wrappedInputStream;<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> private OutputStream buildOutputStream(final boolean bAppend, final Integer bufferSize) throws FileSystemException {<a name="line.507"></a> +<span class="sourceLineNo">507</span> private OutputStream buildOutputStream(final boolean bAppend, final int bufferSize) throws FileSystemException {<a name="line.507"></a> <span class="sourceLineNo">508</span> /*<a name="line.508"></a> <span class="sourceLineNo">509</span> * if (getThreadData().getState() != STATE_NONE)<a name="line.509"></a> <span class="sourceLineNo">510</span> */<a name="line.510"></a> @@ -526,7 +526,7 @@ <span class="sourceLineNo">518</span> final OutputStream outstr = fileObject.getOutputStream(bAppend);<a name="line.518"></a> <span class="sourceLineNo">519</span><a name="line.519"></a> <span class="sourceLineNo">520</span> // Create and set wrapper<a name="line.520"></a> -<span class="sourceLineNo">521</span> final FileContentOutputStream wrapped = bufferSize == null ?<a name="line.521"></a> +<span class="sourceLineNo">521</span> final FileContentOutputStream wrapped = bufferSize == 0 ?<a name="line.521"></a> <span class="sourceLineNo">522</span> new FileContentOutputStream(fileObject, outstr) :<a name="line.522"></a> <span class="sourceLineNo">523</span> new FileContentOutputStream(fileObject, outstr, bufferSize);<a name="line.523"></a> <span class="sourceLineNo">524</span> streams.setOutstr(wrapped);<a name="line.524"></a> Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/LayeredFileNameParser.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/LayeredFileNameParser.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/LayeredFileNameParser.html Thu Aug 15 20:56:06 2019 @@ -62,13 +62,13 @@ <span class="sourceLineNo">054</span> * Parses the base and name into a FileName.<a name="line.54"></a> <span class="sourceLineNo">055</span> *<a name="line.55"></a> <span class="sourceLineNo">056</span> * @param context The component context.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param base The base FileName.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param file name The target file name.<a name="line.58"></a> +<span class="sourceLineNo">057</span> * @param baseFileName The base FileName.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param fileName name The target file name.<a name="line.58"></a> <span class="sourceLineNo">059</span> * @return The constructed FileName.<a name="line.59"></a> <span class="sourceLineNo">060</span> * @throws FileSystemException if an error occurs.<a name="line.60"></a> <span class="sourceLineNo">061</span> */<a name="line.61"></a> <span class="sourceLineNo">062</span> @Override<a name="line.62"></a> -<span class="sourceLineNo">063</span> public FileName parseUri(final VfsComponentContext context, final FileName base, final String fileName)<a name="line.63"></a> +<span class="sourceLineNo">063</span> public FileName parseUri(final VfsComponentContext context, final FileName baseFileName, final String fileName)<a name="line.63"></a> <span class="sourceLineNo">064</span> throws FileSystemException {<a name="line.64"></a> <span class="sourceLineNo">065</span> final StringBuilder name = new StringBuilder();<a name="line.65"></a> <span class="sourceLineNo">066</span><a name="line.66"></a> Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/bzip2/Bzip2FileObject.html Thu Aug 15 20:56:06 2019 @@ -45,7 +45,7 @@ <span class="sourceLineNo">037</span> *<a name="line.37"></a> <span class="sourceLineNo">038</span> * @param name Abstract file name.<a name="line.38"></a> <span class="sourceLineNo">039</span> * @param container My container.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @param container My file system.<a name="line.40"></a> +<span class="sourceLineNo">040</span> * @param fs My file system.<a name="line.40"></a> <span class="sourceLineNo">041</span> *<a name="line.41"></a> <span class="sourceLineNo">042</span> * @deprecated Use {@link #Bzip2FileObject(AbstractFileName, FileObject, Bzip2FileSystem)} instead.<a name="line.42"></a> <span class="sourceLineNo">043</span> */<a name="line.43"></a> Modified: websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/gzip/GzipFileObject.html ============================================================================== --- websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/gzip/GzipFileObject.html (original) +++ websites/production/commons/content/proper/commons-vfs/commons-vfs2/apidocs/src-html/org/apache/commons/vfs2/provider/gzip/GzipFileObject.html Thu Aug 15 20:56:06 2019 @@ -44,7 +44,7 @@ <span class="sourceLineNo">036</span> *<a name="line.36"></a> <span class="sourceLineNo">037</span> * @param name Abstract file name.<a name="line.37"></a> <span class="sourceLineNo">038</span> * @param container My container.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @param container My file system.<a name="line.39"></a> +<span class="sourceLineNo">039</span> * @param fs My file system.<a name="line.39"></a> <span class="sourceLineNo">040</span> *<a name="line.40"></a> <span class="sourceLineNo">041</span> * @deprecated Use {@link #GzipFileObject(AbstractFileName, FileObject, GzipFileSystem)} instead.<a name="line.41"></a> <span class="sourceLineNo">042</span> */<a name="line.42"></a>