org.geotoolkit.io
Class DefaultFileFilter

Object
  FileFilter
      DefaultFileFilter

All Implemented Interfaces:

FileFilter, FilenameFilter

@Immutable
public class DefaultFileFilter
extends FileFilter
implements FileFilter, FilenameFilter

A FileFilter implementation using Unix-style wildcards. A pattern is given to the constructor, which can contains the "*" and "?" wildcards.

Since:

1.2

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

FileNameExtensionFilter

Module:

utility/geotk-utility (download)

View source code for this class

Constructor Summary

DefaultFileFilter(String pattern)
Constructs a file filter for the specified pattern.

DefaultFileFilter(String pattern, String description)
Constructs a file filter for the specified pattern and description.

Method Summary

boolean	accept(File file) Tests if a specified file matches the pattern.
boolean	accept(File directory, String name) Tests if a specified file matches the pattern.
String	getDescription() Returns the description of this filter.

Methods inherited from class Object

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

Constructor Detail

DefaultFileFilter

public DefaultFileFilter(String pattern)

Constructs a file filter for the specified pattern. The pattern can contains the "*" and "?" wildcards.

Parameters:

pattern - The pattern. Example: "*.png"

DefaultFileFilter

public DefaultFileFilter(String pattern,
                         String description)

Constructs a file filter for the specified pattern and description. The pattern can contains the "*" and "?" wildcards.

Parameters:

pattern - The pattern (e.g. "*.png").

description - The description of this filter, usually for graphical user interfaces.

Method Detail

getDescription

public String getDescription()

Returns the description of this filter. For example: "PNG images". The default implementation returns the description given to the constructor, or the pattern without parent directories if no description has been given.

Specified by:

getDescription in class FileFilter

Returns:

The description of this filter.

accept

public boolean accept(File file)

Tests if a specified file matches the pattern.

Specified by:

accept in interface FileFilter

Specified by:

accept in class FileFilter

Parameters:

file - The file to be tested.

Returns:

true if and only if the name matches the pattern.

accept

public boolean accept(File directory,
                      String name)

Tests if a specified file matches the pattern.

Specified by:

accept in interface FilenameFilter

Parameters:

directory - The directory in which the file was found.

name - The name of the file.

Returns:

true if and only if the name matches the pattern.