1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.io.file;
19
20 import java.io.IOException;
21 import java.nio.file.Files;
22 import java.nio.file.Path;
23 import java.nio.file.attribute.FileAttribute;
24
25 /**
26 * A temporary file path that deletes its delegate on close.
27 *
28 * @since 2.12.0
29 */
30 public class TempFile extends DeletablePath {
31
32 /**
33 * Creates a new instance for a new temporary file in the specified directory, using the given prefix to generate its
34 * name.
35 *
36 * @param dir See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
37 * @param prefix See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
38 * @param suffix See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
39 * @param attrs See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
40 * @return a new instance for a new temporary directory
41 * @throws IOException See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
42 */
43 public static TempFile create(final Path dir, final String prefix, final String suffix, final FileAttribute<?>... attrs) throws IOException {
44 return new TempFile(Files.createTempFile(dir, prefix, suffix, attrs));
45 }
46
47 /**
48 * Creates a new instance for a new temporary file in the specified directory, using the given prefix to generate its
49 * name.
50 *
51 * @param prefix See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
52 * @param suffix See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
53 * @param attrs See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
54 * @return a new instance for a new temporary directory
55 * @throws IOException See {@link Files#createTempFile(Path, String, String, FileAttribute...)}.
56 */
57 public static TempFile create(final String prefix, final String suffix, final FileAttribute<?>... attrs) throws IOException {
58 return new TempFile(Files.createTempFile(prefix, suffix, attrs));
59 }
60
61 /**
62 * Constructs a new instance wrapping the given delegate.
63 *
64 * @param path The delegate.
65 */
66 private TempFile(final Path path) {
67 super(path);
68 }
69
70 }