Rework AugmentRuntimeType and Choice/Case linkage

[mdsal.git] / binding / mdsal-binding-runtime-api / src / main / java / org / opendaylight / mdsal / binding / runtime / api / BindingRuntimeTypes.java

diff --git a/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeTypes.java b/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeTypes.java
index 73235013f51ca3d187b1708bdf65ae66dc2cd944..20a166688a7ae19022e00a44853ee26818cc30cc 100644 (file)
--- a/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeTypes.java
+++ b/binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeTypes.java
@@ -9,7 +9,10 @@ package org.opendaylight.mdsal.binding.runtime.api;
 
 import com.google.common.annotations.Beta;
 import java.util.Optional;
+import java.util.Set;
+import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.binding.model.api.GeneratedType;
 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
 import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.yang.common.QName;
@@ -38,4 +41,52 @@ public interface BindingRuntimeTypes extends EffectiveModelContextProvider, Runt
         }
         return tmp;
     }
+
+    /**
+     * Lookup to all {@link CaseRuntimeType}s related to a {@link ChoiceRuntimeType}. This is important when dealing
+     * with sharing incurred by Binding Spec's reuse of constructs defined in a {@code grouping}.
+     *
+     * <p>
+     * As an example, consider {@link ChoiceRuntimeType} and {@link CaseRuntimeType} relationship to
+     * {@link GeneratedType}s in the following model:
+     * <pre>
+     *   <code>
+     *     grouping grp {
+     *       container foo {
+     *         choice bar;
+     *       }
+     *     }
+     *
+     *     container foo {
+     *       uses grp;
+     *     }
+     *
+     *     container bar {
+     *       uses grp;
+     *     }
+     *
+     *     augment /foo/foo/bar {
+     *       case baz
+     *     }
+     *
+     *     augment /bar/foo/bar {
+     *       case xyzzy;
+     *     }
+     *   </code>
+     * </pre>
+     * YANG view of what is valid in {@code /foo/foo/bar} differs from what is valid in {@code /bar/foo/bar}, but this
+     * difference is not reflected in generated Java constructs. More notably, the two augments being in different
+     * modules. Since {@code choice bar}'s is part of a reusable construct, {@code grouping one}, DataObjects' copy
+     * builders can propagate them without translating them to the appropriate manifestation -- and they can do nothing
+     * about that as they lack the complete view of the effective model.
+     *
+     * <p>
+     * This method provides a bridge between a particular instantiation of a {@code choice} to {@link CaseRuntimeType}s
+     * valid in all instantiations.
+     *
+     * @param choiceType A ChoiceRuntimeType
+     * @return The set of {@link CaseRuntimeType}s known to this instance
+     * @throws NullPointerException if {@code ChoiceRuntimeType} is null
+     */
+    @NonNull Set<CaseRuntimeType> allCaseChildren(ChoiceRuntimeType choiceType);
 }