, D, L extends AsyncDataChange * * * - * @see http://www.idevelopment.info/data/LDAP/LDAP_Resources/ - * SEARCH_Setting_the_SCOPE_Parameter.shtml + * @see LDAP */ - public enum DataChangeScope { + enum DataChangeScope { /** - * Represents only a direct change of the node, such as replacement of a - * node, addition or deletion. + * Represents only a direct change of the node, such as replacement of a node, addition or + * deletion. Note that, as described in {@link #ONE}, this may have counterintuitive + * interactions when viewed from a binding aware application, in particular when it + * pertains to lists. * */ BASE, /** - * Represent a change (addition,replacement,deletion) of the node or one - * of its direct children. + * Represent a change (addition,replacement,deletion) of the node or one of its direct + * children. + *
+ * Note that this is done in the binding independent data tree and so the behavior + * might be counterintuitive when used with binding aware interfaces particularly + * when it comes to lists. The list itself is a node in the binding independent tree, + * which means that if you want to listen on new elements you must listen on the list itself + * with the scope of {@link #ONE}. + *
+ * As an example, in the below YANG snippet, listening on node with scope + * {@link #ONE} would tell you if the node-connector list was created or deleted, + * but not when elements were added or removed from the list assuming the list itself + * already existed. + * + *
+ * container nodes {
+ * list node {
+ * key "id";
+ * leaf id {
+ * type string;
+ * }
+ * list node-connector {
+ * leaf id {
+ * type string;
+ * }
+ * }
+ * }
+ * }
+ *
*
* This scope is superset of {@link #BASE}.
*
@@ -130,19 +158,19 @@ public interface AsyncDataBroker, D, L extends AsyncDataChange
* {@inheritDoc}
*/
@Override
- public AsyncReadOnlyTransaction