Changeset 34325 in osm for applications/editors/josm/plugins/MicrosoftStreetside/src

Timestamp:

2018-06-19T19:14:05+02:00 (7 years ago)

Author:

donvip

Message:

fix warnings

Location:

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside

Files:

• StreetsideImage.java (modified) (3 diffs)
• StreetsideImportedImage.java (modified) (2 diffs)
• StreetsideLayer.java (modified) (3 diffs)
• StreetsidePlugin.java (modified) (2 diffs)
• StreetsideSequence.java (modified) (4 diffs)
• cache/CacheUtils.java (modified) (1 diff)
• cubemap/CubemapUtils.java (modified) (1 diff)
• cubemap/ITileDownloadingTaskListener.java (modified) (2 diffs)
• cubemap/TileDownloadingTask.java (modified) (1 diff)
• gui/imageinfo/ImageInfoPanel.java (modified) (4 diffs)
• gui/imageinfo/StreetsideViewerPanel.java (modified) (5 diffs)
• history/commands/CommandTurn.java (modified) (1 diff)
• io/download/StreetsideDownloader.java (modified) (1 diff)
• mode/package-info.java (modified) (1 diff)
• utils/StreetsideProperties.java (modified) (2 diffs)
• utils/StreetsideURL.java (modified) (2 diffs)
• utils/api/JsonSequencesDecoder.java (modified) (3 diffs)
• utils/api/JsonStreetsideSequencesDecoder.java (modified) (3 diffs)

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/StreetsideImage.java

@@ -65 +65 @@
    * Main constructor of the class StreetsideImage
    *
-   * @param key    The unique identifier of the image.
+   * @param id     The unique identifier of the image.
    * @param latLon The latitude and longitude where it is positioned.
