001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.commons.io.filefilter;
018
019 import java.io.File;
020 import java.io.Serializable;
021
022 /**
023 * This filter accepts <code>File</code>s that are files (not directories).
024 * <p>
025 * For example, here is how to print out a list of the real files
026 * within the current directory:
027 *
028 * <pre>
029 * File dir = new File(".");
030 * String[] files = dir.list( FileFileFilter.FILE );
031 * for ( int i = 0; i < files.length; i++ ) {
032 * System.out.println(files[i]);
033 * }
034 * </pre>
035 *
036 * @since Commons IO 1.3
037 * @version $Revision:587916 $ $Date: 2010-10-06 17:13:01 +0100 (Wed, 06 Oct 2010) $
038 * @see FileFilterUtils#fileFileFilter()
039 */
040 public class FileFileFilter extends AbstractFileFilter implements Serializable {
041
042 /** Singleton instance of file filter */
043 public static final IOFileFilter FILE = new FileFileFilter();
044
045 /**
046 * Restrictive consructor.
047 */
048 protected FileFileFilter() {
049 }
050
051 /**
052 * Checks to see if the file is a file.
053 *
054 * @param file the File to check
055 * @return true if the file is a file
056 */
057 @Override
058 public boolean accept(File file) {
059 return file.isFile();
060 }
061
062 }