From: Robert Varga <robert.varga@pantheon.tech>
Date: Mon, 17 Feb 2020 22:36:15 +0000 (+0100)
Subject: Deprecate BindingRuntimeContext.getEnumMapping()
X-Git-Tag: v4.0.12~10
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=55112d628f5db3c7ad81d252d16aa5c4f71821ad;hp=ca8ea99b492d3cf0fcce2b8fc90af5abea9d95a2;p=mdsal.git

Deprecate BindingRuntimeContext.getEnumMapping()

Generated enumerations capture their YANG-declared name and expose
it as their method.

JIRA: MDSAL-392
Change-Id: Iac16b6b3599565f059332ed079c432c0603ac500
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---

diff --git a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/util/BindingRuntimeContext.java b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/util/BindingRuntimeContext.java
index dc2be63654..400bed420f 100644
--- a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/util/BindingRuntimeContext.java
+++ b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/util/BindingRuntimeContext.java
@@ -47,6 +47,7 @@ import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
 import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.yang.binding.Action;
 import org.opendaylight.yangtools.yang.binding.Augmentation;
+import org.opendaylight.yangtools.yang.binding.Enumeration;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
@@ -310,7 +311,9 @@ public final class BindingRuntimeContext implements Immutable {
      *
      * @param enumClass enum generated class
      * @return mapped enum constants from yang with their corresponding values in generated binding classes
+     * @deprecated This method is not guaranteed to be accurate. Use {@link Enumeration#getName()} instead.
      */
+    @Deprecated
     public BiMap<String, String> getEnumMapping(final Class<?> enumClass) {
         final Entry<GeneratedType, WithStatus> typeWithSchema = getTypeWithSchema(enumClass);
         return getEnumMapping(typeWithSchema);
@@ -321,7 +324,9 @@ public final class BindingRuntimeContext implements Immutable {
      *
      * @param enumClassName enum generated class name
      * @return mapped enum constants from yang with their corresponding values in generated binding classes
+     * @deprecated This method is not guaranteed to be accurate. Use {@link Enumeration#getName()} instead.
      */
+    @Deprecated
     public BiMap<String, String> getEnumMapping(final String enumClassName) {
         return getEnumMapping(findTypeWithSchema(enumClassName));
     }