org.mdiutil.swing

Class ExtensionFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

org.mdiutil.swing.ExtensionFileFilter

All Implemented Interfaces:

FileFilter, FilenameFilter

public class ExtensionFileFilter
extends FileFilter
implements FilenameFilter, FileFilter

This class is FileFilter which uses the File extension to filter the file. It is compatible with all the JDK classes filtering Files. Note that the extension is not case sensitive.

Constructor Summary

Constructors

Constructor and Description
ExtensionFileFilter(ExtensionFilenameFilter filter) Constructor.
ExtensionFileFilter(String desc) Constructor.
ExtensionFileFilter(String[] ext, String desc) Constructor.
ExtensionFileFilter(String ext, String desc) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(File f) Return whether the given file is accepted by this filter.
boolean	accept(File dir, String name) Tests if a specified file should be included in a file list.
void	add(String ext) Add an extension to the ExtensionFileFilter.
static ExtensionFileFilter	createFromExtensions(String desc, String... ext) Static constructor allowing to use a vararg for the array of extensions.
File	getCompatibleFile(File in) Create a File compatible with this FileFilter extension, if the input file has no extension.
String	getDescription() Return the description of this FileFilter.
SortedSet<String>	getExtensions() Return the extensions.
static String	getNamePrefix(File f) Utility method to retrieve the name prefix of a file.
static String	getSuffix(File f) Utility method to retrieve the suffix of a file.
String	getUniqueExtension() If this FileFilter accept one unique extension, returns this extension, else return null.
boolean	hasUniqueExtension() Returns true if this FileFilter accept one unique extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionFileFilter

public ExtensionFileFilter(String desc)

Constructor.

Parameters:

desc - the description of the FileFilter

ExtensionFileFilter

public ExtensionFileFilter(String ext,
                           String desc)

Constructor.

Usage

     String ext = "jpg";
     graphicfilter = new ExtensionFileFilter(ext,"JPEG images");
 

Parameters:

ext - the extension

desc - the description of the FileFilter

ExtensionFileFilter

public ExtensionFileFilter(String[] ext,
                           String desc)

Constructor.

Usage

     String[] ext = {"jpg","jpeg","tiff","png","svg"};
     graphicfilter = new ExtensionFileFilter(ext,"JPEG,PNG,TIFF,SVG images");
 

Parameters:

ext - the extensions

desc - the description of the FileFilter

ExtensionFileFilter

public ExtensionFileFilter(ExtensionFilenameFilter filter)

Constructor. Beware that every change in the extensions will also change the input Set of extensions for its FileFilter.

Usage

     String[] ext = {"jpg","jpeg","tiff","png","svg"};
     graphicfilter = new ExtensionFileFilter(ext,"JPEG,PNG,TIFF,SVG images");
 

Parameters:

filter - the ExtensionFilenameFilter

Method Detail

createFromExtensions

public static ExtensionFileFilter createFromExtensions(String desc,
                                                       String... ext)

Static constructor allowing to use a vararg for the array of extensions.

Parameters:

desc - the description

ext - the extensions

Returns:

the ExtensionFileFilter

add

public void add(String ext)

Add an extension to the ExtensionFileFilter. Note that the extension is not case sensitive.

Parameters:

ext - the extension

hasUniqueExtension

public boolean hasUniqueExtension()

Returns true if this FileFilter accept one unique extension.

Returns:

true if this FileFilter accept one unique extension

getUniqueExtension

public String getUniqueExtension()

If this FileFilter accept one unique extension, returns this extension, else return null.

Returns:

the unique extension or null if there are more than one extension managed by this FileFilter

getExtensions

public SortedSet<String> getExtensions()

Return the extensions.

Returns:

the extensions

getCompatibleFile

public File getCompatibleFile(File in)

Create a File compatible with this FileFilter extension, if the input file has no extension.

• If the input file has already one extension, return this file
• Else :
• If this FileFilter accepts one unique extension, add the extension to the input file name
• Else return the input file

Parameters:

in - the File

Returns:

the compatible File

getNamePrefix

public static String getNamePrefix(File f)

Utility method to retrieve the name prefix of a file.

• If the file is named "<name>.<suffix>", the String <name> is returned
• Else the file name is returned

Parameters:

f - the File

Returns:

the File name prefix (without the extension)

getSuffix

public static String getSuffix(File f)

Utility method to retrieve the suffix of a file.

• If the file is named "*.<suffix>", the String <suffix> is returned
• Else an empty String ("") si returned

Parameters:

f - the File

Returns:

the File name suffix (the extension)

accept

public boolean accept(File f)

Return whether the given file is accepted by this filter. The file is accepted if its suffix corresponds with the accepted extensions of the FileFilter.

Specified by:

accept in interface FileFilter

Specified by:

accept in class FileFilter

Parameters:

f - the File

accept

public boolean accept(File dir,
                      String name)

Tests if a specified file should be included in a file list. The file of name name is accepted if its suffix corresponds with the accepted extensions of the FileFilter

Specified by:

accept in interface FilenameFilter

getDescription

public String getDescription()

Return the description of this FileFilter. For example: "JPG and GIF Images"

Specified by:

getDescription in class FileFilter

Returns:

the description of this FileFilter