de.ipk_gatersleben.bit.bi.edal.rmi.client.util

Class EdalFileNameExtensionFilter

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalAbstractFileFilter

de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalFileNameExtensionFilter

public class EdalFileNameExtensionFilter
extends EdalAbstractFileFilter

An implementation of EDALFileFilter that filters using a specified set of extensions. The extension for a file is the portion of the file name after the last ".". Files whose name does not contain a "." have no file name extension. File name extension comparisons are case insensitive.

The following example creates a EDALFileNameExtensionFilter that will show jpg files:

 EDALFileFilter filter = new EDALFileNameExtensionFilter("JPEG file", "jpg", "jpeg");
 EDALFileChooser fileChooser = ...;
 fileChooser.setFileFilter(filter);
 

Version:

1.0

Author:

Jinbo Chen

See Also:

EdalFileChooser.setFileFilter(de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalAbstractFileFilter)

Constructor Summary

Constructors

Constructor and Description
EdalFileNameExtensionFilter(String description, String... extensions) Creates a EDALFileNameExtensionFilter with the specified description and file name extensions.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(ClientPrimaryDataFile f) Tests the specified file, returning true if the file is accepted, false otherwise.
String	getDescription() The description of this filter.
String[]	getExtensions() Returns the set of file name extensions files are tested against.
String	toString() Returns a string representation of the EDALFileNameExtensionFilter.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdalFileNameExtensionFilter

public EdalFileNameExtensionFilter(String description,
                           String... extensions)

Creates a EDALFileNameExtensionFilter with the specified description and file name extensions. The returned EDALFileNameExtensionFilter will accept all directories and any file with a file name extension contained in extensions.

Parameters:

description - textual description for the filter, may be null

extensions - the accepted file name extensions

Throws:

IllegalArgumentException - if extensions is null, empty, contains null, or contains an empty string

See Also:

accept(de.ipk_gatersleben.bit.bi.edal.rmi.client.ClientPrimaryDataFile)

Method Detail

accept

public boolean accept(ClientPrimaryDataFile f)

Tests the specified file, returning true if the file is accepted, false otherwise. True is returned if the extension matches one of the file name extensions of this EDALFileFilter, or the file is a directory.

Specified by:

accept in class EdalAbstractFileFilter

Parameters:

f - the File to test

Returns:

true if the file is to be accepted, false otherwise

getDescription

public String getDescription()

The description of this filter. For example: "JPG and GIF Images."

Specified by:

getDescription in class EdalAbstractFileFilter

Returns:

the description of this filter

getExtensions

public String[] getExtensions()

Returns the set of file name extensions files are tested against.

Returns:

the set of file name extensions files are tested against

toString

public String toString()

Returns a string representation of the EDALFileNameExtensionFilter. This method is intended to be used for debugging purposes, and the content and format of the returned string may vary between implementations.

Overrides:

toString in class Object

Returns:

a string representation of this EDALFileNameExtensionFilter