View Javadoc
1   package org.apache.rat.mp.util.ignore;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import nl.basjes.gitignore.GitIgnoreFileSet;
23  import org.apache.maven.plugin.logging.Log;
24  
25  import java.io.File;
26  import java.util.Optional;
27  
28  public class GitIgnoreMatcher implements IgnoreMatcher {
29  
30      private final GitIgnoreFileSet gitIgnoreFileSet;
31  
32      public GitIgnoreMatcher(final Log log, final File projectBaseDir) {
33          log.debug("Recursively loading .gitignore files in " + projectBaseDir);
34          // This will walk the project tree and load all .gitignore files
35          gitIgnoreFileSet = new GitIgnoreFileSet(projectBaseDir);
36      }
37  
38      @Override
39      public boolean isEmpty() {
40          return gitIgnoreFileSet.isEmpty();
41      }
42  
43      @Override
44      public Optional<Boolean> isIgnoredFile(String filename) {
45          Boolean isIgnoredFile = gitIgnoreFileSet.isIgnoredFile(filename);
46          if (isIgnoredFile == null) {
47              return Optional.empty();
48          }
49          return Optional.of(isIgnoredFile);
50      }
51  
52      @Override
53      public String toString() {
54          return "Loaded .gitignore data:\n" + gitIgnoreFileSet;
55      }
56  }