Changeset 9455 in josm for trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

Timestamp:

2016-01-15T01:31:57+01:00 (8 years ago)

Author:

Don-vip

Message:

session - refactor duplicated code, add javadoc, fix warnings

File:

• trunk/src/org/openstreetmap/josm/io/session/SessionReader.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

@@ -54 +54 @@
 /**
  * Reads a .jos session file and loads the layers in the process.
- *
+ * @since 4668
  */
 public class SessionReader {
 
     private static final Map<String, Class<? extends SessionLayerImporter>> sessionLayerImporters = new HashMap<>();
+
+    private URI sessionFileURI;
+    private boolean zip; // true, if session file is a .joz file; false if it is a .jos file
+    private ZipFile zipFile;
+    private List<Layer> layers = new ArrayList<>();
+    private int active = -1;
+    private final List<Runnable> postLoadTasks = new ArrayList<>();
+    private ViewportData viewport;
 
     static {
@@ -68 +76 @@
     }
 
+    /**
+     * Register a session layer importer.
+     *
+     * @param layerType layer type
+     * @param importer importer for this layer class
+     */
     public static void registerSessionLayerImporter(String layerType, Class<? extends SessionLayerImporter> importer) {
         sessionLayerImporters.put(layerType, importer);
     }
 
+    /**
+     * Returns the session layer importer for the given layer type.
+     * @param layerType layer type to import
+     * @return session layer importer for the given layer
+     */
     public static SessionLayerImporter getSessionLayerImporter(String layerType) {
         Class<? extends SessionLayerImporter> importerClass = sessionLayerImporters.get(layerType);
@@ -85 +104 @@
     }
 
-    private URI sessionFileURI;
-    private boolean zip; // true, if session file is a .joz file; false if it is a .jos file
-    private ZipFile zipFile;
-    private List<Layer> layers = new ArrayList<>();
-    private int active = -1;
-    private final List<Runnable> postLoadTasks = new ArrayList<>();
-    private ViewportData viewport;
-
     /**
      * @return list of layers that are later added to the mapview
@@ -124 +135 @@
     }
 
+    /**
+     * A class that provides some context for the individual {@link SessionLayerImporter}
+     * when doing the import.
+     */
     public class ImportSupport {
 
@@ -130 +145 @@
         private final List<LayerDependency> layerDependencies;
 
+        /**
+         * Path of the file inside the zip archive.
+         * Used as alternative return value for getFile method.
+         */
+        private String inZipPath;
+
+        /**
+         * Constructs a new {@code ImportSupport}.
+         * @param layerName layer name
+         * @param layerIndex layer index
+         * @param layerDependencies layer dependencies
+         */
         public ImportSupport(String layerName, int layerIndex, List<LayerDependency> layerDependencies) {
             this.layerName = layerName;
@@ -135 +162 @@
             this.layerDependencies = layerDependencies;
         }
-
-        /**
-         * Path of the file inside the zip archive.
-         * Used as alternative return value for getFile method.
-         */
-        private String inZipPath;
 
         /**
@@ -556 +577 @@
     }
 
+    /**
+     * Loads session from the given file.
+     * @param sessionFile session file to load
+     * @param zip {@code true} if it's a zipped session (.joz)
+     * @param progressMonitor progress monitor
+     * @throws IllegalDataException if invalid data is detected
+     * @throws IOException if any I/O error occurs
+     */
     public void loadSession(File sessionFile, boolean zip, ProgressMonitor progressMonitor) throws IllegalDataException, IOException {
-        if (progressMonitor == null) {
-            progressMonitor = NullProgressMonitor.INSTANCE;
-        }
-
         try (InputStream josIS = createInputStream(sessionFile, zip)) {
-            loadSession(josIS, sessionFile.toURI(), zip, progressMonitor);
+            loadSession(josIS, sessionFile.toURI(), zip, progressMonitor != null ? progressMonitor : NullProgressMonitor.INSTANCE);
         }
     }
@@ -621 +646 @@
     private static Element getElementByTagName(Element root, String name) {
         NodeList els = root.getElementsByTagName(name);
-        if (els.getLength() == 0) return null;
-        return (Element) els.item(0);
+        return els.getLength() > 0 ? (Element) els.item(0) : null;
     }
 }