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

Interface DataTreeCandidateNode

public interface DataTreeCandidateNode

A single node within a DataTreeCandidate. The nodes are organized in tree hierarchy, reflecting the modification from which this candidate was created. The node itself exposes the before- and after-image of the tree restricted to the modified nodes.

Method Summary

Modifier and Type	Method and Description
Collection<DataTreeCandidateNode>	getChildNodes() Get an unmodifiable collection of modified child nodes.
Optional<NormalizedNode<?,?>>	getDataAfter() Return the after-image of data corresponding to the node.
Optional<NormalizedNode<?,?>>	getDataBefore() Return the before-image of data corresponding to the node.
YangInstanceIdentifier.PathArgument	getIdentifier() Get the node identifier.
ModificationType	getModificationType() Return the type of modification this node is undergoing.
DataTreeCandidateNode	getModifiedChild(YangInstanceIdentifier.PathArgument childIdentifier) Returns modified child or null if child was not modified / does not exists.

Method Detail

getIdentifier

@Nonnull
YangInstanceIdentifier.PathArgument getIdentifier()

Get the node identifier.

Returns:

The node identifier.

getChildNodes

@Nonnull
Collection<DataTreeCandidateNode> getChildNodes()

Get an unmodifiable collection of modified child nodes.

Returns:

Unmodifiable collection of modified child nodes.

getModifiedChild

@Nullable
DataTreeCandidateNode getModifiedChild(YangInstanceIdentifier.PathArgument childIdentifier)

Returns modified child or null if child was not modified / does not exists.

Parameters:

childIdentifier - Identifier of child node

Returns:

Modified child or null if child was not modified.

getModificationType

@Nonnull
ModificationType getModificationType()

Return the type of modification this node is undergoing.

Returns:

Node modification type.

getDataAfter

@Nonnull
Optional<NormalizedNode<?,?>> getDataAfter()

Return the after-image of data corresponding to the node.

Returns:

Node data as they will be present in the tree after the modification is applied.

getDataBefore

@Nonnull
Optional<NormalizedNode<?,?>> getDataBefore()

Return the before-image of data corresponding to the node.

Returns:

Node data as they were present in the tree before the modification was applied.