Changeset 8855 in josm for trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java

Timestamp:

2015-10-10T21:01:42+02:00 (9 years ago)

Author:

Don-vip

Message:

sonar - Unused private method should be removed
sonar - Unused protected methods should be removed
sonar - Sections of code should not be "commented out"
sonar - Empty statements should be removed
sonar - squid:S1172 - Unused method parameters should be removed
sonar - squid:S1481 - Unused local variables should be removed

File:

• trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/actions/mapmode/MapMode.java

@@ -21 +21 @@
  * is another.
  *
- * MapModes should register/deregister all necessary listeners on the map's view
- * control.
+ * MapModes should register/deregister all necessary listeners on the map's view control.
  */
 public abstract class MapMode extends JosmAction implements MouseListener, MouseMotionListener {
@@ -32 +31 @@
     /**
      * Constructor for mapmodes without an menu
+     * @param mapFrame unused but kept for plugin compatibility. Can be {@code null}
      */
     public MapMode(String name, String iconName, String tooltip, Shortcut shortcut, MapFrame mapFrame, Cursor cursor) {
@@ -41 +41 @@
     /**
      * Constructor for mapmodes with an menu (no shortcut will be registered)
+     * @param mapFrame unused but kept for plugin compatibility. Can be {@code null}
      */
     public MapMode(String name, String iconName, String tooltip, MapFrame mapFrame, Cursor cursor) {
@@ -84 +85 @@
     }
 
-    // By default, all tools will work with all layers. Can be overwritten to require
-    // a special type of layer
+    /**
+     * Determines if layer {@code l} is supported by this map mode.
+     * By default, all tools will work with all layers.
+     * Can be overwritten to require a special type of layer
+     * @param l layer
+     * @return {@code true} if the layer is supported by this map mode
+     */
     public boolean layerIsSupported(Layer l) {
-        return true;
+        return l != null;
     }