com.lf.commons.io

Class SuffixFilter

java.lang.Object

javax.swing.filechooser.FileFilter

com.lf.commons.io.SuffixFilter

All Implemented Interfaces:

java.io.FileFilter

public class SuffixFilter
extends javax.swing.filechooser.FileFilter
implements java.io.FileFilter

Can be used to accept files in JFileChooser objects and for use with File objects (interface FileFilter).

The String[] parameter may contain file suffices to be recognized. The description parameter denotes little metadata for the user.

The parameter suffices may contain "class" or "CLASS" for Java class file suffices for example. It is not case sensitive, the lower-case forms will be used for checking. The second parameter could be something like "Java CLASS (*.class, *.CLASS)" for Java class files.

This class is used by TransformationPlugIn implementations. The BDTTumorTrafo for CARAMEL 2000 for example exports the instance of this class which accepts BDT files.

Since:

1.5

Version:

$Revision: 1.24 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description Description of the type represented by filter instances.
protected java.lang.String	id Unique ID for the represented file format ("png", "gif" etc.)
protected java.lang.String	pattern Pattern to be matched, suffices is set otherwise.
static int	PATTERN_REGEX Represents the regex pattern.
static int	PATTERN_SIMPLE_WITH_CASE Represents the simple pattern (case sensitive).
static int	PATTERN_SIMPLE_WITHOUT_CASE Represents the simple pattern (case insensitive).
protected java.lang.String[]	suffices Array with suffices to be used, pattern is set otherwise.
protected int	type The pattern type (PATTERN_SIMPLE_WITHOUT_CASE|...).

Constructor Summary

Constructors

Constructor and Description
SuffixFilter() Constructor method for i18n purposes only.
SuffixFilter(java.lang.String[] suffices, java.lang.String description, boolean autosuffix, java.lang.String id) Classic constructor based on the simple pattern type (case insensitive).
SuffixFilter(java.lang.String pattern, int type, java.lang.String description, boolean autosuffix, java.lang.String id) Enhanced constructor to build a more configurable filter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Extends the FileFilter class.
boolean	accept(org.apache.commons.vfs2.FileObject url) Extends the FileFilter class.
boolean	accept(java.lang.String filename) Extends the FileFilter class.
static boolean	checkPatternType(int type) Convenience method to check a given pattern type against the available types.
static SuffixFilter	createAcceptAllFileFilter(boolean autosuffix) Convenience method to create the "accept all" file filter.
boolean	equals(SuffixFilter tocheck) Checks whether another SuffixFilter instance does the same job.
java.lang.String	getDescription() Extends the FileFilter class.
java.lang.String	getID() Getter for the ID.
java.lang.String	getPattern() Getter for the pattern.
java.lang.String[]	getSuffices() Exports the internal array of suffices (String objects).
java.lang.String	getSufficesList() Exports the internal array of suffices.
int	getType() Getter for the type.
boolean	hasSuffices() Checks if this object is based on suffices instead of patterns.
java.lang.String	toString() Prints the file filter name.

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_SIMPLE_WITHOUT_CASE

public static final int PATTERN_SIMPLE_WITHOUT_CASE

Represents the simple pattern (case insensitive).

See Also:

Constant Field Values

PATTERN_SIMPLE_WITH_CASE

public static final int PATTERN_SIMPLE_WITH_CASE

Represents the simple pattern (case sensitive).

See Also:

Constant Field Values

PATTERN_REGEX

public static final int PATTERN_REGEX

Represents the regex pattern.

See Also:

Constant Field Values

suffices

protected java.lang.String[] suffices

Array with suffices to be used, pattern is set otherwise.

description

protected java.lang.String description

Description of the type represented by filter instances.

type

protected int type

The pattern type (PATTERN_SIMPLE_WITHOUT_CASE|...).

pattern

protected java.lang.String pattern

Pattern to be matched, suffices is set otherwise.

id

protected java.lang.String id

Unique ID for the represented file format ("png", "gif" etc.)

Constructor Detail

SuffixFilter

public SuffixFilter()
             throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

SuffixFilter

public SuffixFilter(java.lang.String[] suffices,
            java.lang.String description,
            boolean autosuffix,
            java.lang.String id)

