    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.io.file;
    019
    020import java.io.IOException;
    021import java.nio.file.FileVisitResult;
    022import java.nio.file.Path;
    023import java.nio.file.SimpleFileVisitor;
    024import java.util.Objects;
    025
    026import org.apache.commons.io.function.IOBiFunction;
    027
    028/**
    029 * A {@link SimpleFileVisitor} typed to a {@link Path}.
    030 *
    031 * @since 2.7
    032 */
    033public abstract class SimplePathVisitor extends SimpleFileVisitor<Path> implements PathVisitor {
    034
    035    private final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailedFunction;
    036
    037    /**
    038     * Constructs a new instance.
    039     */
    040    protected SimplePathVisitor() {
    041        this.visitFileFailedFunction = super::visitFileFailed;
    042    }
    043
    044    /**
    045     * Constructs a new instance.
    046     *
    047     * @param visitFileFailed Called on {@link #visitFileFailed(Path, IOException)}.
    048     */
    049    protected SimplePathVisitor(final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailed) {
    050        this.visitFileFailedFunction = Objects.requireNonNull(visitFileFailed, "visitFileFailed");
    051    }
    052
    053    @Override
    054    public FileVisitResult visitFileFailed(final Path file, final IOException exc) throws IOException {
    055        return visitFileFailedFunction.apply(file, exc);
    056    }
    057}