Changeset 11928 in josm for trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java

Timestamp:

2017-04-16T14:42:27+02:00 (7 years ago)

Author:

Don-vip

Message:

improve unit tests, javadoc

File:

• trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java

@@ -4 +4 @@
 /**
  * Classes that do not wish to implement all methods of DataSetListener
- * may use this class. Implement DatasetListenerAdapter.Listener and
+ * may use this class. Implement {@link DataSetListenerAdapter.Listener} and
  * pass this adapter instead of class itself.
- *
+ * @since 2622
  */
 public class DataSetListenerAdapter implements DataSetListener {
 
+    /**
+     * Single method dataset change event listener.
+     */
     @FunctionalInterface
     public interface Listener {
+        /**
+         * Called when notified about any type of dataset change event.
+         * @param event dataset change event
+         */
         void processDatasetEvent(AbstractDatasetChangedEvent event);
     }
@@ -17 +24 @@
     private final Listener listener;
 
+    /**
+     * Constructs a new {@code DataSetListenerAdapter}.
+     * @param listener listener for which its {@code processDatasetEvent()} method will be called for all events
+     */
     public DataSetListenerAdapter(Listener listener) {
         this.listener = listener;