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

Class DataTreeCandidates

java.lang.Object

org.opendaylight.yangtools.yang.data.tree.spi.DataTreeCandidates

@Beta
public final class DataTreeCandidates
extends Object

Utility class holding methods useful when dealing with DataTreeCandidate instances.

Method Summary

Modifier and Type	Method	Description
static @NonNull DataTreeCandidate	aggregate(@NonNull List<? extends DataTreeCandidate> candidates)	Compress a list of DataTreeCandidates into a single DataTreeCandidate.
static void	applyToCursor(DataTreeModificationCursor cursor, DataTreeCandidate candidate)
static void	applyToModification(DataTreeModification modification, DataTreeCandidate candidate)
static @NonNull DataTreeCandidate	fromNormalizedNode(YangInstanceIdentifier rootPath, NormalizedNode node)
static @NonNull DataTreeCandidate	newDataTreeCandidate(YangInstanceIdentifier rootPath, DataTreeCandidateNode rootNode)

Methods inherited from class java.lang.Object

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

Method Details

newDataTreeCandidate

public static @NonNull DataTreeCandidate newDataTreeCandidate(YangInstanceIdentifier rootPath,
 DataTreeCandidateNode rootNode)

fromNormalizedNode

public static @NonNull DataTreeCandidate fromNormalizedNode(YangInstanceIdentifier rootPath,
 NormalizedNode node)

applyToCursor

public static void applyToCursor(DataTreeModificationCursor cursor,
 DataTreeCandidate candidate)

applyToModification

public static void applyToModification(DataTreeModification modification,
 DataTreeCandidate candidate)

aggregate

public static @NonNull DataTreeCandidate aggregate(@NonNull List<? extends DataTreeCandidate> candidates)

Compress a list of DataTreeCandidates into a single DataTreeCandidate. The resulting candidate is a summarization of changes recorded in the input candidates.

Parameters:

candidates - Input list, must be non-empty

Returns:

Summarized DataTreeCandidate

Throws:

IllegalArgumentException - if candidates is empty, or contains candidates with mismatched root path

NullPointerException - if candidates is null or contains a null entry