java.lang.Object
- javax.swing.filechooser.FileFilter
- - adams.gui.core.ExtensionFileFilter

All Implemented Interfaces:

Serializable, Comparable<ExtensionFileFilter>

Direct Known Subclasses:

ExtensionFileFilterWithClass, JComponentWriterFileFilter
```
public class ExtensionFileFilter
extends FileFilter
implements Comparable<ExtensionFileFilter>, Serializable
```
A FileFilter for filtering files base on their extension. Directories are always accepted.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`EXT_ALL_FILES`	the "all files" extensions.
`protected boolean`	`m_CaseSensitive`	whether case-sensitive or not.
`protected String`	`m_Description`	the description of the filter.
`protected String[]`	`m_Extensions`	the extensions.

Constructor Summary

Constructors
Constructor	Description
`ExtensionFileFilter()`	Constructs a filter that matches all files.
`ExtensionFileFilter(String description, String extension)`	Constructs a filter that matches files with the given extension, not case-sensitive.
`ExtensionFileFilter(String description, String[] extensions)`	Constructs a filter that matches files with the given extension, not case-sensitive.
`ExtensionFileFilter(String description, String[] extensions, boolean caseSensitive)`	Constructs a filter that matches files with the given extension, not case-sensitive.
`ExtensionFileFilter(String description, String extension, boolean caseSensitive)`	Constructs a filter that matches files with the given extension, not case-sensitive.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(File f)`	Whether the given file is accepted by this filter.
`int`	`compareTo(ExtensionFileFilter o)`	Compares this image format with the specified filter for order.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`static ExtensionFileFilter`	`getCommandLineFileFilter()`	Returns a filter for commandline setup files.
`static ExtensionFileFilter`	`getCsvFileFilter()`	Returns a filter for CSV files.
`String`	`getDescription()`	The description of this filter.
`String[]`	`getExtensions()`	Returns the extensions.
`static ExtensionFileFilter`	`getFlowFileFilter()`	Returns a filter for flow files.
`static ExtensionFileFilter`	`getLogFileFilter()`	Returns a filter for log files.
`static ExtensionFileFilter`	`getModelFileFilter()`	Returns a filter for model files.
`static ExtensionFileFilter`	`getPdfFileFilter()`	Returns a filter for PDF files.
`static ExtensionFileFilter`	`getPropertiesFileFilter()`	Returns a filter for props files.
`static ExtensionFileFilter`	`getSerializedModelFileFilter()`	Returns a filter for serialized model files.
`static ExtensionFileFilter`	`getTextFileFilter()`	Returns a filter for text files.
`static ExtensionFileFilter`	`getZipFileFilter()`	Returns a filter for ZIP files.
`boolean`	`isCaseSensitive()`	Returns whether the filter is case-sensitive or not.
`String`	`toString()`	Returns a short description of the filter.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EXT_ALL_FILES
```
public static final String EXT_ALL_FILES
```
    the "all files" extensions.
    
    See Also:
    
    Constant Field Values
  - m_Description
```
protected String m_Description
```
    the description of the filter.
  - m_Extensions
```
protected String[] m_Extensions
```
    the extensions.
  - m_CaseSensitive
```
protected boolean m_CaseSensitive
```
    whether case-sensitive or not.
- Constructor Detail
  - ExtensionFileFilter
```
public ExtensionFileFilter()
```
    Constructs a filter that matches all files.
  - ExtensionFileFilter
```
public ExtensionFileFilter(String description,
                           String extension)
```
    Constructs a filter that matches files with the given extension, not case-sensitive.
    
    Parameters:
    
    description - the display string
    
    extension - the extensions of the files (no dot!)
  - ExtensionFileFilter
```
public ExtensionFileFilter(String description,
                           String[] extensions)
```
    Constructs a filter that matches files with the given extension, not case-sensitive.
    
    Parameters:
    
    description - the display string
    
    extensions - the extensions of the files (no dot!)
  - ExtensionFileFilter
```
public ExtensionFileFilter(String description,
                           String extension,
                           boolean caseSensitive)
