dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/store/DOMStoreTreeChangePublisher.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.spi.store;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
  12 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  14 import org.opendaylight.yangtools.concepts.Registration;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16
  17 /**
  18  * Interface implemented by DOMStore implementations which allow registration of {@link DOMDataTreeChangeListener}
  19  * instances.
  20  */
  21 public interface DOMStoreTreeChangePublisher {
  22     /**
  23      * Registers a {@link DOMDataTreeChangeListener} to receive notifications when data changes under a given path in
  24      * the conceptual data tree. See
  25      * {@link DataTreeChangeExtension#registerTreeChangeListener(DOMDataTreeIdentifier, DOMDataTreeChangeListener)} for
  26      * full semantics.
  27      *
  28      * @param treeId Data tree identifier of the subtree which should be watched for changes.
  29      * @param listener Listener instance which is being registered
  30      * @return A {@link Registration} registration object, which may be used to unregister your listener using
  31      *         {@link Registration#close()} to stop delivery of change events.
  32      */
  33     @NonNull Registration registerTreeChangeListener(@NonNull YangInstanceIdentifier treeId,
  34         @NonNull DOMDataTreeChangeListener listener);
  35
  36     /**
  37      * Registers a {@link DOMDataTreeChangeListener} to receive notifications when data changes under a given path in
  38      * the conceptual data tree. See {@link DataTreeChangeExtension#registerLegacyTreeChangeListener(
  39      * DOMDataTreeIdentifier, DOMDataTreeChangeListener)} for full semantics.
  40      *
  41      * @param treeId Data tree identifier of the subtree which should be watched for changes.
  42      * @param listener Listener instance which is being registered
  43      * @return A {@link Registration} registration object, which may be used to unregister your listener using
  44      *         {@link Registration#close()} to stop delivery of change events.
  45      * @deprecated Legacy support class
  46      */
  47     @Deprecated(since = "13.0.0", forRemoval = true)
  48     @NonNull Registration registerLegacyTreeChangeListener(@NonNull YangInstanceIdentifier treeId,
  49         @NonNull DOMDataTreeChangeListener listener);
  50 }