Separate out YangIdentifierClassNamingStrategy

Our current ClassNamingStrategies rely on the fact that each YANG
statement's argument provides an AbstractQName from which we can extract
a YANG identifier (i.e. AbstractQName.getLocalName()).

ietf-restconf:yang-data's argument is any non-empty String, so we just
cannot keep this contract.

Separate current handing into a separate class, which inherits the
notion of having a nodeIdentifier(), except that fact is purely internal
field. This also neatly re-joins Module and CamelCase to use the same
simpleClassName() method.

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

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseNamingStrategy.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseNamingStrategy.java
index c0e20918ea4e711eef4c323ffc1df8e1ba769a95..85334de947f4de466c216463d68336b5b19a062b 100644 (file)
--- a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseNamingStrategy.java
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseNamingStrategy.java
@@ -12,22 +12,15 @@ import static java.util.Objects.requireNonNull;
 import com.google.common.base.MoreObjects.ToStringHelper;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
 import org.opendaylight.yangtools.yang.common.AbstractQName;
 
 @NonNullByDefault
-final class CamelCaseNamingStrategy extends ClassNamingStrategy {
+final class CamelCaseNamingStrategy extends YangIdentifierClassNamingStrategy {
     private final StatementNamespace namespace;
-    private final AbstractQName nodeIdentifier;
 
     CamelCaseNamingStrategy(final StatementNamespace namespace, final AbstractQName nodeIdentifier) {
+        super(nodeIdentifier);
         this.namespace = requireNonNull(namespace);
-        this.nodeIdentifier = requireNonNull(nodeIdentifier);
-    }
-
-    @Override
-    AbstractQName nodeIdentifier() {
-        return nodeIdentifier;
     }
 
     StatementNamespace namespace() {
@@ -39,13 +32,8 @@ final class CamelCaseNamingStrategy extends ClassNamingStrategy {
         return new CamelCaseWithNamespaceNamingStrategy(this);
     }
 
-    @Override
-    String simpleClassName() {
-        return BindingMapping.getClassName(nodeIdentifier.getLocalName());
-    }
-
     @Override
     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
-        return helper.add("localName", nodeIdentifier.getLocalName()).add("namespace", namespace);
+        return super.addToStringAttributes(helper).add("namespace", namespace);
     }
 }

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseWithNamespaceNamingStrategy.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseWithNamespaceNamingStrategy.java
index d17483c1f2c45d16723df6af5055aa562ed94bd3..5a60fe4582279c3b8cbad32b7edf42f7ef9b27fa 100644 (file)
--- a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseWithNamespaceNamingStrategy.java
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CamelCaseWithNamespaceNamingStrategy.java
@@ -10,7 +10,6 @@ package org.opendaylight.mdsal.binding.generator.impl.reactor;
 import static java.util.Objects.requireNonNull;
 
 import com.google.common.base.MoreObjects.ToStringHelper;
-import org.opendaylight.yangtools.yang.common.AbstractQName;
 
 final class CamelCaseWithNamespaceNamingStrategy extends ClassNamingStrategy {
     private final CamelCaseNamingStrategy delegate;
@@ -19,11 +18,6 @@ final class CamelCaseWithNamespaceNamingStrategy extends ClassNamingStrategy {
         this.delegate = requireNonNull(delegate);
     }
 
-    @Override
-    AbstractQName nodeIdentifier() {
-        return delegate.nodeIdentifier();
-    }
-
     @Override
     String simpleClassName() {
         return delegate.namespace().appendSuffix(delegate.simpleClassName());
@@ -43,6 +37,16 @@ final class CamelCaseWithNamespaceNamingStrategy extends ClassNamingStrategy {
         return null;
     }
 
+    @Override
+    String rootName() {
+        return delegate.rootName();
+    }
+
+    @Override
+    String childPackage() {
+        return delegate.childPackage();
+    }
+
     @Override
     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
         return helper.add("delegate", delegate);

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ClassNamingStrategy.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ClassNamingStrategy.java
index 5634beed3bc38cd9f0a785a4c4db0127a26ffe76..abae47e7fa72305c22dd4f0cee446de0ae87aa58 100644 (file)
--- a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ClassNamingStrategy.java
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ClassNamingStrategy.java
@@ -12,21 +12,12 @@ import com.google.common.base.MoreObjects.ToStringHelper;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.concepts.Immutable;
-import org.opendaylight.yangtools.yang.common.AbstractQName;
 
 /**
  * Enumeration of known strategies for translating a YANG node identifier into a Java package name segment or a Java
  * simple class name.
  */
 abstract class ClassNamingStrategy implements Immutable {
-    /**
-     * Return the YANG node identifier backing this naming strategy. Only the {@link AbstractQName#getLocalName()} part
-     * of the identifier is significant.
-     *
-     * @return YANG node identifier.
-     */
-    abstract @NonNull AbstractQName nodeIdentifier();
-
     /**
      * Return the simple Java class name assigned by this naming strategy.
      *
@@ -42,6 +33,16 @@ abstract class ClassNamingStrategy implements Immutable {
      */
     abstract @Nullable ClassNamingStrategy fallback();
 
+    // FIXME: document this method
+    abstract @NonNull String rootName();
+
+    /**
+     * Return the {@code Java package name} allocated for any classes generated as children of this strategy.
+     *
+     * @return A package fragment name, for example {@code "foo.bar.baz"}
+     */
+    abstract @NonNull String childPackage();
+
     @Override
     public final String toString() {
         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CollisionDomain.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CollisionDomain.java
index ff6c52a5a3a1b507629a3898884373b3595d3f2a..0f8d9d2f7292954fb60a1902dd8d702fd219d62c 100644 (file)
--- a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CollisionDomain.java
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/CollisionDomain.java
@@ -101,7 +101,7 @@ final class CollisionDomain {
 
         @Override
         final String computeCurrentPackage() {
-            return packageString(strategy.nodeIdentifier());
+            return strategy.childPackage();
         }
 
         @Override
@@ -122,8 +122,7 @@ final class CollisionDomain {
 
         @Override
         boolean equalRoot(final Member other) {
-            return other instanceof Primary primary
-                && strategy.nodeIdentifier().getLocalName().equals(primary.strategy.nodeIdentifier().getLocalName());
+            return other instanceof Primary primary && strategy.rootName().equals(primary.strategy.rootName());
         }
     }
 
@@ -331,8 +330,8 @@ final class CollisionDomain {
         return member;
     }
 
-    private static @NonNull String packageString(final AbstractQName component) {
-        // Replace dashes with dots, as dashes are not allowed in package names
+    // Replace dashes with dots, as dashes are not allowed in package names
+    static @NonNull String packageString(final AbstractQName component) {
         return component.getLocalName().replace('-', '.');
     }
 }

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ModuleNamingStrategy.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ModuleNamingStrategy.java
index 98d95c3001a84c59dd044dd558d65ee93c2f5e21..045062184b60a379733a5875c545b4c7a898a0d9 100644 (file)
--- a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ModuleNamingStrategy.java
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ModuleNamingStrategy.java
@@ -7,37 +7,18 @@
  */
 package org.opendaylight.mdsal.binding.generator.impl.reactor;
 
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.base.MoreObjects.ToStringHelper;
-import org.eclipse.jdt.annotation.NonNull;
-import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.yang.common.AbstractQName;
 
-final class ModuleNamingStrategy extends ClassNamingStrategy {
-    private final @NonNull AbstractQName name;
-
+@NonNullByDefault
+final class ModuleNamingStrategy extends YangIdentifierClassNamingStrategy {
     ModuleNamingStrategy(final AbstractQName name) {
-        this.name = requireNonNull(name);
-    }
-
-    @Override
-    AbstractQName nodeIdentifier() {
-        return name;
+        super(name);
     }
 
     @Override
-    String simpleClassName() {
-        return BindingMapping.getClassName(name.getLocalName());
-    }
-
-    @Override
-    ClassNamingStrategy fallback() {
+    @Nullable ClassNamingStrategy fallback() {
         return null;
     }
-
-    @Override
-    ToStringHelper addToStringAttributes(final ToStringHelper helper) {
-        return helper.add("localName", name.getLocalName());
-    }
 }

diff --git a/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/YangIdentifierClassNamingStrategy.java b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/YangIdentifierClassNamingStrategy.java
new file mode 100644 (file)
index 0000000..673bcd4
--- /dev/null
+++ b/binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/YangIdentifierClassNamingStrategy.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.generator.impl.reactor;
+
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.base.MoreObjects.ToStringHelper;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
+import org.opendaylight.yangtools.yang.common.AbstractQName;
+
+/**
+ * A {@link ClassNamingStrategy} which is based on a YANG node identifier as captured in
+ * {@link AbstractQName#getLocalName()}.
+ */
+@NonNullByDefault
+abstract class YangIdentifierClassNamingStrategy extends ClassNamingStrategy {
+    private final AbstractQName nodeIdentifier;
+
+    YangIdentifierClassNamingStrategy(final AbstractQName nodeIdentifier) {
+        this.nodeIdentifier = requireNonNull(nodeIdentifier);
+    }
+
+    @Override
+    final String simpleClassName() {
+        return BindingMapping.getClassName(rootName());
+    }
+
+    @Override
+    final String rootName() {
+        return nodeIdentifier.getLocalName();
+    }
+
+    @Override
+    final String childPackage() {
+        return CollisionDomain.packageString(nodeIdentifier);
+    }
+
+    @Override
+    ToStringHelper addToStringAttributes(final ToStringHelper helper) {
+        return helper.add("localName", rootName());
+    }
+}