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 javax.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
  17  * data tree changes. It provides 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
  22      * to register this listener.
  23      *
  24      * <p>
  25      * This method may be also invoked during registration of the listener if
  26      * there is any pre-existing data in the conceptual data tree for supplied
  27      * path. This initial event will contain all pre-existing data as created.
  28      *
  29      * <p>
  30      * A data change event may be triggered spuriously, e.g. such that data before
  31      * and after compare as equal. Implementations of this interface are expected
  32      * to recover from such events. Event producers are expected to exert reasonable
  33      * effort to suppress such events.
  34      *
  35      * In other words, it is completely acceptable to observe
  36      * a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode},
  37      * which reports a {@link org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType}
  38      * other than UNMODIFIED, while the before- and after- data items compare as
  39      * equal.
  40      *
  41      * @param changes Collection of change events, may not be null or empty.
  42      */
  43     void onDataTreeChanged(@Nonnull Collection<DataTreeCandidate> changes);
  44 }