Module org.opendaylight.yangtools.yang.data.tree.spi
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 org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
    aggregate(@NonNull List<? extends org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate> candidates)
    Compress a list of DataTreeCandidates into a single DataTreeCandidate.
    static void
    applyToCursor(org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor cursor, org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate candidate)
     
    static void
    applyToModification(org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification modification, org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate candidate)
     
    static @NonNull org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
    fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode node)
     
    static @NonNull org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
    newDataTreeCandidate(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath, org.opendaylight.yangtools.yang.data.tree.api.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 org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate newDataTreeCandidate(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath, org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode rootNode)

    • fromNormalizedNode

      public static @NonNull org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode node)

    • applyToCursor

      public static void applyToCursor(org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor cursor, org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate candidate)

    • applyToModification

      public static void applyToModification(org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification modification, org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate candidate)

    • aggregate

      public static @NonNull org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate aggregate(@NonNull List<? extends org.opendaylight.yangtools.yang.data.tree.api.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