X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-spi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fcore%2Fspi%2Fdata%2FDOMStoreTreeChangePublisher.java;h=a0808861a2bab6a6290a41e2caa6e05256b85ff2;hp=5d75f88fb9ecde385e21dd3ed625d17dbdbcc405;hb=3ec97cd0a86ad1b79f6854dc6924eb7b06e359a3;hpb=08351c185b20967cf3de414b16e97670149f5d51 diff --git a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreTreeChangePublisher.java b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreTreeChangePublisher.java index 5d75f88fb9..a0808861a2 100644 --- a/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreTreeChangePublisher.java +++ b/opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreTreeChangePublisher.java @@ -7,7 +7,7 @@ */ package org.opendaylight.controller.sal.core.spi.data; -import javax.annotation.Nonnull; +import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener; import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; @@ -15,20 +15,25 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; /** * Interface implemented by DOMStore implementations which allow registration * of {@link DOMDataTreeChangeListener} instances. + * + * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher} instead. */ +@Deprecated public interface DOMStoreTreeChangePublisher { /** * 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 YangInstanceIdentifier}. - *

* + *

* 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 data tree on path for which you are * registering, you will receive initial data change event, which will @@ -38,6 +43,7 @@ public interface DOMStoreTreeChangePublisher { * This method returns a {@link ListenerRegistration} object. To * "unregister" your listener for changes call the {@link ListenerRegistration#close()} * method on this 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 @@ -52,5 +58,6 @@ public interface DOMStoreTreeChangePublisher { * your listener using {@link ListenerRegistration#close()} to stop * delivery of change events. */ - @Nonnull ListenerRegistration registerTreeChangeListener(@Nonnull YangInstanceIdentifier treeId, @Nonnull L listener); + @NonNull ListenerRegistration registerTreeChangeListener( + @NonNull YangInstanceIdentifier treeId, @NonNull L listener); }