org.opendaylight.mdsal.binding.api

Interface DataTreeListener

All Superinterfaces:

EventListener

public interface DataTreeListener
extends EventListener

Interface implemented by data consumers, e.g. processes wanting to act on data after it has been introduced to the conceptual data tree.

Method Summary

Modifier and Type	Method and Description
void	onDataTreeChanged(@NonNull Collection<DataTreeModification<?>> changes, @NonNull Map<DataTreeIdentifier<?>,DataObject> subtrees) Invoked whenever one or more registered subtrees change.
void	onDataTreeFailed(@NonNull Collection<DataTreeListeningException> causes) Invoked when a subtree listening failure occurs.

Method Detail

onDataTreeChanged

void onDataTreeChanged(@NonNull Collection<DataTreeModification<?>> changes,
                       @NonNull Map<DataTreeIdentifier<?>,DataObject> subtrees)

Invoked whenever one or more registered subtrees change. The logical changes are reported, as well as the roll up of new state for all subscribed subtrees.

Parameters:

changes - The set of changes being reported. Each subscribed subtree may be present at most once.

subtrees - Per-subtree state as visible after the reported changes have been applied. This includes all the subtrees this listener is subscribed to, even those which have not changed.

onDataTreeFailed

void onDataTreeFailed(@NonNull Collection<DataTreeListeningException> causes)

Invoked when a subtree listening failure occurs. This can be triggered, for example, when a connection to external subtree source is broken. The listener will not receive any other callbacks, but its registration still needs to be closed to prevent resource leak.

Parameters:

causes - Collection of failure causes, may not be null or empty.