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  
21  /**
22   * This filter accepts <code>File</code>s that are files (not directories).
23   * <p>
24   * For example, here is how to print out a list of the real files
25   * within the current directory:
26   *
27   * <pre>
28   * File dir = new File(".");
29   * String[] files = dir.list( FileFileFilter.FILE );
30   * for ( int i = 0; i &lt; files.length; i++ ) {
31   *     System.out.println(files[i]);
32   * }
33   * </pre>
34   *
35   * @since Commons IO 1.3
36   * @version $Revision: 155419 $ $Date: 2006-08-28 08:39:07 +0200 (Mo, 28 Aug 2006) $
37   */
38  public class FileFileFilter extends AbstractFileFilter {
39  
40      /** Singleton instance of file filter */
41      public static final IOFileFilter FILE = new FileFileFilter();
42  
43      /**
44       * Restrictive consructor.
45       */
46      protected FileFileFilter() {
47      }
48  
49      /**
50       * Checks to see if the file is a file.
51       *
52       * @param file  the File to check
53       * @return true if the file is a file
54       */
55      public boolean accept(File file) {
56          return file.isFile();
57      }
58  
59  }