1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19
20 package org.apache.rat.walker;
21
22 import org.apache.commons.io.filefilter.FalseFileFilter;
23 import org.apache.rat.api.Document;
24 import org.apache.rat.report.IReportable;
25
26 import java.io.FilenameFilter;
27 import java.nio.file.Path;
28
29 /**
30 * Abstract walker.
31 */
32 public abstract class Walker implements IReportable {
33
34 /** The file name filter that the walker is applying */
35 private final FilenameFilter filesToIgnore;
36 /** The document this walker is walking */
37 private final Document document;
38
39 /**
40 * Creates the walker
41 * @param document The document the walker is walking.
42 * @param filesToIgnore the Files to ignore. If {@code null} no files are ignored.
43 */
44 protected Walker(final Document document, final FilenameFilter filesToIgnore) {
45 this.document = document;
46 this.filesToIgnore = filesToIgnore == null ? FalseFileFilter.FALSE : filesToIgnore;
47 }
48
49 /**
50 * Retrieves the document from the constructor.
51 * @return the document from the constructor.
52 */
53 protected Document getDocument() {
54 return document;
55 }
56
57 /**
58 * Tests if the specified path should be ignored.
59 * @param path the Path to test
60 * @return {@code true} if the file should not be ignored.
61 */
62 protected final boolean isNotIgnored(final Path path) {
63 return !filesToIgnore.accept(path.getParent().toFile(), path.toString());
64 }
65 }