Changeset 32341 in osm for applications

Timestamp:

2016-06-20T17:21:21+02:00 (8 years ago)

Author:

floscher

Message:

Fix some problems detected by code analysis

Missing JavaDoc, public attributes that can be final, unnecessary initialization with null, …

Location:

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary

Files:

• MapillaryAbstractImage.java (modified) (2 diffs)
• io/download/MapillaryImageInfoDownloadThread.java (modified) (3 diffs)
• utils/MapillaryURL.java (modified) (1 diff)
• utils/MapillaryUtils.java (modified) (4 diffs)

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryAbstractImage.java

@@ -32 +32 @@
   protected double ca;
   /** Temporal position of the picture until it is uploaded. */
-  public LatLon tempLatLon;
+  private LatLon tempLatLon;
   /**
    * When the object is being dragged in the map, the temporal position is
    * stored here.
    */
-  public LatLon movingLatLon;
+  private LatLon movingLatLon;
   /** Temporal direction of the picture until it is uploaded */
-  public double tempCa;
+  private double tempCa;
   /**
    * When the object direction is being moved in the map, the temporal direction
@@ -132 +132 @@
   /**
    * Returns the sequence which contains this image.
+   * Never null.
    *
    * @return The MapillarySequence object that contains this MapillaryImage.
    */
   public MapillarySequence getSequence() {
-    if (this.sequence == null) {
-      this.sequence = new MapillarySequence();
-      this.sequence.add(this);
-    }
-
+    if (sequence == null) {
+      sequence = new MapillarySequence();
+      sequence.add(this);
+    }
     return this.sequence;
   }

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/io/download/MapillaryImageInfoDownloadThread.java

@@ -5 +5 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.net.MalformedURLException;
 import java.util.concurrent.ExecutorService;
 
@@ -11 +10 @@
 import javax.json.JsonArray;
 import javax.json.JsonObject;
+import javax.json.JsonReader;
 
 import org.openstreetmap.josm.Main;
@@ -50 +50 @@
       ));
     ) {
-      JsonObject jsonobj = Json.createReader(br).readObject();
-      if (!jsonobj.getBoolean("more"))
-        this.ex.shutdown();
-      JsonArray jsonarr = jsonobj.getJsonArray("ims");
-      JsonObject data;
-      for (int i = 0; i < jsonarr.size(); i++) {
-        data = jsonarr.getJsonObject(i);
-        String key = data.getString("key");
-        for (MapillaryAbstractImage image : MapillaryLayer.getInstance().getData().getImages()) {
-          if (
-            image instanceof MapillaryImage
-              && ((MapillaryImage) image).getKey().equals(key)
-              && ((MapillaryImage) image).getUser() == null
-          ) {
-            ((MapillaryImage) image).setUser(data.getString("user"));
-            ((MapillaryImage) image).setCapturedAt(data.getJsonNumber("captured_at").longValue());
+      try (JsonReader reader = Json.createReader(br)) {
+        JsonObject jsonObj = reader.readObject();
+        if (!jsonObj.getBoolean("more"))
+          this.ex.shutdown();
+        JsonArray jsonArr = jsonObj.getJsonArray("ims");
+        JsonObject data;
+        for (int i = 0; i < jsonArr.size(); i++) {
+          data = jsonArr.getJsonObject(i);
+          String key = data.getString("key");
+          for (MapillaryAbstractImage image : MapillaryLayer.getInstance().getData().getImages()) {
+            if (
+              image instanceof MapillaryImage
+                && ((MapillaryImage) image).getKey().equals(key)
+                && ((MapillaryImage) image).getUser() == null
+            ) {
+              ((MapillaryImage) image).setUser(data.getString("user"));
+              ((MapillaryImage) image).setCapturedAt(data.getJsonNumber("captured_at").longValue());
+            }
           }
         }
       }
-    } catch (MalformedURLException e) {
-      Main.error(e);
     } catch (IOException e) {
       Main.error(e);

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/utils/MapillaryURL.java

@@ -79 +79 @@
    * @param bounds the bounds in which you want to search for images
    * @param page number of the page to retrieve from the API
-   * @param selector
+   * @param selector if set, only a specific type of image is returned by the URL
    * @return the API-URL which gives you the images in the given bounds as JSON
    */

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/utils/MapillaryUtils.java

@@ -90 +90 @@
    * @param format The format of the date.
    * @return The date in Epoch format.
-   * @throws ParseException
+   * @throws ParseException if the date cannot be parsed with the given format
    */
   public static long getEpoch(String date, String format) throws ParseException {
@@ -153 +153 @@
 
   /**
-   * Joins two images into the same sequence.
-   *
-   * @param mapillaryAbstractImage
-   * @param mapillaryAbstractImage2
+   * Joins two images into the same sequence. One of them must be the last image of a sequence, the other one the beginning of a different one.
+   *
+   * @param mapillaryAbstractImage the first image, into whose sequence the images from the sequence of the second image are merged
+   * @param mapillaryAbstractImage2 the second image, whose sequence is merged into the sequence of the first image
    */
   public static synchronized void join(
@@ -210 +210 @@
       });
     } else {
-      Bounds zoomBounds = null;
+      Bounds zoomBounds;
       if (images.isEmpty()) {
         zoomBounds = new Bounds(new LatLon(0, 0));
@@ -236 +236 @@
 
   /**
-   * Separates two images belonging to the same sequence.
-   *
-   * @param mapillaryAbstractImage
-   * @param mapillaryAbstractImage2
+   * Separates two images belonging to the same sequence. The two images have to be consecutive in the same sequence.
+   * Two new sequences are created and all images up to (and including) either {@code imgA} or {@code imgB} (whichever appears first in the sequence) are put into the first of the two sequences.
+   * All others are put into the second new sequence.
+   *
+   * @param mapillaryAbstractImage one of the images marking where to split the sequence
+   * @param mapillaryAbstractImage2 the other image marking where to split the sequence, needs to be a direct neighbour of {@code mapillaryAbstractImage} in the sequence.
    */
   public static synchronized void unjoin(