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.FileVisitResult;
22 import java.nio.file.Path;
23 import java.nio.file.SimpleFileVisitor;
24 import java.util.Objects;
25
26 import org.apache.commons.io.function.IOBiFunction;
27
28 /**
29 * A {@link SimpleFileVisitor} typed to a {@link Path}.
30 *
31 * @since 2.7
32 */
33 public abstract class SimplePathVisitor extends SimpleFileVisitor<Path> implements PathVisitor {
34
35 private final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailedFunction;
36
37 /**
38 * Constructs a new instance.
39 */
40 protected SimplePathVisitor() {
41 this.visitFileFailedFunction = super::visitFileFailed;
42 }
43
44 /**
45 * Constructs a new instance.
46 *
47 * @param visitFileFailed Called on {@link #visitFileFailed(Path, IOException)}.
48 */
49 protected SimplePathVisitor(final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailed) {
50 this.visitFileFailedFunction = Objects.requireNonNull(visitFileFailed, "visitFileFailed");
51 }
52
53 @Override
54 public FileVisitResult visitFileFailed(final Path file, final IOException exc) throws IOException {
55 return visitFileFailedFunction.apply(file, exc);
56 }
57 }