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.DirectoryStream;
22 import java.nio.file.FileVisitResult;
23 import java.nio.file.Path;
24 import java.util.Objects;
25
26 /**
27 * A {@link java.nio.file.DirectoryStream.Filter DirectoryStream.Filter} that delegates to a {@link PathFilter}.
28 * <p>
29 * You pass this filter to {@link java.nio.file.Files#newDirectoryStream(Path, DirectoryStream.Filter)
30 * Files#newDirectoryStream(Path, DirectoryStream.Filter)}.
31 * </p>
32 *
33 * @since 2.9.0
34 */
35 public class DirectoryStreamFilter implements DirectoryStream.Filter<Path> {
36
37 private final PathFilter pathFilter;
38
39 /**
40 * Constructs a new instance for the given path filter.
41 *
42 * @param pathFilter How to filter paths.
43 */
44 public DirectoryStreamFilter(final PathFilter pathFilter) {
45 // TODO Instead of NPE, we could map null to FalseFileFilter.
46 this.pathFilter = Objects.requireNonNull(pathFilter, "pathFilter");
47 }
48
49 @Override
50 public boolean accept(final Path path) throws IOException {
51 return pathFilter.accept(path, PathUtils.readBasicFileAttributes(path, PathUtils.EMPTY_LINK_OPTION_ARRAY)) == FileVisitResult.CONTINUE;
52 }
53
54 /**
55 * Gets the path filter.
56 *
57 * @return the path filter.
58 */
59 public PathFilter getPathFilter() {
60 return pathFilter;
61 }
62
63 }