Source for org.jfree.ui.ExtensionFileFilter

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * ------------------------
  28:  * ExtensionFileFilter.java
  29:  * ------------------------
  30:  * (C) Copyright 2000-2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: ExtensionFileFilter.java,v 1.4 2005/11/16 15:58:41 taqua Exp $
  36:  *
  37:  * Changes (from 26-Oct-2001)
  38:  * --------------------------
  39:  * 26-Oct-2001 : Changed package to com.jrefinery.ui.* (DG);
  40:  * 26-Jun-2002 : Updated imports (DG);
  41:  * 14-Oct-2002 : Fixed errors reported by Checkstyle (DG);
  42:  *
  43:  */
  44: package org.jfree.ui;
  45: 
  46: import java.io.File;
  47: 
  48: import javax.swing.filechooser.FileFilter;
  49: 
  50: /**
  51:  * A filter for JFileChooser that filters files by extension.
  52:  *
  53:  * @author David Gilbert
  54:  */
  55: public class ExtensionFileFilter extends FileFilter {
  56: 
  57:     /** A description for the file type. */
  58:     private String description;
  59: 
  60:     /** The extension (for example, "png" for *.png files). */
  61:     private String extension;
  62: 
  63:     /**
  64:      * Standard constructor.
  65:      *
  66:      * @param description  a description of the file type;
  67:      * @param extension  the file extension;
  68:      */
  69:     public ExtensionFileFilter(final String description, final String extension) {
  70:         this.description = description;
  71:         this.extension = extension;
  72:     }
  73: 
  74:     /**
  75:      * Returns true if the file ends with the specified extension.
  76:      *
  77:      * @param file  the file to test.
  78:      *
  79:      * @return A boolean that indicates whether or not the file is accepted by the filter.
  80:      */
  81:     public boolean accept(final File file) {
  82: 
  83:         if (file.isDirectory()) {
  84:             return true;
  85:         }
  86: 
  87:         final String name = file.getName().toLowerCase();
  88:         if (name.endsWith(this.extension)) {
  89:             return true;
  90:         }
  91:         else {
  92:             return false;
  93:         }
  94: 
  95:     }
  96: 
  97:     /**
  98:      * Returns the description of the filter.
  99:      *
 100:      * @return a description of the filter.
 101:      */
 102:     public String getDescription() {
 103:         return this.description;
 104:     }
 105: 
 106: }