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

Interface DataTreeCandidate.CandidateNode

All Known Subinterfaces:

DataTreeCandidate.CandidateNode.Appeared, DataTreeCandidate.CandidateNode.Compacted, DataTreeCandidate.CandidateNode.Created, DataTreeCandidate.CandidateNode.Deleted, DataTreeCandidate.CandidateNode.Disappeared, DataTreeCandidate.CandidateNode.Modified, DataTreeCandidate.CandidateNode.Replaced, DataTreeCandidate.CandidateNode.Unmodified, DataTreeCandidate.CandidateNode.WithDataAfter, DataTreeCandidate.CandidateNode.WithoutDataAfter

Enclosing interface:

DataTreeCandidate

public static sealed interface DataTreeCandidate.CandidateNode
permits DataTreeCandidate.CandidateNode.WithDataAfter, DataTreeCandidate.CandidateNode.WithoutDataAfter

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataTreeCandidate.CandidateNode.Appeared	An implied NormalizedNodeContainer is coming into existence via one of its children coming to existence.
static interface	DataTreeCandidate.CandidateNode.Compacted	An DataTreeCandidate.CandidateNode.Unmodified event indicating the backing metadata has been compacted to appear as if this node has been DataTreeCandidate.CandidateNode.Created with current #DataTreeCandidate.CandidateNode.WithDataAfter.dataAfter().
static interface	DataTreeCandidate.CandidateNode.Created	A NormalizedNode is being introduced without being previously present.
static interface	DataTreeCandidate.CandidateNode.Deleted	A NormalizedNode is being removed having been previously present.
static interface	DataTreeCandidate.CandidateNode.Disappeared	An implied NormalizedNodeContainer is becoming non-existent via all of its children becoming non-existent.
static interface	DataTreeCandidate.CandidateNode.Modified	A NormalizedNodeContainer becoming non-existent via all of its children becoming non-existent.
static interface	DataTreeCandidate.CandidateNode.Replaced	An existing NormalizedNode is being replaced.
static interface	DataTreeCandidate.CandidateNode.Unmodified	The NormalizedNode has not been modified in a way its Object.equals(Object) contract has been left unchanged.
static interface	DataTreeCandidate.CandidateNode.WithChildren	A non-terminal DataTreeCandidate.CandidateNode which has some child DataTreeCandidate.CandidateNodes, which have collectively contributed to this node's existence.
static interface	DataTreeCandidate.CandidateNode.WithDataAfter	Intermediate DataTreeCandidate.CandidateNode indicating the node will exist.
static interface	DataTreeCandidate.CandidateNode.WithDataBefore	Intermediate helper trait guaranteeing DataTreeCandidate.CandidateNode.WithDataBefore.dataBefore() being non-null.
static interface	DataTreeCandidate.CandidateNode.WithoutDataAfter	Intermediate DataTreeCandidate.CandidateNode indicating the node will cease to exist.

Method Summary

Modifier and Type	Method	Description
YangInstanceIdentifier.PathArgument	name()	Get the node underlying NormalizedNode.name().
DataTreeCandidateNode	toLegacy()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

name

YangInstanceIdentifier.PathArgument name()

Get the node underlying NormalizedNode.name().

Returns:

The node identifier.

toLegacy

@Deprecated(since="14.0.0",
            forRemoval=true)
DataTreeCandidateNode toLegacy()

Deprecated, for removal: This API element is subject to removal in a future version.

Return this DataTreeCandidate.CandidateNode as a legacy DataTreeCandidateNode.

Returns:

a DataTreeCandidateNode