-   * @param cd     The direction of the images in degrees, meaning 0 north.
-   */
-
+   * @param he     The direction of the images in degrees, meaning 0 north.
+   */
   public StreetsideImage(String id, LatLon latLon, double he) {
     super(id, latLon, he);
@@ -205 +204 @@
 
   /**
-   * @param pi the pi to set
+   * @param pitch the pi to set
    */
   public void setPi(double pitch) {
@@ -219 +218 @@
 
   /**
-   * @param burringl the burringl to set
+   * @param blurring the blurring to set
    */
   public void setBl(String blurring) {

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/StreetsideImportedImage.java

@@ -34 +34 @@
    * Using when the EXIF tags doesn't contain that info.
    *
+   * @param id  The Streetside image id
    * @param latLon  The latitude and longitude where the picture was taken.
-   * @param cd  Direction of the picture (0 means north).
+   * @param ca  Direction of the picture (0 means north).
    * @param file  The file containing the picture.
    */
@@ -45 +46 @@
    * Main constructor of the class.
    *
+   * @param id  The Streetside image id
    * @param latLon  Latitude and Longitude where the picture was taken.
-   * @param cd  Direction of the picture (0 means north),
+   * @param ca  Direction of the picture (0 means north),
    * @param file  The file containing the picture.
    * @param datetimeOriginal  The date the picture was taken.

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/StreetsideLayer.java

@@ -218 +218 @@
            * Layer.
            *
-           * @return The {@link MapillaryData} object that stores the database.
+           * @return The {@link StreetsideData} object that stores the database.
            */
           public StreetsideLocationChangeset getLocationChangeset() {
@@ -333 +333 @@
         }
 
-        /**
+        /*
          * Draws an image marker onto the given Graphics context.
          * @param g the Graphics context
@@ -524 +524 @@
         }
 
-        /**
+        /*
          * Returns the closest images belonging to a different sequence and
          * different from the specified target image.

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/StreetsidePlugin.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.plugins.streetside;
-
-import java.io.IOException;
 
 import org.openstreetmap.josm.Main;
@@ -59 +57 @@
    * @param info
    *          Required information of the plugin. Obtained from the jar file.
-   * @throws IOException if the streetside cache directory is not found
    */
-  public StreetsidePlugin(PluginInformation info) /*throws IOException*/ {
+  public StreetsidePlugin(PluginInformation info) {
     super(info);
 

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/StreetsideSequence.java

@@ -37 +37 @@
   private List<StreetsideAbstractImage> images;
 
-  /**
-   * Unique identifier. Used only for {@link StreetsideImage} sequences.
-   */
-
-  /**
-   * @param string
-   * @param string2
-   * @param capturedAt2
-   */
   public StreetsideSequence(String id, Long ca) {
         this.id = id;
@@ -52 +43 @@
   }
 
-  /**
-   * @param string
-   * @param la
-   * @param lo
-   */
   public StreetsideSequence(String id, double la, double lo) {
     this.id = id;
@@ -65 +51 @@
 
   /**
-   *    No argument constructor for StreetsideSequence - necessary for JSON serialization
+   * No argument constructor for StreetsideSequence - necessary for JSON serialization
    */
   public StreetsideSequence() {
@@ -85 +71 @@
 }
 
-/**
+  /**
    * Adds a new {@link StreetsideAbstractImage} object to the database.
    *

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/cache/CacheUtils.java

@@ -53 +53 @@
 * image. Does nothing if it is already in cache.
 *
-* @param img
+* @param cm
 *          The image whose picture is going to be downloaded.
 */

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/cubemap/CubemapUtils.java

@@ -17 +17 @@
                     SIXTEEN(16);
 
-                    private int value;
+                    private final int value;
                     private static Map<Integer, CubefaceType> map = new HashMap<>();
 

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/cubemap/ITileDownloadingTaskListener.java

@@ -3 +3 @@
 
 /**
-* Interface for listeners of the class {@link StreetsideData}.
+* Interface for listeners of the class {@link org.openstreetmap.josm.plugins.streetside.StreetsideData}.
 *
 * @author renerr18
@@ -10 +10 @@
 public interface ITileDownloadingTaskListener {
 
-/**
-* Fired when a cubemap tile image is downloaded by a download worker.
-*
-*/
-void tileAdded(String imageId);
+ /**
+ * Fired when a cubemap tile image is downloaded by a download worker.
+ * @param imageId image id 
+ */
+ void tileAdded(String imageId);
 }

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/cubemap/TileDownloadingTask.java

@@ -56 +56 @@
 
         /**
-         * @param tileId the tileId to set
+         * @param id the tileId to set
          */
         public void setId(String id) {

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/gui/imageinfo/ImageInfoPanel.java

@@ -18 +18 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.openstreetmap.josm.data.SelectionChangedListener;
-import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.DataSelectionListener;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Tag;
+import org.openstreetmap.josm.data.osm.event.SelectionEventManager;
 import org.openstreetmap.josm.data.preferences.AbstractProperty.ValueChangeListener;
 import org.openstreetmap.josm.gui.dialogs.ToggleDialog;
@@ -34 +34 @@
 import org.openstreetmap.josm.tools.I18n;
 
-public final class ImageInfoPanel extends ToggleDialog implements StreetsideDataListener, SelectionChangedListener {
+public final class ImageInfoPanel extends ToggleDialog implements StreetsideDataListener, DataSelectionListener {
   private static final long serialVersionUID = 4141847503072417190L;
   private static final Log L = LogFactory.getLog(ImageInfoPanel.class);
@@ -59 +59 @@
       150
     );
-    DataSet.addSelectionListener(this);
+    SelectionEventManager.getInstance().addSelectionListener(this);
 
     //numDetectionsLabel = new JLabel();
@@ -232 +232 @@
    */
   @Override
-  public synchronized void selectionChanged(final Collection<? extends OsmPrimitive> sel) {
+  public synchronized void selectionChanged(final SelectionChangeEvent event) {
+    final Collection<? extends OsmPrimitive> sel = event.getSelection();
     L.debug(String.format("Selection changed. %d primitives are selected.", sel == null ? 0 : sel.size()));
     addStreetsideTagAction.setTarget(sel != null && sel.size() == 1 ? sel.iterator().next() : null);

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/gui/imageinfo/StreetsideViewerPanel.java

@@ -3 +3 @@
 
 import java.awt.BorderLayout;
-import java.util.Collection;
 
 import javax.swing.JCheckBox;
@@ -9 +8 @@
 import javax.swing.SwingUtilities;
 
-import org.openstreetmap.josm.data.SelectionChangedListener;
-import org.openstreetmap.josm.data.osm.DataSet;
-import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.preferences.AbstractProperty.ValueChangeListener;
 import org.openstreetmap.josm.plugins.streetside.StreetsideAbstractImage;
@@ -28 +24 @@
 
 public final class StreetsideViewerPanel extends JPanel
-                implements StreetsideDataListener, SelectionChangedListener {
+                implements StreetsideDataListener {
 
         private static final long serialVersionUID = 4141847503072417190L;
@@ -56 +52 @@
 
         private void initializeAndStartGUI() {
-
-                DataSet.addSelectionListener(this);
 
                 threeSixtyDegreeViewerPanel = new ThreeSixtyDegreeViewerPanel();
@@ -150 +144 @@
         }
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see
-         * org.openstreetmap.josm.data.SelectionChangedListener#selectionChanged(java.
-         * util.Collection)
-         */
-        @Override
-        public synchronized void selectionChanged(final Collection<? extends OsmPrimitive> sel) {
-                Logging.debug(String.format("Selection changed. %d primitives are selected.", sel == null ? 0 : sel.size()));
-        }
-
         public CubemapBox getCubemapBox() {
                 return threeSixtyDegreeViewerPanel.getCubemapBox();

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/history/commands/CommandTurn.java

@@ -23 +23 @@
    * @param images
    *          Set of images that is turned.
-   * @param cd
+   * @param ca
    *          How much the images turn.
    */

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/io/download/StreetsideDownloader.java

@@ -198 +198 @@
    * lots of Streetside images are going to be downloaded, slowing down the
    * program too much. A notification is shown when the download has stopped or continued.
+   * @param area area to check 
+   * @return {@code true} if the area is too big
    */
   private static boolean isAreaTooBig(final double area) {

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/mode/package-info.java

@@ -5 +5 @@
  * Currently there are two of them:
  * <ul>
- *  <li><strong>{@link org.openstreetmap.josm.plugins.mapillary.mode.JoinMode}</strong> for joining pictures to make sequences</li>
- *  <li><strong>{@link org.openstreetmap.josm.plugins.mapillary.mode.SelectMode}</strong> for selecting pictures in the layer</li>
+ *  <li><strong>{@link org.openstreetmap.josm.plugins.streetside.mode.JoinMode JoinMode}</strong> for joining pictures to make sequences</li>
+ *  <li><strong>{@link org.openstreetmap.josm.plugins.streetside.mode.SelectMode SelectMode}</strong> for selecting pictures in the layer</li>
  * </ul>
  */

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/utils/StreetsideProperties.java

@@ -9 +9 @@
 import org.openstreetmap.josm.data.preferences.NamedColorProperty;
 import org.openstreetmap.josm.data.preferences.StringProperty;
-import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.plugins.streetside.gui.imageinfo.ImageInfoPanel;
+import org.openstreetmap.josm.plugins.streetside.gui.imageinfo.StreetsideViewerPanel;
 import org.openstreetmap.josm.plugins.streetside.io.download.StreetsideDownloader;
 
@@ -37 +37 @@
 
   /**
-   * @see OsmDataLayer#PROPERTY_BACKGROUND_COLOR
+   * See {@code OsmDataLayer#PROPERTY_BACKGROUND_COLOR}
    */
   public static final NamedColorProperty BACKGROUND = new NamedColorProperty("background", Color.BLACK);
   /**
-   * @see OsmDataLayer#PROPERTY_OUTSIDE_COLOR
+   * See {@code OsmDataLayer#PROPERTY_OUTSIDE_COLOR}
    */
   public static final NamedColorProperty OUTSIDE_DOWNLOADED_AREA = new NamedColorProperty("outside downloaded area", Color.YELLOW);

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/utils/StreetsideURL.java

@@ -193 +193 @@
                 /**
                  * Gives you the URL for the blur editor of the image with the given key.
-                 * @param key the key of the image for which you want to open the blur editor
+                 * @param id the key of the image for which you want to open the blur editor
                  * @return the URL of the blur editor
                  * @throws IllegalArgumentException if the image key is <code>null</code>
@@ -334 +334 @@
         }
 
-        /**
-         *
-         */
         static String queryByIdString(Map<String, String> parts) {
                 final StringBuilder ret = new StringBuilder("?id=");

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/utils/api/JsonSequencesDecoder.java

@@ -28 +28 @@
    * Parses a given {@link JsonObject} as a GeoJSON Feature into a {@link StreetsideSequence}.
    * @param json the {@link JsonObject} to be parsed
-   * @return a {@link Streetsideequence} that is parsed from the given {@link JsonObject}. If mandatory information is
+   * @return a {@link StreetsideSequence} that is parsed from the given {@link JsonObject}. If mandatory information is
    *         missing from the JSON or it's not meeting the expecting format in another way, <code>null</code> will be
    *         returned.
@@ -72 +72 @@
    * Converts a {@link JsonArray} to a java array.
    * The conversion from {@link JsonValue} to a java type is done by the supplied function.
+   * @param <T> object type
    * @param array the array to be converted
    * @param decodeValueFunction the function used for conversion from {@link JsonValue} to the desired type.
@@ -98 +99 @@
    * For example this is used to convert the `image_keys` JSON array to a String[] array or the `cas` JSON array to a
    * Double[] array.
+   * @param <T> object type
    * @param json the JSON object representing the `properties` of a sequence
    * @param key the key, which identifies the desired array inside the `coordinateProperties` object to be converted

applications/editors/josm/plugins/MicrosoftStreetside/src/org/openstreetmap/josm/plugins/streetside/utils/api/JsonStreetsideSequencesDecoder.java

@@ -70 +70 @@
 
   /**
-   * Parses a given {@link JsonObject} as a GeoJSON Feature into a {@link StreetsideSequence}.
-   * @param json the {@link JsonObject} to be parsed
+   * Parses a given {@link StreetsideImage} as a GeoJSON Feature into a {@link StreetsideSequence}.
+   * @param image the {@link StreetsideImage} to be parsed
    * @return a {@link StreetsideSequence} that is parsed from the given {@link JsonObject}. If mandatory information is
    *         missing from the JSON or it's not meeting the expecting format in another way, <code>null</code> will be
@@ -123 +123 @@
    * Converts a {@link JsonArray} to a java array.
    * The conversion from {@link JsonValue} to a java type is done by the supplied function.
+   * @param <T> object type
    * @param array the array to be converted
    * @param decodeValueFunction the function used for conversion from {@link JsonValue} to the desired type.
@@ -149 +150 @@
    * For example this is used to convert the `image_keys` JSON array to a String[] array or the `cas` JSON array to a
    * Double[] array.
+   * @param <T> object type
    * @param json the JSON object representing the `properties` of a sequence
    * @param key the key, which identifies the desired array inside the `coordinateProperties` object to be converted