Changeset 11905 in josm for trunk/src/org/openstreetmap/josm/gui

Timestamp:

2017-04-14T21:23:29+02:00 (7 years ago)

Author:

Don-vip

Message:

sonar - squid:S2301 - Public methods should not contain selector arguments

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• MainFrame.java (modified) (1 diff)
• MapView.java (modified) (2 diffs)
• dialogs/LayerListDialog.java (modified) (2 diffs)
• layer/LayerManager.java (modified) (9 diffs)

trunk/src/org/openstreetmap/josm/gui/MainFrame.java

@@ -94 +94 @@
         // This listener is never removed, since the main frame exists forever.
         Main.getLayerManager().addActiveLayerChangeListener(e -> refreshTitle());
-        Main.getLayerManager().addLayerChangeListener(new ManageLayerListeners(), true);
+        Main.getLayerManager().addAndFireLayerChangeListener(new ManageLayerListeners());
 
         refreshTitle();

trunk/src/org/openstreetmap/josm/gui/MapView.java

@@ -255 +255 @@
         this.layerManager = layerManager;
         initialViewport = viewportData;
-        layerManager.addLayerChangeListener(this, true);
+        layerManager.addAndFireLayerChangeListener(this);
         layerManager.addActiveLayerChangeListener(this);
         Main.pref.addPreferenceChangeListener(this);
@@ -746 +746 @@
      */
     public void destroy() {
-        layerManager.removeLayerChangeListener(this, true);
+        layerManager.removeAndFireLayerChangeListener(this);
         layerManager.removeActiveLayerChangeListener(this);
         Main.pref.removePreferenceChangeListener(this);

trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java

@@ -323 +323 @@
     public void showNotify() {
         layerManager.addActiveLayerChangeListener(activateLayerAction);
-        layerManager.addLayerChangeListener(model, true);
+        layerManager.addAndFireLayerChangeListener(model);
         layerManager.addAndFireActiveLayerChangeListener(model);
         model.populate();
@@ -330 +330 @@
     @Override
     public void hideNotify() {
-        layerManager.removeLayerChangeListener(model, true);
+        layerManager.removeAndFireLayerChangeListener(model);
         layerManager.removeActiveLayerChangeListener(model);
         layerManager.removeActiveLayerChangeListener(activateLayerAction);

trunk/src/org/openstreetmap/josm/gui/layer/LayerManager.java

@@ -64 +64 @@
     }
 
+    /**
+     * Base class of layer manager events.
+     */
     protected static class LayerManagerEvent {
         private final LayerManager source;
@@ -215 +218 @@
     }
 
+    /**
+     * Add a layer (implementation).
+     * @param layer The layer to add
+     * @param initialZoom whether if the mapview must be zoomed at layer projection bounds
+     */
     protected synchronized void realAddLayer(Layer layer, boolean initialZoom) {
         if (containsLayer(layer)) {
@@ -240 +248 @@
     }
 
+    /**
+     * Remove the layer from the mapview (implementation).
+     * @param layer The layer to remove
+     */
     protected synchronized void realRemoveLayer(Layer layer) {
         GuiHelper.assertCallFromEdt();
@@ -256 +268 @@
     }
 
+    /**
+     * Remove a single layer from the mapview (implementation).
+     * @param layerToRemove The layer to remove
+     * @return A list of layers that should be removed afterwards.
+     */
     protected Collection<Layer> realRemoveSingleLayer(Layer layerToRemove) {
         updateLayers(mutableLayers -> mutableLayers.remove(layerToRemove));
@@ -273 +290 @@
     }
 
+    /**
+     * Move a layer to a new position (implementation).
+     * @param layer The layer to move.
+     * @param position The position.
+     * @throws IndexOutOfBoundsException if the position is out of bounds.
+     */
     protected synchronized void realMoveLayer(Layer layer, int position) {
         checkContainsLayer(layer);
@@ -360 +383 @@
     }
 
+    /**
+     * Checks if the specified layer is handled by this layer manager.
+     * @param layer layer to check
+     * @throws IllegalArgumentException if layer is not handled by this layer manager
+     */
     protected void checkContainsLayer(Layer layer) {
         if (!containsLayer(layer)) {
@@ -371 +399 @@
      * @param listener the listener.
      * @throws IllegalArgumentException If the listener was added twice.
+     * @see #addAndFireLayerChangeListener
      */
     public synchronized void addLayerChangeListener(LayerChangeListener listener) {
-        addLayerChangeListener(listener, false);
-    }
-
-    /**
-     * Adds a layer change listener
-     *
-     * @param listener the listener.
-     * @param fireAdd if we should fire an add event for every layer in this manager.
-     * @throws IllegalArgumentException If the listener was added twice.
-     */
-    public synchronized void addLayerChangeListener(LayerChangeListener listener, boolean fireAdd) {
         if (layerChangeListeners.contains(listener)) {
             throw new IllegalArgumentException("Listener already registered.");
         }
         layerChangeListeners.add(listener);
-        if (fireAdd) {
-            for (Layer l : getLayers()) {
-                listener.layerAdded(new LayerAddEvent(this, l, true));
-            }
+    }
+
+    /**
+     * Adds a layer change listener and fire an add event for every layer in this manager.
+     *
+     * @param listener the listener.
+     * @throws IllegalArgumentException If the listener was added twice.
+     * @see #addLayerChangeListener
+     * @since 11905
+     */
+    public synchronized void addAndFireLayerChangeListener(LayerChangeListener listener) {
+        addLayerChangeListener(listener);
+        for (Layer l : getLayers()) {
+            listener.layerAdded(new LayerAddEvent(this, l, true));
         }
     }
@@ -399 +427 @@
      *
      * @param listener the listener. Ignored if null or already registered.
+     * @see #removeAndFireLayerChangeListener
      */
     public synchronized void removeLayerChangeListener(LayerChangeListener listener) {
-        removeLayerChangeListener(listener, false);
-    }
-
-    /**
-     * Removes a layer change listener
-     *
-     * @param listener the listener.
-     * @param fireRemove if we should fire a remove event for every layer in this manager. The event is fired as if the layer was deleted but
-     * {@link LayerRemoveEvent#scheduleRemoval(Collection)} is ignored.
-     */
-    public synchronized void removeLayerChangeListener(LayerChangeListener listener, boolean fireRemove) {
         if (!layerChangeListeners.remove(listener)) {
             throw new IllegalArgumentException("Listener was not registered before: " + listener);
-        } else {
-            if (fireRemove) {
-                for (Layer l : getLayers()) {
-                    listener.layerRemoving(new LayerRemoveEvent(this, l));
-                }
-            }
+        }
+    }
+
+    /**
+     * Removes a layer change listener and fire a remove event for every layer in this manager.
+     * The event is fired as if the layer was deleted but
+     * {@link LayerRemoveEvent#scheduleRemoval(Collection)} is ignored.
+     *
+     * @param listener the listener.
+     * @see #removeLayerChangeListener
+     * @since 11905
+     */
+    public synchronized void removeAndFireLayerChangeListener(LayerChangeListener listener) {
+        removeLayerChangeListener(listener);
+        for (Layer l : getLayers()) {
+            listener.layerRemoving(new LayerRemoveEvent(this, l));
         }
     }
@@ -475 +503 @@
     }
 
+    /**
+     * Reset all layer manager state (implementation).
+     */
     protected synchronized void realResetState() {
         // The listeners trigger the removal of other layers