us.daveread.basicquery.util

Class SuffixFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

us.daveread.basicquery.util.SuffixFileFilter

public class SuffixFileFilter
extends javax.swing.filechooser.FileFilter

A FileFilter that limits files to those that end with one of the supplied suffix values. A dot should be the first character of the suffix pattern if the entire suffix must match the pattern. If only the ending characters must match then the dot should be excluded. For example the suffix pattern ".txt" will match files ending with ".txt" while a suffix pattern of "xt" will match files ending in things like ".txt", ".pxt", ".ext", ".next" and so forth.

Author:

David Read

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	acceptedSuffixes The collection of suffixes that match the filter
private java.lang.String	description The description of the filter

Constructor Summary

Constructors

Constructor and Description
SuffixFileFilter(java.lang.String pDescription, java.lang.String[] pAcceptedSuffixes) Create a new filter with the supplied description and collection of suffixes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File file)
java.lang.String	getDescription()
java.io.File	makeWithPrimarySuffix(java.io.File file) Check whether the supplied file's name agrees with this suffix file filter.
private void	setAcceptedSuffixes(java.lang.String[] pAcceptedSuffixes) Set the collection of suffix patterns to be accepted by this filter
private void	setDescription(java.lang.String pDescription) Set the description for this filter

Methods inherited from class java.lang.Object

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

Field Detail

description

private java.lang.String description

The description of the filter

acceptedSuffixes

private java.lang.String[] acceptedSuffixes

The collection of suffixes that match the filter

Constructor Detail

SuffixFileFilter

public SuffixFileFilter(java.lang.String pDescription,
                java.lang.String[] pAcceptedSuffixes)

Create a new filter with the supplied description and collection of suffixes. Note that the suffixes are not case sensitive even on case sensitive operating systems.

Parameters:

pDescription - The description of the filter to be shown to the user

pAcceptedSuffixes - The set of file suffix patterns that match the filter

Method Detail

setDescription

private void setDescription(java.lang.String pDescription)

Set the description for this filter

Parameters:

pDescription - The filter description

setAcceptedSuffixes

private void setAcceptedSuffixes(java.lang.String[] pAcceptedSuffixes)

Set the collection of suffix patterns to be accepted by this filter

Parameters:

pAcceptedSuffixes - The accepted suffix patterns

makeWithPrimarySuffix

public java.io.File makeWithPrimarySuffix(java.io.File file)

Check whether the supplied file's name agrees with this suffix file filter. If not (e.g. the suffix is not a match) then append the first suffix in the list for this filter to the filename and return it. Otherwise return the original file name.

Parameters:

file - The file whose name is to be check against this filter

Returns:

The file name adjust ed match this suffix filter if necessary

accept

public boolean accept(java.io.File file)

Specified by:

accept in class javax.swing.filechooser.FileFilter

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class javax.swing.filechooser.FileFilter