binding/mdsal-binding-dom-codec-api/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/CommonDataObjectCodecTreeNode.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.List;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.eclipse.jdt.annotation.Nullable;
  14 import org.opendaylight.yangtools.yang.binding.DataObject;
  15 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.common.Empty;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  18
  19 /**
  20  * Common interface shared between {@link BindingDataObjectCodecTreeNode} and {@link BindingAugmentationCodecTreeNode}.
  21  * This interface should never be implemented on its own.
  22  *
  23  * @param <T> DataObject type
  24  */
  25 @Beta
  26 public interface CommonDataObjectCodecTreeNode<T extends DataObject>
  27         extends BindingDataObjectCodecTreeParent<Empty>, BindingObjectCodecTreeNode<T> {
  28     /**
  29      * Returns binding class of interface which represents API of current schema node. The result is same as invoking
  30      * {@link DataObject#implementedInterface()} on instance of data.
  31      *
  32      * @return interface which defines API of binding representation of data.
  33      */
  34     @Override
  35     @NonNull Class<T> getBindingClass();
  36
  37     /**
  38      * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case,
  39      * one must issue getChild(ChoiceClass).getChild(CaseClass).
  40      *
  41      * <p>
  42      * This method differs from {@link #getStreamChild(Class)}, that is less strict for interfaces representing
  43      * augmentation and cases, that may return {@link BindingCodecTreeNode} even if augmentation interface containing
  44      * same data was supplied and does not represent augmentation of this node.
  45      *
  46      * @param childClass Child class by Binding Stream navigation
  47      * @return Context of child or {@code null} is supplied class is not applicable in context.
  48      * @throws NullPointerException if {@code childClass} is {@code null}
  49      */
  50     <E extends DataObject> @Nullable CommonDataObjectCodecTreeNode<E> streamChild(@NonNull Class<E> childClass);
  51
  52     /**
  53      * Returns nested node context using supplied YANG Instance Identifier.
  54      *
  55      * @param child
  56      *            Yang Instance Identifier Argument
  57      * @return Context of child
  58      * @throws IllegalArgumentException
  59      *             If supplied argument does not represent valid child.
  60      */
  61     @NonNull BindingCodecTreeNode yangPathArgumentChild(YangInstanceIdentifier.@NonNull PathArgument child);
  62
  63     /**
  64      * Returns nested node context using supplied Binding Instance Identifier and adds YANG instance identifiers to
  65      * the supplied list.
  66      *
  67      * @param arg
  68      *            Binding Instance Identifier Argument
  69      * @param builder
  70      *            Mutable instance of list, which is appended by YangInstanceIdentifiers
  71      *            as tree is walked. Use null if such side-product is not needed.
  72      * @return Context of child
  73      * @throws IllegalArgumentException
  74      *             If supplied argument does not represent valid child.
  75      */
  76     @NonNull CommonDataObjectCodecTreeNode<?> bindingPathArgumentChild(InstanceIdentifier.@NonNull PathArgument arg,
  77             @Nullable List<YangInstanceIdentifier.PathArgument> builder);
  78
  79     /**
  80      * Serializes path argument for current node.
  81      *
  82      * @param arg Binding Path Argument, may be null if Binding Instance Identifier does not have
  83      *        representation for current node (e.g. choice or case).
  84      * @return Yang Path Argument, may be null if Yang Instance Identifier does not have
  85      *         representation for current node (e.g. case).
  86      * @throws IllegalArgumentException If supplied {@code arg} is not valid.
  87      */
  88     @Beta
  89     YangInstanceIdentifier.@Nullable PathArgument serializePathArgument(InstanceIdentifier.@Nullable PathArgument arg);
  90
  91     /**
  92      * Deserializes path argument for current node.
  93      *
  94      * @param arg Yang Path Argument, may be null if Yang Instance Identifier does not have
  95      *         representation for current node (e.g. case).
  96      * @return Binding Path Argument, may be null if Binding Instance Identifier does not have
  97      *        representation for current node (e.g. choice or case).
  98      * @throws IllegalArgumentException If supplied {@code arg} is not valid.
  99      */
 100     @Beta
 101     InstanceIdentifier.@Nullable PathArgument deserializePathArgument(
 102             YangInstanceIdentifier.@Nullable PathArgument arg);
 103
 104     /**
 105      * Return a summary of addressability of potential children. Binding specification does not allow all DOM tree
 106      * elements to be directly addressed, which means some recursive tree operations, like data tree changes do not
 107      * have a one-to-one mapping from DOM to binding in all cases. This method provides an optimization hint to guide
 108      * translation of data structures, allowing for fast paths when all children are known to either be addressable
 109      * or non-addressable.
 110      *
 111      * @return Summary children addressability.
 112      */
 113     @NonNull ChildAddressabilitySummary getChildAddressabilitySummary();
 114
 115     /**
 116      * Enumeration of possible addressability attribute of all children.
 117      */
 118     enum ChildAddressabilitySummary {
 119         /**
 120          * All children are addressable.
 121          */
 122         ADDRESSABLE,
 123         /**
 124          * All children are non-addressable, including the case when this node does not have any children.
 125          */
 126         UNADDRESSABLE,
 127         /**
 128          * Mixed children, some are addressable and some are not.
 129          */
 130         MIXED
 131     }
 132 }