Class ExtensionFileFilter

java.lang.Object
javax.swing.filechooser.FileFilter
org.openstreetmap.josm.actions.ExtensionFileFilter
All Implemented Interfaces:
FileFilter

public class ExtensionFileFilter extends FileFilter implements FileFilter
A file filter that filters after the extension. Also includes a list of file filters used in JOSM.
Since:
32
  • Field Details

  • Constructor Details

    • ExtensionFileFilter

      public ExtensionFileFilter(String extension, String defaultExtension, String description)
      Construct an extension file filter by giving the extension to check after.
      Parameters:
      extension - The comma-separated list of file extensions
      defaultExtension - The default extension
      description - A short textual description of the file type
      Since:
      1169
  • Method Details

    • comparator

    • addImporter

      public static void addImporter(FileImporter importer)
      Adds a new file importer at the end of the global list. This importer will be evaluated after core ones.
      Parameters:
      importer - new file importer
      Since:
      10407
    • addImporterFirst

      public static void addImporterFirst(FileImporter importer)
      Adds a new file importer at the beginning of the global list. This importer will be evaluated before core ones.
      Parameters:
      importer - new file importer
      Since:
      10407
    • addExporter

      public static void addExporter(FileExporter exporter)
      Adds a new file exporter at the end of the global list. This exporter will be evaluated after core ones.
      Parameters:
      exporter - new file exporter
      Since:
      10407
    • addExporterFirst

      public static void addExporterFirst(FileExporter exporter)
      Adds a new file exporter at the beginning of the global list. This exporter will be evaluated before core ones.
      Parameters:
      exporter - new file exporter
      Since:
      10407
    • getImporters

      public static List<FileImporter> getImporters()
      Returns the list of file importers.
      Returns:
      unmodifiable list of file importers
      Since:
      10407
    • getExporters

      public static List<FileExporter> getExporters()
      Returns the list of file exporters.
      Returns:
      unmodifiable list of file exporters
      Since:
      10407
    • updateAllFormatsImporter

      public static void updateAllFormatsImporter()
      Updates the AllFormatsImporter that is contained in the importers list. If you do not use the importers variable directly, you don't need to call this.

      Updating the AllFormatsImporter is required when plugins add new importers that support new file extensions. The old AllFormatsImporter doesn't include the new extensions and thus will not display these files.

      Since:
      5131
    • getImportExtensionFileFilters

      Replies an ordered list of ExtensionFileFilters for importing. The list is ordered according to their description, an AllFormatsImporter is append at the end.
      Returns:
      an ordered list of ExtensionFileFilters for importing.
      Since:
      2029
    • getExportExtensionFileFilters

      Replies an ordered list of enabled ExtensionFileFilters for exporting. The list is ordered according to their description, an AllFormatsImporter is append at the end.
      Returns:
      an ordered list of enabled ExtensionFileFilters for exporting.
      Since:
      2029
    • getDefaultImportExtensionFileFilter

      Replies the default ExtensionFileFilter for a given extension
      Parameters:
      extension - the extension
      Returns:
      the default ExtensionFileFilter for a given extension
      Since:
      2029
    • getDefaultExportExtensionFileFilter

      Replies the default ExtensionFileFilter for a given extension
      Parameters:
      extension - the extension
      Returns:
      the default ExtensionFileFilter for a given extension
      Since:
      2029
    • applyChoosableImportFileFilters

      public static void applyChoosableImportFileFilters(AbstractFileChooser fileChooser, String extension, Predicate<ExtensionFileFilter> additionalTypes)
      Applies the choosable FileFilter to a AbstractFileChooser before using the file chooser for selecting a file for reading.
      Parameters:
      fileChooser - the file chooser
      extension - the default extension
      additionalTypes - matching types will additionally be added to the "file type" combobox.
      Since:
      14668 (signature)
    • applyChoosableExportFileFilters

      public static void applyChoosableExportFileFilters(AbstractFileChooser fileChooser, String extension, Predicate<ExtensionFileFilter> additionalTypes)
      Applies the choosable FileFilter to a AbstractFileChooser before using the file chooser for selecting a file for writing.
      Parameters:
      fileChooser - the file chooser
      extension - the default extension
      additionalTypes - matching types will additionally be added to the "file type" combobox.
      Since:
      14668 (signature)
    • newFilterWithArchiveExtensions

      public static ExtensionFileFilter newFilterWithArchiveExtensions(String extensions, String defaultExtension, String description, ExtensionFileFilter.AddArchiveExtension addArchiveExtension, List<String> archiveExtensions)
      Construct an extension file filter with the extensions supported by Compression automatically added to the extensions. The specified extensions will be added to the description in the form old-description (*.ext1, *.ext2).
      Parameters:
      extensions - The comma-separated list of file extensions
      defaultExtension - The default extension
      description - A short textual description of the file type without supported extensions in parentheses
      addArchiveExtension - Whether to also add the archive extensions to the description
      archiveExtensions - List of extensions to be added
      Returns:
      The constructed filter
    • newFilterWithArchiveExtensions

      public static ExtensionFileFilter newFilterWithArchiveExtensions(String extensions, String defaultExtension, String description, boolean addArchiveExtensionsToDescription)
      Construct an extension file filter with the extensions supported by Compression automatically added to the extensions. The specified extensions will be added to the description in the form old-description (*.ext1, *.ext2).
      Parameters:
      extensions - The comma-separated list of file extensions
      defaultExtension - The default extension
      description - A short textual description of the file type without supported extensions in parentheses
      addArchiveExtensionsToDescription - Whether to also add the archive extensions to the description
      Returns:
      The constructed filter
    • acceptName

      public boolean acceptName(String filename)
      Returns true if this file filter accepts the given filename.
      Parameters:
      filename - The filename to check after
      Returns:
      true if this file filter accepts the given filename (i.e if this filename ends with one of the extensions)
      Since:
      1169
    • accept

      public boolean accept(File pathname)
      Specified by:
      accept in interface FileFilter
      Specified by:
      accept in class FileFilter
    • getDescription

      Specified by:
      getDescription in class FileFilter
    • getExtensions

      Replies the comma-separated list of file extensions of this file filter.
      Returns:
      the comma-separated list of file extensions of this file filter, as a String
      Since:
      5131
    • getDefaultExtension

      Replies the default file extension of this file filter.
      Returns:
      the default file extension of this file filter
      Since:
      2029
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object