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.Closeable;
21 import java.io.IOException;
22 import java.nio.file.Path;
23
24 import org.apache.commons.io.file.Counters.PathCounters;
25
26 /**
27 * A Path that deletes its delegate on close.
28 *
29 * @since 2.12.0
30 */
31 public class DeletablePath extends AbstractPathWrapper implements Closeable {
32
33 /**
34 * Constructs a new instance wrapping the given delegate.
35 *
36 * @param path The delegate.
37 */
38 public DeletablePath(final Path path) {
39 super(path);
40 }
41
42 @Override
43 public void close() throws IOException {
44 delete();
45 }
46
47 /**
48 * Deletes the delegate path.
49 *
50 * @return The visitor used to delete the given directory.
51 * @throws IOException if an I/O error is thrown by a visitor method or if an I/O error occurs.
52 */
53 public PathCounters delete() throws IOException {
54 return delete((DeleteOption[]) null);
55 }
56
57 /**
58 * Deletes the delegate path.
59 * @param deleteOptions How to handle deletion.
60 *
61 * @return The visitor used to delete the given directory.
62 * @throws IOException if an I/O error is thrown by a visitor method or if an I/O error occurs.
63 */
64 public PathCounters delete(final DeleteOption... deleteOptions) throws IOException {
65 return PathUtils.delete(get(), deleteOptions);
66 }
67
68 }