001    /* FileView.java --
002       Copyright (C) 2002, 2004, 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.Icon;
044    
045    /**
046     * An abstract class that provides presentation information about files and 
047     * directories.  .
048     * 
049     * @author  Andrew Selkirk
050     */
051    public abstract class FileView 
052    {
053    
054      /**
055       * Creates a new <code>FileView</code> instance.
056       */
057      public FileView() 
058      {
059        // Nothing to do here.
060      } 
061    
062      /**
063       * Returns the name for the specified file.  This method always returns
064       * <code>null</code> and should be overridden by subclasses.
065       * 
066       * @param file  the file.
067       * 
068       * @return Always <code>null</code>.
069       */
070      public String getName(File file) 
071      {
072        return null;
073      } 
074    
075      /**
076       * Returns a description for the specified file.  This method always returns
077       * <code>null</code> and should be overridden by subclasses.
078       * 
079       * @param file  the file.
080       * 
081       * @return Always <code>null</code>.
082       */
083      public String getDescription(File file) 
084      {
085        return null;
086      } 
087    
088      /**
089       * Returns a description for the type of the specified file.  This method 
090       * always returns <code>null</code> and should be overridden by subclasses.
091       * 
092       * @param file  the file.
093       * 
094       * @return Always <code>null</code>.
095       */
096      public String getTypeDescription(File file) 
097      {
098        return null;
099      } 
100    
101      /**
102       * Returns an {@link Icon} to represent the specified file.  This method 
103       * always returns <code>null</code> and should be overridden by subclasses.
104       * 
105       * @param file  the file.
106       * 
107       * @return Always <code>null</code>.
108       */
109      public Icon getIcon(File file) 
110      {
111        return null;
112      } 
113    
114      /**
115       * Returns {@link Boolean#TRUE} if the given directory is traversable, and
116       * {@link Boolean#FALSE} if it is not.  This method always returns 
117       * <code>null</code> and should be overridden by subclasses.
118       * 
119       * @param directory  the directory.
120       * 
121       * @return Always <code>null</code>.
122       */
123      public Boolean isTraversable(File directory) 
124      {
125        return null;
126      } 
127    
128    }