Source for java.io.FileFilter

   1: /* FileFilter.java -- Filter a list of pathnames
   2:    Copyright (C) 1998,2003 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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: /**
  42:  * This interface has one method which is used for filtering pathnames
  43:  * returned in a pathname listing.  It is currently used by the 
  44:  * <code>File.listFiles(FileFilter)</code> method.
  45:  * <p>
  46:  * The method in this interface determines if a particular pathname should
  47:  * or should not be included in the pathname listing.
  48:  *
  49:  * @author Aaron M. Renn (arenn@urbanophile.com)
  50:  * 
  51:  * @see File#listFiles(java.io.FileFilter)
  52:  */
  53: public interface FileFilter
  54: {
  55:   /**
  56:    * This method determines whether or not a given pathname should be included
  57:    * in a pathname listing.
  58:    *
  59:    * @param pathname The pathname to test
  60:    *
  61:    * @return <code>true</code> if the path should be included in the list, 
  62:    * <code>false</code> otherwise.
  63:    */
  64:   boolean accept(File pathname);
  65: }