forked from assertj/assertj
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFiles.java
More file actions
316 lines (293 loc) · 10.8 KB
/
Files.java
File metadata and controls
316 lines (293 loc) · 10.8 KB
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2020 the original author or authors.
*/
package org.assertj.core.util;
import static java.io.File.separator;
import static java.util.Objects.requireNonNull;
import static org.assertj.core.util.Arrays.isNullOrEmpty;
import static org.assertj.core.util.Preconditions.checkArgument;
import static org.assertj.core.util.Strings.append;
import static org.assertj.core.util.Strings.concat;
import static org.assertj.core.util.Strings.quote;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
/**
* Utility methods related to files.
*
* @author Yvonne Wang
* @author Alex Ruiz
*/
public class Files {
/**
* Returns the names of the files inside the specified directory.
*
* @param dirName the name of the directory to start the search from.
* @param recurse if {@code true}, we will look in subdirectories.
* @return the names of the files inside the specified directory.
* @throws IllegalArgumentException if the given directory name does not point to an existing directory.
*/
public static List<String> fileNamesIn(String dirName, boolean recurse) {
File dir = new File(dirName);
checkArgument(dir.isDirectory(), "%s is not a directory", quote(dirName));
return fileNamesIn(dir, recurse);
}
/**
* Returns the names of the files inside the specified directory.
*
* @param dir the name of the directory to start the search from.
* @param recurse if {@code true}, we will look in subdirectories.
* @return the names of the files inside the specified directory.
*/
private static List<String> fileNamesIn(File dir, boolean recurse) {
List<String> scriptNames = new ArrayList<>();
File[] existingFiles = dir.listFiles();
if (isNullOrEmpty(existingFiles)) {
return scriptNames;
}
for (File existingFile : existingFiles) {
if (existingFile.isDirectory()) {
if (recurse) {
scriptNames.addAll(fileNamesIn(existingFile, recurse));
}
continue;
}
String filename = existingFile.getAbsolutePath();
if (!scriptNames.contains(filename)) {
scriptNames.add(filename);
}
}
return scriptNames;
}
/**
* Returns the system's temporary directory.
*
* @return the system's temporary directory.
* @throws RuntimeException if this method cannot find or create the system's temporary directory.
*
* @deprecated Use either {@link org.junit.jupiter.api.io.TempDir} or {@link org.junit.rules.TemporaryFolder}
*/
@Deprecated
public static File temporaryFolder() {
File temp = new File(temporaryFolderPath());
if (!temp.isDirectory()) {
throw new RuntimeException("Unable to find temporary directory");
}
return temp;
}
/**
* Returns the path of the system's temporary directory. This method appends the system's file separator at the end of
* the path.
*
* @return the path of the system's temporary directory.
*/
public static String temporaryFolderPath() {
return append(separator).to(System.getProperty("java.io.tmpdir"));
}
/**
* Creates a new file in the system's temporary directory. The name of the file will be the result of:
* <pre><code class='java'> concat(UUID.randomUUID().toString(), ".txt");</code></pre>
*
* @return the created file.
*/
public static File newTemporaryFile() {
String tempFileName = concat(UUID.randomUUID().toString(), ".txt");
return newFile(concat(temporaryFolderPath(), tempFileName));
}
/**
* Creates a new directory in the system's temporary directory. The name of the directory will be the result of:
* <pre><code class='java'> UUID.randomUUID().toString();</code></pre>
*
* @return the created file.
*/
public static File newTemporaryFolder() {
String tempFileName = UUID.randomUUID().toString();
return newFolder(concat(temporaryFolderPath(), tempFileName));
}
/**
* Creates a new file using the given path.
*
* @param path the path of the new file.
* @return the new created file.
* @throws RuntimeException if the path belongs to an existing non-empty directory.
* @throws RuntimeException if the path belongs to an existing file.
* @throws UncheckedIOException if any I/O error is thrown when creating the new file.
*/
public static File newFile(String path) {
File file = createFileIfPathIsNotANonEmptyDirectory(path);
try {
if (!file.createNewFile()) {
throw cannotCreateNewFile(path, "a file was found with the same path");
}
} catch (IOException e) {
throw cannotCreateNewFile(path, e);
}
return file;
}
/**
* Creates a new directory using the given path.
*
* @param path the path of the new directory.
* @return the new created directory.
* @throws RuntimeException if the path belongs to an existing non-empty directory.
* @throws RuntimeException if the path belongs to an existing file.
* @throws RuntimeException if any I/O error is thrown when creating the new directory.
*/
public static File newFolder(String path) {
File file = createFileIfPathIsNotANonEmptyDirectory(path);
try {
if (!file.mkdir()) {
throw cannotCreateNewFile(path, "a file was found with the same path");
}
} catch (Exception e) {
throw cannotCreateNewFile(path, e);
}
return file;
}
private static File createFileIfPathIsNotANonEmptyDirectory(String path) {
File file = new File(path);
if (file.isDirectory() && !isNullOrEmpty(file.list())) {
throw cannotCreateNewFile(path, "a non-empty directory was found with the same path");
}
return file;
}
private static UncheckedIOException cannotCreateNewFile(String path, String reason) {
throw cannotCreateNewFile(path, reason, null);
}
private static UncheckedIOException cannotCreateNewFile(String path, Exception cause) {
throw cannotCreateNewFile(path, null, cause);
}
private static UncheckedIOException cannotCreateNewFile(String path, String reason, Exception cause) {
String message = String.format("Unable to create the new file %s", quote(path));
if (!Strings.isNullOrEmpty(reason)) {
message = concat(message, ": ", reason);
}
if (cause == null) {
throw new RuntimeException(message);
}
if (cause instanceof IOException) {
throw new UncheckedIOException(message, (IOException) cause);
}
throw new RuntimeException(message, cause);
}
/**
* Returns the current directory.
*
* @return the current directory.
* @throws UncheckedIOException if the current directory cannot be obtained.
*/
public static File currentFolder() {
try {
return new File(".").getCanonicalFile();
} catch (IOException e) {
throw new UncheckedIOException("Unable to get current directory", e);
}
}
/**
* Deletes the given file or directory.
*
* @param file the file or directory to delete.
*
* @deprecated use https://commons.apache.org/proper/commons-io/javadocs/api-release/org/apache/commons/io/FileUtils.html#forceDelete-java.io.File- instead
*/
@Deprecated
public static void delete(File file) {
if (file.isFile()) {
if (!file.delete()) {
System.out.println("Fail to delete " + file);
}
return;
}
if (!file.isDirectory()) {
return;
}
File[] existingFiles = file.listFiles();
if (!isNullOrEmpty(existingFiles)) {
for (File f : existingFiles) {
delete(f);
}
}
if (!file.delete()) {
System.out.println("Fail to delete " + file);
}
}
/**
* Loads the text content of a file into a character string.
*
* @param file the file.
* @param charsetName the name of the character set to use.
* @return the content of the file.
* @throws IllegalArgumentException if the given character set is not supported on this platform.
* @throws UncheckedIOException if an I/O exception occurs.
*/
public static String contentOf(File file, String charsetName) {
checkArgumentCharsetIsSupported(charsetName);
return contentOf(file, Charset.forName(charsetName));
}
/**
* Loads the text content of a file into a character string.
*
* @param file the file.
* @param charset the character set to use.
* @return the content of the file.
* @throws NullPointerException if the given charset is {@code null}.
* @throws UncheckedIOException if an I/O exception occurs.
*/
public static String contentOf(File file, Charset charset) {
requireNonNull(charset, "The charset should not be null");
try {
return new String(java.nio.file.Files.readAllBytes(file.toPath()), charset);
} catch (IOException e) {
throw new UncheckedIOException("Unable to read " + file.getAbsolutePath(), e);
}
}
/**
* Loads the text content of a file into a list of strings, each string corresponding to a line. The line endings are
* either \n, \r or \r\n.
*
* @param file the file.
* @param charset the character set to use.
* @return the content of the file.
* @throws NullPointerException if the given charset is {@code null}.
* @throws UncheckedIOException if an I/O exception occurs.
*/
public static List<String> linesOf(File file, Charset charset) {
requireNonNull(charset, "The charset should not be null");
try {
return java.nio.file.Files.readAllLines(file.toPath(), charset);
} catch (IOException e) {
throw new UncheckedIOException("Unable to read " + file.getAbsolutePath(), e);
}
}
/**
* Loads the text content of a file into a list of strings, each string corresponding to a line. The line endings are
* either \n, \r or \r\n.
*
* @param file the file.
* @param charsetName the name of the character set to use.
* @return the content of the file.
* @throws NullPointerException if the given charset is {@code null}.
* @throws UncheckedIOException if an I/O exception occurs.
*/
public static List<String> linesOf(File file, String charsetName) {
checkArgumentCharsetIsSupported(charsetName);
return linesOf(file, Charset.forName(charsetName));
}
private static void checkArgumentCharsetIsSupported(String charsetName) {
checkArgument(Charset.isSupported(charsetName), "Charset:<'%s'> is not supported on this system", charsetName);
}
private Files() {}
}