001    /* FileFilter.java --
002       Copyright (C) 2002, 2005, 2006, 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 javax.swing.filechooser;
040    
041    import java.io.File;
042    
043    import javax.swing.JFileChooser;
044    
045    /**
046     * The base class for filters that control the visibility of files in the
047     * {@link JFileChooser} component.
048     *
049     * @see JFileChooser#addChoosableFileFilter(FileFilter)
050     *
051     * @author      Andrew Selkirk
052     */
053    public abstract class FileFilter
054    {
055    
056      /**
057       * Default constructor.
058       */
059      public FileFilter()
060      {
061        // Nothing to do here.
062      }
063    
064      /**
065       * Returns <code>true</code> if the specified file matches the filter, and
066       * <code>false</code> otherwise.
067       *
068       * @param file  the file.
069       *
070       * @return A boolean.
071       */
072      public abstract boolean accept(File file);
073    
074      /**
075       * Returns a description of the files that will be selected by the filter
076       * (for example, "Java source files").  This description will usually be
077       * displayed on the {@link JFileChooser} component, often in a combo box that
078       * is used to select the appropriate filter (in cases where more than one
079       * filter is available).
080       *
081       * @return A description of the filter.
082       */
083      public abstract String getDescription();
084    
085    }