binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeChangeListener.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.binding.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.binding.DataObject;
  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, which has potentially
  18  * lower overhead and allow more flexible consumption of change event.
  19  */
  20 public interface DataTreeChangeListener<T extends DataObject> extends EventListener {
  21     /**
  22      * Invoked when there was data change for the supplied path, which was used
  23      * to register this listener.
  24      *
  25      * <p>
  26      * This method may be also invoked during registration of the listener if
  27      * there is any pre-existing data in the conceptual data tree for supplied
  28      * path. This initial event will contain all pre-existing data as created.
  29      *
  30      * <p>
  31      * A data change event may be triggered spuriously, e.g. such that data before
  32      * and after compare as equal. Implementations of this interface are expected
  33      * to recover from such events. Event producers are expected to exert reasonable
  34      * effort to suppress such events.
  35      *
  36      *<p>
  37      * In other words, it is completely acceptable to observe
  38      * a {@link DataObjectModification}, while the state observed before and
  39      * after- data items compare as equal.
  40      *
  41      * @param changes Collection of change events, may not be null or empty.
  42      */
  43     void onDataTreeChanged(@NonNull Collection<DataTreeModification<T>> changes);
  44
  45     /**
  46      * Invoked only once during registration of the listener if there was no data in the conceptual data tree
  47      * for the supplied path, which was used to register this listener, and after this {@link #onDataTreeChanged}
  48      * would always be invoked for data changes.
  49      *
  50      * <p>
  51      * Users not care about this event could leave it as default with no-op.
  52      */
  53     default void onInitialData() {
  54         //no-op
  55     }
  56 }