io.scif.gui

Class FormatFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

io.scif.gui.FormatFileFilter

All Implemented Interfaces:

FileFilter, Comparable<FileFilter>

public class FormatFileFilter
extends FileFilter
implements FileFilter, Comparable<FileFilter>

A file filter for identifying the files supported by an associated Formats. Because these filters are queried repeatedly, opening a dataset during the checking process is disabled. Thus this filter will never accept a dataset that need to be opened to determine format support. File choosers should have an "All files" option to allow selection of such datasets.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
FormatFileFilter(Format format) Constructs a new filter that accepts files of the given format's type.

Method Summary

Modifier and Type	Method and Description
boolean	accept(File f) Accepts files in accordance with the associated format's Checker.
int	compareTo(FileFilter o) Compares two FileFilter objects alphanumerically.
String	getDescription() Gets the filter's description.
Format	getFormat() Returns the filter's format.
String	toString() Gets a string representation of this file filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatFileFilter

public FormatFileFilter(Format format)

Constructs a new filter that accepts files of the given format's type.

Parameters:

format - The format to use for verifying a file's type.

Method Detail

getFormat

public Format getFormat()

Returns the filter's format.

accept

public boolean accept(File f)

Accepts files in accordance with the associated format's Checker.

Specified by:

accept in interface FileFilter

Specified by:

accept in class FileFilter

getDescription

public String getDescription()

Gets the filter's description.

Specified by:

getDescription in class FileFilter

toString

public String toString()

Gets a string representation of this file filter.

Overrides:

toString in class Object

compareTo

public int compareTo(FileFilter o)

Compares two FileFilter objects alphanumerically.

Specified by:

compareTo in interface Comparable<FileFilter>