Coverage Report - org.apache.commons.io.filefilter.OrFileFilter
 
Classes in this File Line Coverage Branch Coverage Complexity
OrFileFilter
100%
43/43
86%
19/22
2.4
 
 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  
 package org.apache.commons.io.filefilter;
 18  
 
 19  
 import java.io.File;
 20  
 import java.io.Serializable;
 21  
 import java.util.ArrayList;
 22  
 import java.util.Collections;
 23  
 import java.util.List;
 24  
 
 25  
 /**
 26  
  * A {@link java.io.FileFilter} providing conditional OR logic across a list of
 27  
  * file filters. This filter returns {@code true} if any filters in the
 28  
  * list return {@code true}. Otherwise, it returns {@code false}.
 29  
  * Checking of the file filter list stops when the first filter returns
 30  
  * {@code true}.
 31  
  *
 32  
  * @since 1.0
 33  
  * @version $Id: OrFileFilter.java 1642757 2014-12-01 21:09:30Z sebb $
 34  
  * @see FileFilterUtils#or(IOFileFilter...)
 35  
  */
 36  
 public class OrFileFilter
 37  
         extends AbstractFileFilter
 38  
         implements ConditionalFileFilter, Serializable {
 39  
 
 40  
     private static final long serialVersionUID = 5767770777065432721L;
 41  
     /** The list of file filters. */
 42  
     private final List<IOFileFilter> fileFilters;
 43  
 
 44  
     /**
 45  
      * Constructs a new instance of <code>OrFileFilter</code>.
 46  
      *
 47  
      * @since 1.1
 48  
      */
 49  14
     public OrFileFilter() {
 50  14
         this.fileFilters = new ArrayList<IOFileFilter>();
 51  14
     }
 52  
 
 53  
     /**
 54  
      * Constructs a new instance of <code>OrFileFilter</code>
 55  
      * with the specified filters.
 56  
      *
 57  
      * @param fileFilters  the file filters for this filter, copied, null ignored
 58  
      * @since 1.1
 59  
      */
 60  47
     public OrFileFilter(final List<IOFileFilter> fileFilters) {
 61  47
         if (fileFilters == null) {
 62  1
             this.fileFilters = new ArrayList<IOFileFilter>();
 63  
         } else {
 64  46
             this.fileFilters = new ArrayList<IOFileFilter>(fileFilters);
 65  
         }
 66  47
     }
 67  
 
 68  
     /**
 69  
      * Constructs a new file filter that ORs the result of two other filters.
 70  
      * 
 71  
      * @param filter1  the first filter, must not be null
 72  
      * @param filter2  the second filter, must not be null
 73  
      * @throws IllegalArgumentException if either filter is null
 74  
      */
 75  9
     public OrFileFilter(final IOFileFilter filter1, final IOFileFilter filter2) {
 76  9
         if (filter1 == null || filter2 == null) {
 77  1
             throw new IllegalArgumentException("The filters must not be null");
 78  
         }
 79  8
         this.fileFilters = new ArrayList<IOFileFilter>(2);
 80  8
         addFileFilter(filter1);
 81  8
         addFileFilter(filter2);
 82  8
     }
 83  
 
 84  
     /**
 85  
      * {@inheritDoc}
 86  
      */
 87  
     public void addFileFilter(final IOFileFilter ioFileFilter) {
 88  66
         this.fileFilters.add(ioFileFilter);
 89  66
     }
 90  
 
 91  
     /**
 92  
      * {@inheritDoc}
 93  
      */
 94  
     public List<IOFileFilter> getFileFilters() {
 95  17
         return Collections.unmodifiableList(this.fileFilters);
 96  
     }
 97  
 
 98  
     /**
 99  
      * {@inheritDoc}
 100  
      */
 101  
     public boolean removeFileFilter(final IOFileFilter ioFileFilter) {
 102  6
         return this.fileFilters.remove(ioFileFilter);
 103  
     }
 104  
 
 105  
     /**
 106  
      * {@inheritDoc}
 107  
      */
 108  
     public void setFileFilters(final List<IOFileFilter> fileFilters) {
 109  1
         this.fileFilters.clear();
 110  1
         this.fileFilters.addAll(fileFilters);
 111  1
     }
 112  
 
 113  
     /**
 114  
      * {@inheritDoc}
 115  
      */
 116  
     @Override
 117  
     public boolean accept(final File file) {
 118  1166
         for (final IOFileFilter fileFilter : fileFilters) {
 119  2142
             if (fileFilter.accept(file)) {
 120  405
                 return true;
 121  
             }
 122  1737
         }
 123  761
         return false;
 124  
     }
 125  
 
 126  
     /**
 127  
      * {@inheritDoc}
 128  
      */
 129  
     @Override
 130  
     public boolean accept(final File file, final String name) {
 131  22
         for (final IOFileFilter fileFilter : fileFilters) {
 132  32
             if (fileFilter.accept(file, name)) {
 133  17
                 return true;
 134  
             }
 135  15
         }
 136  5
         return false;
 137  
     }
 138  
 
 139  
     /**
 140  
      * Provide a String representaion of this file filter.
 141  
      *
 142  
      * @return a String representaion
 143  
      */
 144  
     @Override
 145  
     public String toString() {
 146  19
         final StringBuilder buffer = new StringBuilder();
 147  19
         buffer.append(super.toString());
 148  19
         buffer.append("(");
 149  19
         if (fileFilters != null) {
 150  48
             for (int i = 0; i < fileFilters.size(); i++) {
 151  29
                 if (i > 0) {
 152  15
                     buffer.append(",");
 153  
                 }
 154  29
                 final Object filter = fileFilters.get(i);
 155  29
                 buffer.append(filter == null ? "null" : filter.toString());
 156  
             }
 157  
         }
 158  19
         buffer.append(")");
 159  19
         return buffer.toString();
 160  
     }
 161  
 
 162  
 }