Adopt odlparent-10.0.0/yangtools-8.0.0-SNAPSHOT

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

diff --git a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeListener.java b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeListener.java
index 2ae4f780dbb322495302c18321193dce865ea62b..21954323c5a75acf93b155d9d756be28c9971780 100644 (file)
--- a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeListener.java
+++ b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeChangeListener.java
@@ -7,10 +7,10 @@
  */
 package org.opendaylight.mdsal.dom.api;
 
-import java.util.Collection;
 import java.util.EventListener;
+import java.util.List;
 import org.eclipse.jdt.annotation.NonNull;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
+import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
 
 /**
  * Interface implemented by classes interested in receiving notifications about data tree changes. It provides
@@ -25,15 +25,25 @@ public interface DOMDataTreeChangeListener extends EventListener {
      * in the conceptual data tree for supplied path. This initial event will contain all pre-existing data as created.
      *
      * <p>
+     * Note: If there is no pre-existing data, the method {@link #onInitialData} will be invoked.
+     *
+     * <p>
      * A data change event may be triggered spuriously, e.g. such that data before and after compare as equal.
      * Implementations of this interface are expected to recover from such events. Event producers are expected to exert
      * reasonable effort to suppress such events. In other words, it is completely acceptable to observe
-     * a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode}, which reports
-     * a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType} other than UNMODIFIED, while
+     * a {@link org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode}, which reports
+     * a {@link org.opendaylight.yangtools.yang.data.tree.api.ModificationType} other than UNMODIFIED, while
      * the before- and after- data items compare as equal.
      *
-     * @param changes Collection of change events, may not be null or empty.
+     * @param changes List of change events, may not be null or empty.
      * @throws NullPointerException if {@code changes} is null
      */
-    void onDataTreeChanged(@NonNull Collection<DataTreeCandidate> changes);
+    void onDataTreeChanged(@NonNull List<DataTreeCandidate> changes);
+
+    /**
+     * Invoked only once during registration of the listener if there was no data in the conceptual data tree
+     * for the supplied path, which was used to register this listener, and after this
+     * {@link #onDataTreeChanged(List)} would always be invoked for data changes.
+     */
+    void onInitialData();
 }