View Javadoc

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.FileFilter;
21  import java.io.FilenameFilter;
22  
23  /**
24   * An interface which brings the FileFilter and FilenameFilter 
25   * interfaces together.
26   * 
27   * @since Commons IO 1.0
28   * @version $Revision: 471628 $ $Date: 2006-11-06 05:06:45 +0100 (Mo, 06 Nov 2006) $
29   * 
30   * @author Stephen Colebourne
31   */
32  public interface IOFileFilter extends FileFilter, FilenameFilter {
33  
34      /**
35       * Checks to see if the File should be accepted by this filter.
36       * <p>
37       * Defined in {@link java.io.FileFilter}.
38       * 
39       * @param file  the File to check
40       * @return true if this file matches the test
41       */
42      public boolean accept(File file);
43  
44      /**
45       * Checks to see if the File should be accepted by this filter.
46       * <p>
47       * Defined in {@link java.io.FilenameFilter}.
48       * 
49       * @param dir  the directory File to check
50       * @param name  the filename within the directory to check
51       * @return true if this file matches the test
52       */
53      public boolean accept(File dir, String name);
54      
55  }