libjava/java/io/FilenameFilter.java

   1 /* FilenameFilter.java -- Filter a list of filenames
   2    Copyright (C) 1998, 1999, 2001, 2003, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
  42  * "The Java Language Specification", ISBN 0-201-63451-1
  43  * Status:  Complete to 1.1.
  44  */
  45
  46 /**
  47  * This interface has one method which is used for filtering filenames
  48  * returned in a directory listing.  It is currently used by the
  49  * <code>File.list(FilenameFilter)</code> method and by the filename
  50  * dialog in AWT.
  51  * <p>
  52  * The method in this interface determines if a particular file should
  53  * or should not be included in the file listing.
  54  *
  55  * @author Aaron M. Renn (arenn@urbanophile.com)
  56  * @author Tom Tromey (tromey@cygnus.com)
  57  *
  58  * @see File#listFiles(java.io.FilenameFilter)
  59  * @see java.awt.FileDialog#setFilenameFilter(java.io.FilenameFilter)
  60  */
  61 public interface FilenameFilter
  62 {
  63   /**
  64    * This method determines whether or not a given file should be included
  65    * in a directory listing.
  66    *
  67    * @param dir The <code>File</code> instance for the directory being read
  68    * @param name The name of the file to test
  69    *
  70    * @return <code>true</code> if the file should be included in the list,
  71    * <code>false</code> otherwise.
  72    */
  73   boolean accept(File dir, String name);
  74
  75 } // interface FilenameFilter
  76