View Javadoc
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.nio.file.FileVisitResult;
21  import java.nio.file.Path;
22  import java.nio.file.attribute.BasicFileAttributes;
23  
24  /**
25   * A filter for {@link Path}s.
26   *
27   * @since 2.9.0
28   */
29  @FunctionalInterface
30  public interface PathFilter {
31  
32      /**
33       * Tests whether or not to include the specified Path in a result.
34       *
35       * @param path The Path to test.
36       * @param attributes the file's basic attributes (TODO may be null).
37       * @return a FileVisitResult
38       */
39      FileVisitResult accept(Path path, BasicFileAttributes attributes);
40  }