Source for javax.swing.filechooser.FileFilter

   1: /* FileFilter.java --
   2:    Copyright (C) 2002, 2005, 2006, 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 javax.swing.filechooser;
  40: 
  41: import java.io.File;
  42: 
  43: import javax.swing.JFileChooser;
  44: 
  45: /**
  46:  * The base class for filters that control the visibility of files in the
  47:  * {@link JFileChooser} component.
  48:  * 
  49:  * @see JFileChooser#addChoosableFileFilter(FileFilter)
  50:  * 
  51:  * @author    Andrew Selkirk
  52:  */
  53: public abstract class FileFilter 
  54: {
  55: 
  56:   /**
  57:    * Default constructor.
  58:    */
  59:   public FileFilter()
  60:   {
  61:     // Nothing to do here.
  62:   }
  63: 
  64:   /**
  65:    * Returns <code>true</code> if the specified file matches the filter, and
  66:    * <code>false</code> otherwise.
  67:    * 
  68:    * @param file  the file.
  69:    * 
  70:    * @return A boolean.
  71:    */
  72:   public abstract boolean accept(File file);
  73: 
  74:   /**
  75:    * Returns a description of the files that will be selected by the filter 
  76:    * (for example, "Java source files").  This description will usually be 
  77:    * displayed on the {@link JFileChooser} component, often in a combo box that
  78:    * is used to select the appropriate filter (in cases where more than one
  79:    * filter is available).
  80:    * 
  81:    * @return A description of the filter.
  82:    */
  83:   public abstract String getDescription();
  84: 
  85: }