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