info.bioinfweb.commons.io

Class ExtensionFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

info.bioinfweb.commons.io.ExtensionFileFilter

All Implemented Interfaces:

java.io.FileFilter, java.io.FilenameFilter

Direct Known Subclasses:

ContentExtensionFileFilter

public class ExtensionFileFilter
extends javax.swing.filechooser.FileFilter
implements java.io.FileFilter, java.io.FilenameFilter

A file filter that both inherits from the Swing class FileFilter and implements both the Java I/O interfaces FileFilter and FilenameFilter. It implements functionality similar to that of FileNameExtensionFilter but offers more features and allows extending this class, which is prohibited by FileNameExtensionFilter.

Since:

1.2.0

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static char	EXTENSION_SEPARATOR The character separating an extension from the file name.

Constructor Summary

Constructors

Constructor and Description
ExtensionFileFilter(java.lang.String description, boolean addExtensionListToDescription, java.util.List<java.lang.String> extensions) Creates a new instance of this class.
ExtensionFileFilter(java.lang.String description, boolean addExtensionListToDescription, java.lang.String... extensions) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File f) This default implementation accepts all files that are directories or that end with one of the defined extensions.
boolean	accept(java.io.File dir, java.lang.String name) Creates a file from dir and name and delegates to accept(File).
java.lang.String	getDefaultExtension() Returns the default file extension of this filter.
java.lang.String	getDescription()
java.util.List<java.lang.String>	getExtensions() Returns a list of all extensions accepted by this filter.
java.lang.String	getExtensionsAsString() Returns all extensions stored in this filter as a single string.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_SEPARATOR

public static final char EXTENSION_SEPARATOR

The character separating an extension from the file name.

See Also:

Constant Field Values

Constructor Detail

ExtensionFileFilter

public ExtensionFileFilter(java.lang.String description,
                           boolean addExtensionListToDescription,
                           java.lang.String... extensions)

Creates a new instance of this class.

Parameters:

description - the description of this file type to be displayed e.g. in open dialogs

addExtensionListToDescription - Specify true here, if a list of valid extensions shall be appended on the specified description in parentheses.

extensions - one and possibly additional alternative extensions accepted by this filter (All file extension should be specified without a leading '.'.)

Throws:

java.lang.NullPointerException - if description or any specified extension are null

java.lang.IllegalArgumentException - if not at least one extension has been specified

ExtensionFileFilter

public ExtensionFileFilter(java.lang.String description,
                           boolean addExtensionListToDescription,
                           java.util.List<java.lang.String> extensions)

Creates a new instance of this class.

Parameters:

description - the description of this file type to be displayed e.g. in open dialogs

addExtensionListToDescription - Specify true here, if a list of valid extensions shall be appended on the specified description in parentheses.

extensions - one and possibly additional alternative extensions accepted by this filter (All file extension should be specified without a leading '.'.)

Throws:

java.lang.NullPointerException - if description or any specified extension are null

java.lang.IllegalArgumentException - if not at least one extension has been specified

Method Detail

getExtensionsAsString

public java.lang.String getExtensionsAsString()

Returns all extensions stored in this filter as a single string.

Example: If the extensions jpeg, jpg and jpe would be have been passed to the constructor of this class, the return value would be "*.jpeg;*.jpg;*.jpe" (The path separator used, would depending on the operating system).

Returns:

a string concatenating all extensions of this filter

accept

public boolean accept(java.io.File f)

This default implementation accepts all files that are directories or that end with one of the defined extensions.

Inherited classes may add additional functionality to this method by overwriting, if the specified file extensions are ambiguous.

Specified by:

accept in interface java.io.FileFilter

Specified by:

accept in class javax.swing.filechooser.FileFilter

See Also:

FileFilter.accept(java.io.File), FileFilter.accept(File)

accept

public boolean accept(java.io.File dir,
                      java.lang.String name)

Creates a file from dir and name and delegates to accept(File).

Specified by:

accept in interface java.io.FilenameFilter

See Also:

FilenameFilter.accept(java.io.File, java.lang.String)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class javax.swing.filechooser.FileFilter

getDefaultExtension

public java.lang.String getDefaultExtension()

Returns the default file extension of this filter.

Returns:

the default file extension not including the leading '.'

getExtensions

public java.util.List<java.lang.String> getExtensions()

Returns a list of all extensions accepted by this filter. The first element of that list is equal to the return value of getDefaultExtension().

Returns:

an unmodifiable list of alternative file extensions