X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fapi%2FDOMDataTreeChangeService.java;h=28590fc606736dd6863858e817f14cb2b3bdf3f0;hb=b4bf55727093657662d8c16a50fa85f87978a586;hp=e001dbbf1bcac5b68ef80f9286810e1a2d295597;hpb=bd8beb1bfee9f421ad8f2d07b1424b21038234a2;p=controller.git diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeChangeService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeChangeService.java index e001dbbf1b..28590fc606 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeChangeService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeChangeService.java @@ -7,26 +7,28 @@ */ package org.opendaylight.controller.md.sal.dom.api; -import javax.annotation.Nonnull; +import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.concepts.ListenerRegistration; /** - * A {@link DOMService} which allows users to register for changes to a + * A {@link DOMServiceExtension} which allows users to register for changes to a * subtree. */ -public interface DOMDataTreeChangeService extends DOMService { +public interface DOMDataTreeChangeService extends DOMDataBrokerExtension { /** * Registers a {@link DOMDataTreeChangeListener} to receive * notifications when data changes under a given path in the conceptual data * tree. + * *

* 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 data change notifications for a subtree or leaf * even if it does not exist. You will receive notification once that node is * 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 @@ -36,6 +38,7 @@ public interface DOMDataTreeChangeService extends DOMService { * This method returns a {@link ListenerRegistration} object. To * "unregister" your listener for changes call the {@link ListenerRegistration#close()} * method on the returned object. + * *

* You MUST explicitly unregister your listener when you no longer want to receive * notifications. This is especially true in OSGi environments, where failure to @@ -50,5 +53,6 @@ public interface DOMDataTreeChangeService extends DOMService { * your listener using {@link ListenerRegistration#close()} to stop * delivery of change events. */ - @Nonnull ListenerRegistration registerDataTreeChangeListener(@Nonnull DOMDataTreeIdentifier treeId, @Nonnull L listener); + @NonNull ListenerRegistration registerDataTreeChangeListener( + @NonNull DOMDataTreeIdentifier treeId, @NonNull L listener); }