restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/util/DataChangeScope.java

   1 /*
   2  * Copyright (c) 2018 Inocybe Technologies 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.restconf.common.util;
   9
  10 /**
  11  * Represents the scope of a data change (addition, replacement, deletion) registration.
  12  *
  13  * <p>
  14  * Note: this enum was originally defined in the AsynDataBroker interface but was removed when DataChangeListener
  15  * et al were removed.
  16  */
  17 public enum DataChangeScope {
  18     /**
  19      * Represents only a direct change of the node, such as replacement of a node, addition or deletion..
  20      *
  21      */
  22     BASE,
  23
  24     /**
  25      * Represent a change (addition, replacement, deletion) of the node or one of its direct
  26      * children.
  27      *
  28      * <p>
  29      * This scope is superset of {@link #BASE}.
  30      *
  31      */
  32     ONE,
  33
  34     /**
  35      * Represents a change of the node or any of or any of its child nodes, direct and nested.
  36      *
  37      * <p>
  38      * This scope is superset of {@link #ONE} and {@link #BASE}.
  39      *
  40      */
  41     SUBTREE
  42 }