Classic constructor based on the simple pattern type (case insensitive).

The parameter suffices may contain "class" or "CLASS" for Java class file suffices for example. It is not case sensitive, the lower-case forms will be used for checking. The second parameter could be something like "Java CLASS (*.class)" for Java class files.

Parameters:

suffices - These suffices shall be recognized

description - The description for the combo box

autosuffix - Add the suffices automatically like [class] -> "(*.class)" ?

id - Unique ID for the represented file format ("png", "gif" etc.)

Since:

1.5

SuffixFilter

public SuffixFilter(java.lang.String pattern,
            int type,
            java.lang.String description,
            boolean autosuffix,
            java.lang.String id)

Enhanced constructor to build a more configurable filter.

The given pattern may be a simple extension list like "zip jar" to match extensions directly (either case sensitive or ignoring the case). The pattern may be also a regular expression to match almost any type of file names.

Parameters:

pattern - The pattern to be matched

type - The pattern type (PATTERN_SIMPLE_WITHOUT_CASE|...)

description - The description for the combo box

autosuffix - Add the suffices automatically like [class] -> "(*.class)" ?

id - Unique ID for the represented file format ("png", "gif" etc.)

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

Method Detail

accept

public boolean accept(java.io.File file)

Extends the FileFilter class.

Specified by:

accept in interface java.io.FileFilter

Specified by:

accept in class javax.swing.filechooser.FileFilter

Parameters:

file - The file check

Returns:

Does the file belong to the defined set?

Since:

1.5

accept

public boolean accept(org.apache.commons.vfs2.FileObject url)

Extends the FileFilter class.

Parameters:

url - The URL check

Returns:

Does the URL belong to the defined set?

Since:

1.6

accept

public boolean accept(java.lang.String filename)

Extends the FileFilter class.

Parameters:

filename - The filename to check (without path)

Returns:

Does the file belong to the defined set?

Since:

1.5

getDescription

public java.lang.String getDescription()

Extends the FileFilter class.

Specified by:

getDescription in class javax.swing.filechooser.FileFilter

Returns:

The identifier for the combo box

Since:

1.5

getSuffices

public java.lang.String[] getSuffices()

Exports the internal array of suffices (String objects).

Returns:

The suffices String array, may be null if pattern is used

Since:

1.5

getSufficesList

public java.lang.String getSufficesList()

Exports the internal array of suffices.

Returns:

The suffices as SPACE separated list, may be null if pattern is used

Since:

1.6

See Also:

getPattern()

equals

public boolean equals(SuffixFilter tocheck)

Checks whether another SuffixFilter instance does the same job.

We check both the suffices and the type description for this.

Parameters:

tocheck - The other SuffixFilter to be checked

Returns:

Is the parameter equal to this instance?

Since:

1.5

toString

public java.lang.String toString()

Prints the file filter name.

Overrides:

toString in class java.lang.Object

Returns:

The file filter name

Since:

1.6

createAcceptAllFileFilter

public static SuffixFilter createAcceptAllFileFilter(boolean autosuffix)

Convenience method to create the "accept all" file filter.

Parameters:

autosuffix - Add the suffices automatically like [class] -> "(*.class)" ?

Returns:

The "accept all" file filter

Since:

1.6

checkPatternType

public static boolean checkPatternType(int type)

Convenience method to check a given pattern type against the available types.

Parameters:

type - The pattern type

Returns:

Type OK?

Since:

1.6

getType

public int getType()

Getter for the type.

Returns:

The pattern type (PATTERN_SIMPLE_WITHOUT_CASE|...)

Since:

1.6

getPattern

public java.lang.String getPattern()

Getter for the pattern.

Returns:

Pattern to be matched, suffices is set otherwise

Since:

1.6

See Also:

getSufficesList()

hasSuffices

public boolean hasSuffices()

Checks if this object is based on suffices instead of patterns.

Returns:

Suffices mode or pattern mode otherwise?

Since:

1.6

getID

public java.lang.String getID()

Getter for the ID.

Returns:

Arbitrary object as unique ID for the represented file format ("png", "gif" etc.)

Since:

1.6