Merge pull request #2968 from idodeclare/feature/filter_override

Filter subclasses override Match() instead of creating Ignore()

Author: tarzanek

opengrok-indexer/src/main/java/org/opengrok/indexer/index/Filter.java

@@ -46,7 +46,7 @@ public class Filter implements Serializable {
      * The full list of all patterns. This list will be saved in the
      * configuration file (if used).
      */
-    private final List<String> items;
+    private final PatternList items;
 
     public Filter() {
         filenames = new HashSet<>();
@@ -154,7 +154,7 @@ public boolean match(File file) {
      * @return true if this pathname matches, false otherwise
      */
     public boolean match(String name) {
-        /**
+        /*
          * Creating File object out of relative path would mean the path would be
          * checked against current working directory which is usually undesired.
          */

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IgnoredDirs.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.index;
 
@@ -45,21 +46,14 @@ public IgnoredDirs() {
     }
 
     /**
-     * Should the file be ignored or not?
-     * @param file the file to check
-     * @return true if this file should be ignored, false otherwise
+     * Should the file (that must be a directory) be ignored or not?
+     * @return {@code true} if {@code file} has
+     * {@link File#isDirectory()} () == true} and should be ignored per
+     * filtering
      */
-    public boolean ignore(File file) {
-        return file.isDirectory() && match(file);
-    }
-
-    /**
-     * Should the file be ignored or not?
-     * @param name the name of the file to check
-     * @return true if this pathname should be ignored, false otherwise
-     */
-    public boolean ignore(String name) {
-        return match(name);
+    @Override
+    public boolean match(File file) {
+        return file.isDirectory() && super.match(file);
     }
 
     private void addDefaultPatterns() {

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IgnoredFiles.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.index;
 
@@ -67,20 +68,12 @@ public IgnoredFiles() {
 
     /**
      * Should the file be ignored or not?
-     * @param file the file to check
-     * @return true if this file should be ignored, false otherwise
+     * @return {@code true} if {@code file} has {@link File#isFile() == true}
+     * and should be ignored per filtering
      */
-    public boolean ignore(File file) {
-        return file.isFile() && match(file);
-    }
-
-    /**
-     * Should the file be ignored or not?
-     * @param name the name of the file to check
-     * @return true if this pathname should be ignored, false otherwise
-     */
-    public boolean ignore(String name) {
-        return match(name);
+    @Override
+    public boolean match(File file) {
+        return file.isFile() && super.match(file);
     }
 
     private void addDefaultPatterns() {

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IgnoredNames.java

@@ -79,9 +79,9 @@ public void add(String pattern) {
      */
     public boolean ignore(File file) {
         if (file.isFile()) {
-            return ignoredFiles.ignore(file);
+            return ignoredFiles.match(file);
         } else {
-            return ignoredDirs.ignore(file);
+            return ignoredDirs.match(file);
         }
     }
 
@@ -92,7 +92,7 @@ public boolean ignore(File file) {
      * @return true if this pathname should be ignored, false otherwise
      */
     public boolean ignore(String name) {
-        return ignoredFiles.ignore(name) || ignoredDirs.ignore(name);
+        return ignoredFiles.match(name) || ignoredDirs.match(name);
     }
 
     public void clear() {