org.opendaylight.mdsal.dom.spi

Class AbstractRegistrationTree<T>

java.lang.Object

org.opendaylight.mdsal.dom.spi.AbstractRegistrationTree<T>

Type Parameters:

T - Type of registered object

Direct Known Subclasses:

AbstractDOMStoreTreeChangePublisher

public abstract class AbstractRegistrationTree<T>
extends Object

An abstract tree of registrations. Allows a read-only snapshot to be taken.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegistrationTree()

Method Summary

Modifier and Type	Method and Description
protected void	addRegistration(@NonNull RegistrationTreeNode<T> node, T registration) Add a registration to a particular node.
protected @NonNull RegistrationTreeNode<T>	findNodeFor(@NonNull Iterable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> path) Find an existing, or allocate a fresh, node for a particular path.
protected void	releaseLock() Release the read-write lock.
protected void	removeRegistration(@NonNull RegistrationTreeNode<T> node, T registration) Remove a registration from a particular node.
protected void	takeLock() Acquire the read-write lock.
@NonNull RegistrationTreeSnapshot<T>	takeSnapshot() Obtain a tree snapshot.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRegistrationTree

protected AbstractRegistrationTree()

Method Detail

takeLock

protected final void takeLock()

Acquire the read-write lock. This should be done before invoking findNodeFor(Iterable). This method must not be called when the lock is already held by this thread.

releaseLock

protected final void releaseLock()

Release the read-write lock. This should be done after invocation of findNodeFor(Iterable) and modification of the returned node. Note that callers should do so in a finally block.

findNodeFor

protected final @NonNull RegistrationTreeNode<T> findNodeFor(@NonNull Iterable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> path)

Find an existing, or allocate a fresh, node for a particular path. Must be called with the lock held.

Parameters:

path - Path to find a node for

Returns:

A registration node for the specified path

addRegistration

protected final void addRegistration(@NonNull RegistrationTreeNode<T> node,
                                     T registration)

Add a registration to a particular node. The node must have been returned via findNodeFor(Iterable) and the lock must still be held.

Parameters:

node - Tree node

registration - Registration instance

removeRegistration

protected final void removeRegistration(@NonNull RegistrationTreeNode<T> node,
                                        T registration)

Remove a registration from a particular node. This method must not be called while the lock is held.

Parameters:

node - Tree node

registration - Registration instance

takeSnapshot

public final @NonNull RegistrationTreeSnapshot<T> takeSnapshot()

Obtain a tree snapshot. This snapshot ensures a consistent view of registrations. The snapshot should be closed as soon as it is not required, because each unclosed instance blocks modification of this tree.

Returns:

A snapshot instance.