org.mdiutil.io

Class ExtensionFilenameFilter

java.lang.Object

org.mdiutil.io.ExtensionFilenameFilter

All Implemented Interfaces:

FileFilter, FilenameFilter

public class ExtensionFilenameFilter
extends Object
implements FilenameFilter, FileFilter

A FileFilter utility class simplifying the creation of File filters.

Constructor Summary

Constructors

Constructor and Description
ExtensionFilenameFilter(Set<String> exts, String desc) Constructor.
ExtensionFilenameFilter(String desc) Constructor.
ExtensionFilenameFilter(String[] ext, String desc) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(File f) Return true if 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 previously created ExtensionFileFilter.
File	getCompatibleFile(File in) Creates 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()
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.
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

ExtensionFilenameFilter

public ExtensionFilenameFilter(String desc)

Constructor. This filter is not case sensitive.

Parameters:

desc - the filter description

ExtensionFilenameFilter

public ExtensionFilenameFilter(String[] ext,
                               String desc)

Constructor.

Example of use:

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

Parameters:

ext - the array of extensions

desc - the filter description

ExtensionFilenameFilter

public ExtensionFilenameFilter(Set<String> exts,
                               String desc)

Constructor. Beware that if the set given as input is a SortedSet, it will back this fileFilter. In this case, every change in the extensions will also change the input Set.

Example of use:

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

Parameters:

exts - the Set of extensions

desc - the filter description

Method Detail

add

public void add(String ext)

Add an extension to the previously created ExtensionFileFilter.

Parameters:

ext - the extension

getExtensions

public SortedSet<String> getExtensions()

hasUniqueExtension

public boolean hasUniqueExtension()

Returns True if this FileFilter accept one unique extension.

Returns:

true if this FileFilter accept one unique extensio

getUniqueExtension

public String getUniqueExtension()

If this FileFilter accept one unique extension, returns this extension.

Returns:

the unique extension or the first one

getCompatibleFile

public File getCompatibleFile(File in)

Creates 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 input file

Returns:

a file compatible with the extension filter

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

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 suffix

accept

public boolean accept(File f)

Return true if 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

Parameters:

f - the file

Returns:

true if the given file is accepted by this filter

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

Parameters:

name - the file name

Returns:

true if the given file is accepted by this filter

getDescription

public String getDescription()

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

Returns:

the description of this FileFilter