| <!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="../../../../../javadoc.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 contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.internal;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static org.apache.juneau.internal.ThrowableUtils.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static org.apache.juneau.internal.ArgUtils.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.nio.file.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * File utilities.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> *<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <ul class='seealso'><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <li class='extlink'>{@source}<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * </ul><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public class FileUtils {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Same as {@link File#mkdirs()} except throws a RuntimeExeption if directory could not be created.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> *<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @param f The directory to create. Must not be <jk>null</jk>.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @return The same file.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @throws RuntimeException if directory could not be created.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> public static File mkdirs(File f, boolean clean) {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> assertArgNotNull("f", f);<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> if (f.exists()) {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> if (clean) {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> if (! delete(f))<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> throw new BasicRuntimeException("Could not clean directory ''{0}''", f.getAbsolutePath());<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> } else {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> return f;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> }<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> }<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> if (! f.mkdirs())<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> throw new BasicRuntimeException("Could not create directory ''{0}''", f.getAbsolutePath());<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> return f;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> }<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Same as {@link #mkdirs(String, boolean)} but uses String path.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> *<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param path The path of the directory to create. Must not be <jk>null</jk><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @return The directory.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static File mkdirs(String path, boolean clean) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> assertArgNotNull("path", path);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> return mkdirs(new File(path), clean);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Recursively deletes a file or directory.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> *<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param f The file or directory to delete.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return <jk>true</jk> if file or directory was successfully deleted.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public static boolean delete(File f) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> if (f == null)<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return true;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> if (f.isDirectory()) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> File[] cf = f.listFiles();<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> if (cf != null)<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> for (File c : cf)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> delete(c);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> return f.delete();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Creates a file if it doesn't already exist using {@link File#createNewFile()}.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <p><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Throws a {@link RuntimeException} if the file could not be created.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param f The file to create.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public static void create(File f) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> if (f.exists())<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> return;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> try {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> if (! f.createNewFile())<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> throw new BasicRuntimeException("Could not create file ''{0}''", f.getAbsolutePath());<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> } catch (IOException e) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> throw asRuntimeException(e);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Updates the modified timestamp on the specified file.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <p><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Method ensures that the timestamp changes even if it's been modified within the past millisecond.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> *<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param f The file to modify the modified timestamp on.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public static void modifyTimestamp(File f) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> long lm = f.lastModified();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> long l = System.currentTimeMillis();<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> if (lm == l)<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> l++;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (! f.setLastModified(l))<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> throw new BasicRuntimeException("Could not modify timestamp on file ''{0}''", f.getAbsolutePath());<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> // Linux only gives 1s precision, so set the date 1s into the future.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> if (lm == f.lastModified()) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> l += 1000;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (! f.setLastModified(l))<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> throw new BasicRuntimeException("Could not modify timestamp on file ''{0}''", f.getAbsolutePath());<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> /**<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * Create a temporary file with the specified name.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> *<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <p><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * The name is broken into file name and suffix, and the parts are passed to<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * {@link File#createTempFile(String, String)}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <p><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> *<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param name The file name<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @return A newly-created temporary file.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @throws IOException Thrown by underlying stream.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public static File createTempFile(String name) throws IOException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> String[] parts = name.split("\\.");<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> File f = File.createTempFile(parts[0], "." + parts[1]);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> f.deleteOnExit();<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return f;<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> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Create a temporary file with the specified name and specified contents.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> *<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * <p><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * The name is broken into file name and suffix, and the parts are passed to<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * {@link File#createTempFile(String, String)}.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * <p><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @param name The file name<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param contents The file contents.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return A newly-created temporary file.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @throws IOException Thrown by underlying stream.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public static File createTempFile(String name, String contents) throws IOException {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> File f = createTempFile(name);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> try (Reader r = new StringReader(contents); Writer w = new FileWriter(f)) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> IOUtils.pipe(r, w);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> w.flush();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return f;<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> };<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Strips the extension from a file name.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> *<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @param name The file name.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @return The file name without the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public static String getBaseName(String name) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> if (name == null)<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return null;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> int i = name.lastIndexOf('.');<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> if (i == -1)<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return name;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> return name.substring(0, i);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Returns the extension from a file name.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> *<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @param name The file name.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @return The the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public static String getExtension(String name) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (name == null)<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> return null;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> int i = name.lastIndexOf('.');<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> if (i == -1)<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> return "";<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> return name.substring(i+1);<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> * Returns <jk>true</jk> if the specified file exists in the specified directory.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> *<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * @param dir The directory.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param fileName The file name.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * @return <jk>true</jk> if the specified file exists in the specified directory.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> */<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> public static boolean exists(File dir, String fileName) {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> if (dir == null || fileName == null)<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return false;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> return Files.exists(dir.toPath().resolve(fileName));<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<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> * Returns <jk>true</jk> if the specified file name contains the specified extension.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> *<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @param name The file name.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param ext The extension.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @return <jk>true</jk> if the specified file name contains the specified extension.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> */<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> public static boolean hasExtension(String name, String ext) {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> if (name == null || ext == null)<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return false;<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> return ext.equals(getExtension(name));<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> /**<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * Given an arbitrary path, returns the file name portion of that path.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> *<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @param path The path to check.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @return The file name.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> */<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> public static String getFileName(String path) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> if (isEmpty(path))<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> return null;<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> path = trimTrailingSlashes(path);<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> int i = path.lastIndexOf('/');<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return i == -1 ? path : path.substring(i+1);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span>}<a name="line.243"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
