Changeset 12097 in josm for trunk

Timestamp:

2017-05-10T22:37:07+02:00 (8 years ago)

Author:

michael2402

Message:

Improve documentation of data selection listener.

File:

• trunk/src/org/openstreetmap/josm/data/osm/DataSelectionListener.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/osm/DataSelectionListener.java

@@ -21 +21 @@
     /**
      * Called whenever the selection is changed.
-     * @param e The selection change event.
-     */
-    void selectionChanged(SelectionChangeEvent e);
+     *
+     * You get notified about the new selection, the elements that were added and removed and the layer that triggered the event.
+     * @param event The selection change event.
+     * @see SelectionChangeEvent
+     */
+    void selectionChanged(SelectionChangeEvent event);
 
     /**
@@ -53 +56 @@
          * <p>
          * This collection cannot be modified and will not change.
-         * @return The primitives
+         * @return The primitives that were removed
          */
         Set<OsmPrimitive> getRemoved();
@@ -63 +66 @@
          * <p>
          * This collection cannot be modified and will not change.
-         * @return The primitives
+         * @return The primitives that were added
          */
         Set<OsmPrimitive> getAdded();
@@ -76 +79 @@
          * Test if this event did not change anything.
          * <p>
-         * Should return true for all events that are fired.
+         * This will return <code>false</code> for all events that are sent to listeners, so you don't need to test it.
          * @return <code>true</code> if this did not change the selection.
          */