Changeset 7392 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2014-08-14T11:27:38+02:00 (10 years ago)

Author:

Don-vip

Message:

code cleanup, javadoc update

Location:

trunk/src/org/openstreetmap/josm/io

Files:

• FileImporter.java (modified) (2 diffs)
• OsmImporter.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/io/FileImporter.java

@@ -21 +21 @@
 public abstract class FileImporter implements Comparable<FileImporter>, LayerChangeListener {
 
+    /**
+     * The extension file filter used to accept files.
+     */
     public final ExtensionFileFilter filter;
 
     private boolean enabled;
 
+    /**
+     * Constructs a new {@code FileImporter} with the given extension file filter.
+     * @param filter The extension file filter
+     */
     public FileImporter(ExtensionFileFilter filter) {
         this.filter = filter;
@@ -30 +37 @@
     }
 
+    /**
+     * Determines if this file importer accepts the given file.
+     * @param pathname The file to test
+     * @return {@code true} if this file importer accepts the given file, {@code false} otherwise
+     */
     public boolean acceptFile(File pathname) {
         return filter.acceptName(pathname.getName());

trunk/src/org/openstreetmap/josm/io/OsmImporter.java

@@ -18 +18 @@
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.gui.util.GuiHelper;
-import org.openstreetmap.josm.tools.Utils;
 
 public class OsmImporter extends FileImporter {
 
+    /**
+     * The OSM file filter (*.osm and *.xml files).
+     */
     public static final ExtensionFileFilter FILE_FILTER = new ExtensionFileFilter(
             "osm,xml", "osm", tr("OSM Server Files") + " (*.osm *.xml)");
 
+    /**
+     * Utility class containing imported OSM layer, and a task to run after it is added to MapView.
+     */
     public static class OsmImporterData {
 
@@ -51 +56 @@
     }
 
+    /**
+     * Constructs a new {@code OsmImporter} with the given extension file filter.
+     * @param filter The extension file filter
+     */
     public OsmImporter(ExtensionFileFilter filter) {
         super(filter);