Bug #30705 - Add conditional file filters.

I effectively merged these new filters into the existing And and Or
filters, rather than having multiple flavours of them. In practice, this
means that I added the contructors from the original filters to these new
ones, and then replaced the old with the new. All of the pre-existing
tests work with the resulting filters, along with all the new tests
supplied with the enhancement request. Thanks to Steven Caswell for the
code.

I also had to exclude the abstract test cases in the Maven build file, so
that JUnit wouldn't try to instantiate and run them, and regenerate the
Ant build file.


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@140618 13f79535-47bb-0310-9956-ffa450edef68

Author: mfncooper

build.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!--build.xml generated by maven from project.xml version 1.1-dev
-  on date October 23 2004, time 1747-->
+  on date October 24 2004, time 1323-->
 
 <project default="jar" name="commons-io" basedir=".">
   <property name="defaulttargetdir" value="target">
@@ -106,6 +106,8 @@
         <fileset dir="src/test">
           <include name="**/*Test*">
           </include>
+          <exclude name="**/*AbstractTestCase*">
+          </exclude>
           <exclude name="**/testtools/**">
           </exclude>
         </fileset>

project.xml

@@ -183,6 +183,7 @@
         <include>**/*Test*</include>
       </includes>
       <excludes>
+        <exclude>**/*AbstractTestCase*</exclude>
         <exclude>**/testtools/**</exclude>
       </excludes>
     </unitTest>

src/java/org/apache/commons/io/filefilter/AndFileFilter.java

@@ -1,12 +1,12 @@
 /*
  * Copyright 2002-2004 The Apache Software Foundation.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -16,56 +16,119 @@
 package org.apache.commons.io.filefilter;
 
 import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
 
 /**
- * This filter produces a logical AND of the two filters specified.
+ * A {@link FileFilter} providing conditional AND logic across a list of
+ * file filters. This filter returns <code>true</code> if all filters in the
+ * list return <code>true</code>. Otherwise, it returns <code>false</code>.
+ * Checking of the file filter list stops when the first filter returns
+ * <code>false</code>.
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.8 $ $Date: 2004/02/23 04:37:57 $
- * 
- * @author Stephen Colebourne
+ * @version $Revision: 1.9 $ $Date: 2004/10/24 21:58:44 $
+ *
+ * @author  Steven Caswell
  */
-public class AndFileFilter extends AbstractFileFilter {
-    
-    /** The first filter */
-    private IOFileFilter filter1;
-    /** The second filter */
-    private IOFileFilter filter2;
+public class AndFileFilter
+extends AbstractFileFilter
+implements IOFileFilter, ConditionalFileFilter {
+
+  private List fileFilters;
+
+  /**
+   * Constructs a new instance of <code>AndFileFilter</code>.
+   */
+  public AndFileFilter() {
+    this.fileFilters = new ArrayList();
+  }
+
+  /**
+   * Constructs a new instance of <code>AndFileFilter</code>
+   * with the specified list of filters.
+   */
+  public AndFileFilter(final List fileFilters) {
+    this.fileFilters = new ArrayList(fileFilters);
+  }
 
-    /**
-     * Constructs a new file filter that ANDs the result of two other filters.
-     * 
-     * @param filter1  the first filter, must not be null
-     * @param filter2  the second filter, must not be null
-     * @throws IllegalArgumentException if either filter is null
-     */
-    public AndFileFilter(IOFileFilter filter1, IOFileFilter filter2) {
-        if (filter1 == null || filter2 == null) {
-            throw new IllegalArgumentException("The filters must not be null");
-        }
-        this.filter1 = filter1;
-        this.filter2 = filter2;
+  /**
+   * Constructs a new file filter that ANDs the result of two other filters.
+   *
+   * @param filter1  the first filter, must not be null
+   * @param filter2  the second filter, must not be null
+   * @throws IllegalArgumentException if either filter is null
+   */
+  public AndFileFilter(IOFileFilter filter1, IOFileFilter filter2) {
+      if (filter1 == null || filter2 == null) {
+          throw new IllegalArgumentException("The filters must not be null");
+      }
+      this.fileFilters = new ArrayList();
+      addFileFilter(filter1);
+      addFileFilter(filter2);
+  }
+
+  /**
+   * @{inheritDoc}
+   */
+  public void addFileFilter(final IOFileFilter ioFileFilter) {
+    this.fileFilters.add(ioFileFilter);
+  }
+
+  /**
+   * @{inheritDoc}
+   */
+  public List getFileFilters() {
+    return Collections.unmodifiableList(this.fileFilters);
+  }
+
+  /**
+   * @{inheritDoc}
+   */
+  public boolean removeFileFilter(final IOFileFilter ioFileFilter) {
+    return this.fileFilters.remove(ioFileFilter);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public void setFileFilters(final List fileFilters) {
+    this.fileFilters = new ArrayList(fileFilters);
+  }
+
+  /**
+   * @{inheritDoc}
+   */
+  public boolean accept(final File file) {
+    if(this.fileFilters.size() == 0) {
+      return false;
+    }
+    for(Iterator iter = this.fileFilters.iterator(); iter.hasNext();) {
+      IOFileFilter fileFilter = (IOFileFilter) iter.next();
+      if(!fileFilter.accept(file)) {
+        return false;
+      }
     }
+    return true;
+  }
 
-    /**
-     * Checks to see if both filters are true.
-     * 
-     * @param file  the File to check
-     * @return true if both filters are true
-     */
-    public boolean accept(File file) {
-        return filter1.accept(file) && filter2.accept(file);
+  /**
+   * @{inheritDoc}
+   */
+  public boolean accept(final File file, final String name)
+  {
+    if(this.fileFilters.size() == 0) {
+      return false;
     }
-    
-    /**
-     * Checks to see if both filters are true.
-     * 
-     * @param file  the File directory
-     * @param name  the filename
-     * @return true if both filters are true
-     */
-    public boolean accept(File file, String name) {
-        return filter1.accept(file, name) && filter2.accept(file, name);
+    for(Iterator iter = this.fileFilters.iterator(); iter.hasNext();) {
+      IOFileFilter fileFilter = (IOFileFilter) iter.next();
+      if(!fileFilter.accept(file, name)) {
+        return false;
+      }
     }
-    
+    return true;
+  }
+
 }

src/java/org/apache/commons/io/filefilter/ConditionalFileFilter.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2002-2004 The Apache Software Foundation.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.io.filefilter;
+
+import java.util.List;
+
+/**
+ * Defines operations for conditional file filters.
+ *
+ * @since Commons IO 1.0
+ * @version $Revision: 1.1 $ $Date: 2004/10/24 21:58:44 $
+ *
+ * @author  Steven Caswell
+ */
+public interface ConditionalFileFilter
+{
+  /**
+   * Adds the specified file filter to the list of file filters at the end of
+   * the list.
+   *
+   * @param ioFileFilter the filter to be added
+   */
+  public void addFileFilter(IOFileFilter ioFileFilter);
+
+  /**
+   * Returns this conditional file filter's list of file filters.
+   *
+   * @return the file filter list
+   */
+  public List getFileFilters();
+  
+  /**
+   * Removes the specified file filter.
+   *
+   * @param ioFileFilter filter to be removed
+   * @return <code>true</code> if the filter was found in the list,
+   * <code>false</code> otherwise
+   */
+  public boolean removeFileFilter(IOFileFilter ioFileFilter);
+
+  /**
+   * Sets the list of file filters, replacing any previously configured
+   * file filters on this filter.
+   *
+   * @param fileFilters the list of filters
+   */
+  public void setFileFilters(List fileFilters);
+  
+}