Migrate mdsal-dom-api to JDT annotations
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMDataTreeChangeListener.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.mdsal.dom.api;
9
10 import java.util.Collection;
11 import java.util.EventListener;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
14
15 /**
16  * Interface implemented by classes interested in receiving notifications about data tree changes. It provides
17  * a cursor-based view of the change.
18  */
19 public interface DOMDataTreeChangeListener extends EventListener {
20     /**
21      * Invoked when there was data change for the supplied path, which was used to register this listener.
22      *
23      * <p>
24      * This method may be also invoked during registration of the listener if there is any pre-existing data
25      * in the conceptual data tree for supplied path. This initial event will contain all pre-existing data as created.
26      *
27      * <p>
28      * A data change event may be triggered spuriously, e.g. such that data before and after compare as equal.
29      * Implementations of this interface are expected to recover from such events. Event producers are expected to exert
30      * reasonable effort to suppress such events. In other words, it is completely acceptable to observe
31      * a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode}, which reports
32      * a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType} other than UNMODIFIED, while
33      * the before- and after- data items compare as equal.
34      *
35      * @param changes Collection of change events, may not be null or empty.
36      * @throws NullPointerException if {@code changes} is null
37      */
38     void onDataTreeChanged(@NonNull Collection<DataTreeCandidate> changes);
39 }