```
    Constructs a filter that matches files with the given extension, not case-sensitive.
    
    Parameters:
    
    description - the display string
    
    extension - the extensions of the files (no dot!)
    
    caseSensitive - if true then the filter is case-sensitive
  - ExtensionFileFilter
```
public ExtensionFileFilter(String description,
                           String[] extensions,
                           boolean caseSensitive)
```
    Constructs a filter that matches files with the given extension, not case-sensitive.
    
    Parameters:
    
    description - the display string
    
    extensions - the extensions of the files (no dot!)
    
    caseSensitive - if true then the filter is case-sensitive
- Method Detail
  - accept
```
public boolean accept(File f)
```
    Whether the given file is accepted by this filter.
    
    Specified by:
    
    accept in class FileFilter
    
    Parameters:
    
    f - the file to check
    
    Returns:
    
    true if accepted
  - getDescription
```
public String getDescription()
```
    The description of this filter.
    
    Specified by:
    
    getDescription in class FileFilter
    
    Returns:
    
    the description
  - getExtensions
```
public String[] getExtensions()
```
    Returns the extensions.
    
    Returns:
    
    the extensions
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Returns whether the filter is case-sensitive or not.
    
    Returns:
    
    true if case-sensitive
  - compareTo
```
public int compareTo(ExtensionFileFilter o)
```
    Compares this image format with the specified filter for order. Returns a negative integer, zero, or a positive integer as this filter is less than, equal to, or greater than the specified filter.
    
    Specified by:
    
    compareTo in interface Comparable<ExtensionFileFilter>
    
    Parameters:
    
    o - the filter to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - equals
```
public boolean equals(Object obj)
```
    Indicates whether some other object is "equal to" this one.
    
    For some reason, we cannot override this method, using the result returned by the compareTo(ExtensionFileFilter) method. This results in the user no longer being able to change the file filter in the FileChooser dialog.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
  - toString
```
public String toString()
```
    Returns a short description of the filter.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the description
  - getTextFileFilter
```
public static ExtensionFileFilter getTextFileFilter()
```
    Returns a filter for text files.
    
    Returns:
    
    the text filter
  - getFlowFileFilter
```
public static ExtensionFileFilter getFlowFileFilter()
```
    Returns a filter for flow files.
    
    Returns:
    
    the flow filter
  - getLogFileFilter
```
public static ExtensionFileFilter getLogFileFilter()
```
    Returns a filter for log files.
    
    Returns:
    
    the log filter
  - getPropertiesFileFilter
```
public static ExtensionFileFilter getPropertiesFileFilter()
```
    Returns a filter for props files.
    
    Returns:
    
    the props filter
  - getModelFileFilter
```
public static ExtensionFileFilter getModelFileFilter()
```
    Returns a filter for model files.
    
    Returns:
    
    the model filter
  - getCsvFileFilter
```
public static ExtensionFileFilter getCsvFileFilter()
```
    Returns a filter for CSV files.
    
    Returns:
    
    the CSV filter
  - getPdfFileFilter
```
public static ExtensionFileFilter getPdfFileFilter()
```
    Returns a filter for PDF files.
    
    Returns:
    
    the PDF filter
  - getZipFileFilter
```
public static ExtensionFileFilter getZipFileFilter()
```
    Returns a filter for ZIP files.
    
    Returns:
    
    the ZIP filter
  - getSerializedModelFileFilter
```
public static ExtensionFileFilter getSerializedModelFileFilter()
```
    Returns a filter for serialized model files.
    
    Returns:
    
    the model filter
  - getCommandLineFileFilter
```
public static ExtensionFileFilter getCommandLineFileFilter()
```
    Returns a filter for commandline setup files.
    
    Returns:
    
    the commandline filter

Class ExtensionFileFilter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXT_ALL_FILES

m_Description

m_Extensions

m_CaseSensitive

Constructor Detail

ExtensionFileFilter

ExtensionFileFilter

ExtensionFileFilter

ExtensionFileFilter

ExtensionFileFilter

Method Detail

accept

getDescription

getExtensions

isCaseSensitive

compareTo

equals

toString

getTextFileFilter

getFlowFileFilter

getLogFileFilter

getPropertiesFileFilter

getModelFileFilter

getCsvFileFilter

getPdfFileFilter

getZipFileFilter

getSerializedModelFileFilter

getCommandLineFileFilter