binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeListener.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 java.util.Map;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.binding.DataObject;
  15
  16 /**
  17  * Interface implemented by data consumers, e.g. processes wanting to act on data after it has been
  18  * introduced to the conceptual data tree.
  19  */
  20 public interface DataTreeListener extends EventListener {
  21     /**
  22      * Invoked whenever one or more registered subtrees change. The logical changes are reported, as
  23      * well as the roll up of new state for all subscribed subtrees.
  24      *
  25      * @param changes The set of changes being reported. Each subscribed subtree may be present at
  26      *        most once.
  27      * @param subtrees Per-subtree state as visible after the reported changes have been applied.
  28      *        This includes all the subtrees this listener is subscribed to, even those which have
  29      *        not changed.
  30      */
  31     void onDataTreeChanged(@NonNull Collection<DataTreeModification<?>> changes,
  32             @NonNull Map<DataTreeIdentifier<?>, DataObject> subtrees);
  33
  34     /**
  35      * Invoked when a subtree listening failure occurs. This can be triggered, for example, when a
  36      * connection to external subtree source is broken. The listener will not receive any other
  37      * callbacks, but its registration still needs to be closed to prevent resource leak.
  38      *
  39      * @param causes Collection of failure causes, may not be null or empty.
  40      */
  41     void onDataTreeFailed(@NonNull Collection<DataTreeListeningException> causes);
  42 }