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.filefilter;
19
20 import java.io.File;
21 import java.nio.file.FileVisitResult;
22 import java.nio.file.Path;
23 import java.nio.file.attribute.BasicFileAttributes;
24 import java.util.Objects;
25
26 /**
27 * Accepts only an exact {@link File} object match. You can use this filter to visit the start directory when walking a
28 * file tree with
29 * {@link java.nio.file.Files#walkFileTree(java.nio.file.Path, java.util.Set, int, java.nio.file.FileVisitor)}.
30 *
31 * @since 2.9.0
32 */
33 public class FileEqualsFileFilter extends AbstractFileFilter {
34
35 private final File file;
36 private final Path path;
37
38 /**
39 * Constructs a new instance for the given {@link File}.
40 *
41 * @param file The file to match.
42 */
43 public FileEqualsFileFilter(final File file) {
44 this.file = Objects.requireNonNull(file, "file");
45 this.path = file.toPath();
46 }
47
48 @Override
49 public boolean accept(final File file) {
50 return Objects.equals(this.file, file);
51 }
52
53 @Override
54 public FileVisitResult accept(final Path path, final BasicFileAttributes attributes) {
55 return toFileVisitResult(Objects.equals(this.path, path));
56 }
57 }