Rename DOMDataTreeCommitCohortRegistry to CommitCohortExtension

[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMDataTreeChangeService.java

diff --git a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeService.java b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeService.java
index e08892f1fb88ad427accf6d17edbf40ca8be1964..8585feae4e9e06440bf523e53449f6ddfb1f3b6f 100644 (file)
--- a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeService.java
+++ b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeService.java
@@ -7,46 +7,44 @@
  */
 package org.opendaylight.mdsal.dom.api;
 
-import javax.annotation.Nonnull;
-import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.opendaylight.yangtools.concepts.Registration;
 
 /**
- * A {@link DOMServiceExtension} which allows users to register for changes to a
- * subtree.
+ * A {@link DOMDataBroker.Extension} which allows users to register for changes to a subtree.
  */
-public interface DOMDataTreeChangeService extends DOMDataBrokerExtension {
+@NonNullByDefault
+public interface DOMDataTreeChangeService extends DOMDataBroker.Extension {
     /**
-     * Registers a {@link DOMDataTreeChangeListener} to receive notifications when data changes
-     * under a given path in the conceptual data tree.
+     * Registers a {@link DOMDataTreeChangeListener} to receive notifications when data changes under a given path in
+     * the conceptual data tree.
      *
      * <p>
-     * You are able to register for notifications for any node or subtree which can be represented
-     * using {@link DOMDataTreeIdentifier}.
+     * You are able to register for notifications for any node or subtree which can be represented using
+     * {@link DOMDataTreeIdentifier}.
      *
      * <p>
-     * You are able to register for data change notifications for a subtree or leaf even if it does
-     * not exist. You will receive notification once that node is created.
+     * You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will
+     * receive notification once that node is created.
      *
      * <p>
-     * If there is any pre-existing data in the data tree for the path for which you are
-     * registering, you will receive an initial data change event, which will contain all
-     * pre-existing data, marked as created.
+     * If there is any pre-existing data in the data tree for the path for which you are registering, you will receive
+     * an initial data change event, which will contain all pre-existing data, marked as created.
      *
      * <p>
-     * This method returns a {@link ListenerRegistration} object. To "unregister" your listener for
-     * changes call the {@link ListenerRegistration#close()} method on the returned object.
+     * This method returns a {@link Registration} object. To "unregister" your listener for changes call
+     * the {@link Registration#close()} method on the returned object.
      *
      * <p>
-     * You MUST explicitly unregister your listener when you no longer want to receive
-     * notifications. This is especially true in OSGi environments, where failure to do so during
-     * bundle shutdown can lead to stale listeners being still registered.
+     * You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially
+     * true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still
+     * registered.
      *
      * @param treeId Data tree identifier of the subtree which should be watched for changes.
      * @param listener Listener instance which is being registered
-     * @param <L> Listener type
-     * @return Listener registration object, which may be used to unregister your listener using
-     *         {@link ListenerRegistration#close()} to stop delivery of change events.
+     * @return A {@link Registration} object, which may be used to unregister your listener using
+     *         {@link Registration#close()} to stop delivery of change events.
+     * @throws NullPointerException if any of the arguments is {@code null}
      */
-    @Nonnull <L extends DOMDataTreeChangeListener> ListenerRegistration<L>
-                          registerDataTreeChangeListener(@Nonnull DOMDataTreeIdentifier treeId, @Nonnull L listener);
+    Registration registerDataTreeChangeListener(DOMDataTreeIdentifier treeId, DOMDataTreeChangeListener listener);
 }