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 directory path that deletes its delegate on close.
27 *
28 * @since 2.12.0
29 */
30 public class TempDirectory extends DeletablePath {
31
32 /**
33 * Creates a new instance for a new temporary directory in the specified directory, using the given prefix to generate
34 * its name.
35 *
36 * @param dir See {@link Files#createTempDirectory(String, FileAttribute...)}.
37 * @param prefix See {@link Files#createTempDirectory(String, FileAttribute...)}.
38 * @param attrs See {@link Files#createTempDirectory(String, FileAttribute...)}.
39 * @return a new instance for a new temporary directory
40 * @throws IOException See {@link Files#createTempDirectory(String, FileAttribute...)}.
41 */
42 public static TempDirectory create(final Path dir, final String prefix, final FileAttribute<?>... attrs) throws IOException {
43 return new TempDirectory(Files.createTempDirectory(dir, prefix, attrs));
44 }
45
46 /**
47 * Creates a new instance for a new temporary directory in the specified directory, using the given prefix to generate
48 * its name.
49 *
50 * @param prefix See {@link Files#createTempDirectory(String, FileAttribute...)}.
51 * @param attrs See {@link Files#createTempDirectory(String, FileAttribute...)}.
52 * @return a new instance for a new temporary directory
53 * @throws IOException See {@link Files#createTempDirectory(String, FileAttribute...)}.
54 */
55 public static TempDirectory create(final String prefix, final FileAttribute<?>... attrs) throws IOException {
56 return new TempDirectory(Files.createTempDirectory(prefix, attrs));
57 }
58
59 /**
60 * Constructs a new instance wrapping the given delegate.
61 *
62 * @param path The delegate.
63 */
64 private TempDirectory(final Path path) {
65 super(path);
66 }
67
68 }