org.opendaylight.mdsal.dom.spi.store

Class AbstractDOMStoreTreeChangePublisher

java.lang.Object

org.opendaylight.mdsal.dom.spi.AbstractRegistrationTree<AbstractDOMDataTreeChangeListenerRegistration<?>>

org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTreeChangePublisher

All Implemented Interfaces:

DOMStoreTreeChangePublisher

public abstract class AbstractDOMStoreTreeChangePublisher
extends AbstractRegistrationTree<AbstractDOMDataTreeChangeListenerRegistration<?>>
implements DOMStoreTreeChangePublisher

Abstract base class for DOMStoreTreeChangePublisher implementations.

Constructor Summary

Constructors

Constructor and Description
AbstractDOMStoreTreeChangePublisher()

Method Summary

Modifier and Type	Method and Description
protected abstract void	notifyListener(@NonNull AbstractDOMDataTreeChangeListenerRegistration<?> registration, @NonNull Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate> changes) Callback for subclass to notify a specified registration of a list of candidates.
protected boolean	processCandidateTree(@NonNull org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate candidate) Process a candidate tree with respect to registered listeners.
<L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L>	registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId, L listener) Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.
protected abstract void	registrationRemoved(@NonNull AbstractDOMDataTreeChangeListenerRegistration<?> registration) Callback notifying the subclass that the specified registration is being closed and it's user no longer wishes to receive notifications.

Methods inherited from class org.opendaylight.mdsal.dom.spi.AbstractRegistrationTree

addRegistration, findNodeFor, releaseLock, removeRegistration, takeLock, takeSnapshot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDOMStoreTreeChangePublisher

public AbstractDOMStoreTreeChangePublisher()

Method Detail

notifyListener

protected abstract void notifyListener(@NonNull AbstractDOMDataTreeChangeListenerRegistration<?> registration,
                                       @NonNull Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate> changes)

Callback for subclass to notify a specified registration of a list of candidates. This method is guaranteed to be only called from within processCandidateTree(DataTreeCandidate).

Parameters:

registration - the registration to notify

changes - the list of DataTreeCandidate changes

registrationRemoved

protected abstract void registrationRemoved(@NonNull AbstractDOMDataTreeChangeListenerRegistration<?> registration)

Callback notifying the subclass that the specified registration is being closed and it's user no longer wishes to receive notifications. This notification is invoked while the ListenerRegistration.close() method is executing. Subclasses can use this callback to properly remove any delayed notifications pending towards the registration.

Parameters:

registration - Registration which is being closed

processCandidateTree

protected final boolean processCandidateTree(@NonNull org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate candidate)

Process a candidate tree with respect to registered listeners.

Parameters:

candidate - candidate three which needs to be processed

Returns:

true if at least one listener was notified or false.

registerTreeChangeListener

public <L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L> registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId,
                                                                                                                         L listener)

Description copied from interface: DOMStoreTreeChangePublisher

Registers a DOMDataTreeChangeListener 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 YangInstanceIdentifier.

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 data tree on path for which you are registering, you will receive initial data change event, which will contain all pre-existing data, marked as created. If the data at the supplied path does not exist, you will also receive initial data change event, which will contain empty data tree modification, marked as unmodified.

This method returns a ListenerRegistration object. To "unregister" your listener for changes call the ListenerRegistration.close() method on this 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.

Specified by:

registerTreeChangeListener in interface DOMStoreTreeChangePublisher

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.