Migrate mdsal-dom-api to JDT annotations
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMDataTreeChangeListener.java
index efe66b4b4a337ce75d3b1c6395a2666f6b311ed2..2ae4f780dbb322495302c18321193dce865ea62b 100644 (file)
@@ -9,35 +9,31 @@ package org.opendaylight.mdsal.dom.api;
 
 import java.util.Collection;
 import java.util.EventListener;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 
 /**
- * Interface implemented by classes interested in receiving notifications about
- * data tree changes. It provides a cursor-based view of the change.
+ * Interface implemented by classes interested in receiving notifications about data tree changes. It provides
+ * a cursor-based view of the change.
  */
 public interface DOMDataTreeChangeListener extends EventListener {
     /**
-     * Invoked when there was data change for the supplied path, which was used
-     * to register this listener.
+     * Invoked when there was data change for the supplied path, which was used to register this listener.
      *
      * <p>
-     * This method may be also invoked during registration of the listener if
-     * there is any pre-existing data in the conceptual data tree for supplied
-     * path. This initial event will contain all pre-existing data as created.
+     * This method may be also invoked during registration of the listener if there is any pre-existing data
+     * in the conceptual data tree for supplied path. This initial event will contain all pre-existing data as created.
      *
      * <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 the before- and after- data items compare as
-     * equal.
+     * 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
+     * the before- and after- data items compare as equal.
      *
      * @param changes Collection 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 Collection<DataTreeCandidate> changes);
 }