Interface DOMDataTreeChangeService
-
- All Superinterfaces:
DOMDataBrokerExtension
,DOMServiceExtension<DOMDataBroker,DOMDataBrokerExtension>
- All Known Implementing Classes:
PingPongDataBroker
@Deprecated(forRemoval=true) public interface DOMDataTreeChangeService extends DOMDataBrokerExtension
Deprecated, for removal: This API element is subject to removal in a future version.UseDOMDataTreeChangeService
instead.ADOMServiceExtension
which allows users to register for changes to a subtree.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description <L extends DOMDataTreeChangeListener>
@NonNull ListenerRegistration<L>registerDataTreeChangeListener(@NonNull DOMDataTreeIdentifier treeId, @NonNull L listener)
Deprecated, for removal: This API element is subject to removal in a future version.Registers aDOMDataTreeChangeListener
to receive notifications when data changes under a given path in the conceptual data tree.
-
-
-
Method Detail
-
registerDataTreeChangeListener
<L extends DOMDataTreeChangeListener> @NonNull ListenerRegistration<L> registerDataTreeChangeListener(@NonNull DOMDataTreeIdentifier treeId, @NonNull L listener)
Deprecated, for removal: This API element is subject to removal in a future version.Registers aDOMDataTreeChangeListener
to receive notifications when data changes under a given path in the conceptual data tree.You are able to register for notifications for any node or subtree which can be represented using
DOMDataTreeIdentifier
.You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.
If there is any pre-existing data in the data tree for the path for which you are registering, you will receive an initial data change event, which will contain all pre-existing data, marked as created.
This method returns a
ListenerRegistration
object. To "unregister" your listener for changes call theListenerRegistration.close()
method on the returned object.You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.
- Parameters:
treeId
- Data tree identifier of the subtree which should be watched for changes.listener
- Listener instance which is being registered- Returns:
- Listener registration object, which may be used to unregister
your listener using
ListenerRegistration.close()
to stop delivery of change events.
-
-