001 /* FilenameFilter.java -- Filter a list of filenames 002 Copyright (C) 1998, 1999, 2001, 2003, 2005 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package java.io; 040 041 /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3 042 * "The Java Language Specification", ISBN 0-201-63451-1 043 * Status: Complete to 1.1. 044 */ 045 046 /** 047 * This interface has one method which is used for filtering filenames 048 * returned in a directory listing. It is currently used by the 049 * <code>File.list(FilenameFilter)</code> method and by the filename 050 * dialog in AWT. 051 * <p> 052 * The method in this interface determines if a particular file should 053 * or should not be included in the file listing. 054 * 055 * @author Aaron M. Renn (arenn@urbanophile.com) 056 * @author Tom Tromey (tromey@cygnus.com) 057 * 058 * @see File#listFiles(java.io.FilenameFilter) 059 * @see java.awt.FileDialog#setFilenameFilter(java.io.FilenameFilter) 060 */ 061 public interface FilenameFilter 062 { 063 /** 064 * This method determines whether or not a given file should be included 065 * in a directory listing. 066 * 067 * @param dir The <code>File</code> instance for the directory being read 068 * @param name The name of the file to test 069 * 070 * @return <code>true</code> if the file should be included in the list, 071 * <code>false</code> otherwise. 072 */ 073 boolean accept(File dir, String name); 074 075 } // interface FilenameFilter