org.opendaylight.yangtools.yang.data.api.schema.tree

Class DataTreeCandidateNodes

java.lang.Object

org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNodes

@Beta
public final class DataTreeCandidateNodes
extends Object

Method Summary

Modifier and Type	Method and Description
static void	applyRootedNodeToCursor(DataTreeModificationCursor cursor, YangInstanceIdentifier rootPath, DataTreeCandidateNode node) Applies the node that is rooted(doesn't have an identifier) in tree A to tree B's cursor at location specified by rootPath.
static void	applyRootToCursor(DataTreeModificationCursor cursor, DataTreeCandidateNode node)
static void	applyToCursor(DataTreeModificationCursor cursor, DataTreeCandidateNode node) Applies the node to the cursor, note that if the top node of (@code node} is RootNode you need to use applyRootedNodeToCursor method that works with rooted node candidates.
static @NonNull Collection<DataTreeCandidateNode>	containerDelta(@Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> oldData, @Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> newData) Return a collection of DataTreeCandidateNodes summarizing the changes between the contents of two NormalizedNodeContainers.
static @Nullable DataTreeCandidateNode	containerDelta(@Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> oldData, @Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> newData, @NonNull YangInstanceIdentifier.PathArgument child) Return a collection of DataTreeCandidateNodes summarizing the change in a child, identified by a YangInstanceIdentifier.PathArgument, between two NormalizedNodeContainers.
static @NonNull DataTreeCandidateNode	empty(YangInstanceIdentifier.PathArgument identifier) Return an empty DataTreeCandidateNode identified by specified YangInstanceIdentifier.PathArgument.
static @NonNull DataTreeCandidateNode	fromNormalizedNode(NormalizedNode<?,?> node) Deprecated.
static @NonNull DataTreeCandidateNode	unmodified(NormalizedNode<?,?> node) Return an unmodified DataTreeCandidateNode identified by specified NormalizedNode.
static @NonNull DataTreeCandidateNode	written(NormalizedNode<?,?> node) Return a DataTreeCandidateNode pretending specified node was written without the data exsting beforehand.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static @NonNull DataTreeCandidateNode empty(YangInstanceIdentifier.PathArgument identifier)

Return an empty DataTreeCandidateNode identified by specified YangInstanceIdentifier.PathArgument.

Parameters:

identifier - Node identifier

Returns:

An empty DataTreeCandidateNode

fromNormalizedNode

@Deprecated
public static @NonNull DataTreeCandidateNode fromNormalizedNode(NormalizedNode<?,?> node)

Deprecated.

unmodified

public static @NonNull DataTreeCandidateNode unmodified(NormalizedNode<?,?> node)

Return an unmodified DataTreeCandidateNode identified by specified NormalizedNode.

Parameters:

node - Unchanged normalized node

Returns:

An empty DataTreeCandidateNode

written

public static @NonNull DataTreeCandidateNode written(NormalizedNode<?,?> node)

Return a DataTreeCandidateNode pretending specified node was written without the data exsting beforehand.

Parameters:

node - Unchanged normalized node

Returns:

An empty DataTreeCandidateNode

Throws:

NullPointerException - if node is null

containerDelta

public static @NonNull Collection<DataTreeCandidateNode> containerDelta(@Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> oldData,
                                                                        @Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> newData)

Return a collection of DataTreeCandidateNodes summarizing the changes between the contents of two NormalizedNodeContainers.

Parameters:

oldData - Old data container, may be null

newData - New data container, may be null

Returns:

Collection of changes

containerDelta

public static @Nullable DataTreeCandidateNode containerDelta(@Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> oldData,
                                                             @Nullable NormalizedNodeContainer<?,YangInstanceIdentifier.PathArgument,NormalizedNode<?,?>> newData,
                                                             @NonNull YangInstanceIdentifier.PathArgument child)

Return a collection of DataTreeCandidateNodes summarizing the change in a child, identified by a YangInstanceIdentifier.PathArgument, between two NormalizedNodeContainers.

Parameters:

oldData - Old data container, may be null

newData - New data container, may be null

Returns:

A DataTreeCandidateNode describing the change, or null if the node is not present

applyToCursor

public static void applyToCursor(DataTreeModificationCursor cursor,
                                 DataTreeCandidateNode node)

Applies the node to the cursor, note that if the top node of (@code node} is RootNode you need to use applyRootedNodeToCursor method that works with rooted node candidates.

Parameters:

cursor - cursor from the modification we want to apply the node to

node - candidate tree to apply

applyRootedNodeToCursor

public static void applyRootedNodeToCursor(DataTreeModificationCursor cursor,
                                           YangInstanceIdentifier rootPath,
                                           DataTreeCandidateNode node)

Applies the node that is rooted(doesn't have an identifier) in tree A to tree B's cursor at location specified by rootPath.

Parameters:

cursor - cursor from the modification we want to apply the node to

rootPath - path in the cursor's tree we want to apply to candidate to

node - candidate tree to apply

applyRootToCursor

public static void applyRootToCursor(DataTreeModificationCursor cursor,
                                     DataTreeCandidateNode node)