From 07a2ef840a7c4de06d13cb558a2250c072bb4c77 Mon Sep 17 00:00:00 2001
From: Robert Varga <robert.varga@pantheon.tech>
Date: Tue, 31 Dec 2019 18:19:02 +0100
Subject: [PATCH] Add AbstractQName.bindTo(QNameModule)

Generalize the implementation, as all subclasses provide a variant
of this method.

Change-Id: I4a5f5654f1687a76a3c5f5a2976edae3a90e3245
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---
 .../rfc8528/parser/MountPointStatementSupport.java    |  2 +-
 .../yangtools/yang/common/AbstractQName.java          | 11 +++++++++++
 .../org/opendaylight/yangtools/yang/common/QName.java |  9 ++++++++-
 .../yangtools/yang/common/QualifiedQName.java         |  4 ----
 .../yangtools/yang/common/UnqualifiedQName.java       |  4 ----
 .../yangtools/yang/common/YangConstants.java          | 11 ++++++-----
 .../parser/rfc7950/stmt/key/KeyStatementSupport.java  |  2 +-
 .../stmt/type/AbstractTypeStatementSupport.java       |  2 +-
 .../spi/meta/AbstractQNameStatementSupport.java       |  2 +-
 9 files changed, 29 insertions(+), 18 deletions(-)

diff --git a/yang/rfc8528-parser-support/src/main/java/org/opendaylight/yangtools/rfc8528/parser/MountPointStatementSupport.java b/yang/rfc8528-parser-support/src/main/java/org/opendaylight/yangtools/rfc8528/parser/MountPointStatementSupport.java
index 266208b6af..693c861d01 100644
--- a/yang/rfc8528-parser-support/src/main/java/org/opendaylight/yangtools/rfc8528/parser/MountPointStatementSupport.java
+++ b/yang/rfc8528-parser-support/src/main/java/org/opendaylight/yangtools/rfc8528/parser/MountPointStatementSupport.java
@@ -99,7 +99,7 @@ public final class MountPointStatementSupport
     @Override
     public QName adaptArgumentValue(final StmtContext<QName, MountPointStatement, MountPointEffectiveStatement> ctx,
             final QNameModule targetModule) {
-        return ctx.coerceStatementArgument().withModule(targetModule).intern();
+        return ctx.coerceStatementArgument().bindTo(targetModule).intern();
     }
 
     @Override
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/AbstractQName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/AbstractQName.java
index da1521b76d..6709ad94a7 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/AbstractQName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/AbstractQName.java
@@ -61,6 +61,17 @@ public abstract class AbstractQName implements Identifier, WritableObject {
     @Override
     public abstract String toString();
 
+    /**
+     * Returns a QName with the specified namespace and the same local name as this one.
+     *
+     * @param namespace New namespace to use
+     * @return a QName with specified QNameModule and same local name as this one
+     * @throws NullPointerException if namespace is null
+     */
+    public QName bindTo(final QNameModule namespace) {
+        return new QName(namespace, getLocalName());
+    }
+
     abstract Object writeReplace();
 
     static final String checkLocalName(final @Nullable String localName) {
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java
index feea52586a..46457ec10a 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QName.java
@@ -298,14 +298,21 @@ public final class QName extends AbstractQName implements Comparable<QName> {
         return sb.append(getLocalName()).toString();
     }
 
+    @Override
+    public @NonNull QName bindTo(final QNameModule namespace) {
+        return module.equals(namespace) ? this : super.bindTo(namespace);
+    }
+
     /**
      * Returns a QName with the specified QNameModule and the same localname as this one.
      *
      * @param newModule New QNameModule to use
      * @return a QName with specified QNameModule and same local name as this one
+     * @deprecated Use {@link #bindTo(QNameModule)} instead.
      */
+    @Deprecated(forRemoval = true)
     public @NonNull QName withModule(final QNameModule newModule) {
-        return new QName(newModule, getLocalName());
+        return bindTo(newModule);
     }
 
     /**
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
index f6dce7058e..72be15e045 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
@@ -59,10 +59,6 @@ public final class QualifiedQName extends AbstractQName implements Comparable<Qu
         return namespaceContext.findNamespaceForPrefix(prefix).map(this::bindTo);
     }
 
-    private QName bindTo(final QNameModule namespace) {
-        return new QName(namespace, getLocalName());
-    }
-
     @Override
     @SuppressFBWarnings(value = "ES_COMPARING_STRINGS_WITH_EQ", justification = "Interning identity check")
     public QualifiedQName intern() {
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
index 5fb343815a..6d0bc42b0e 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
@@ -48,10 +48,6 @@ public final class UnqualifiedQName extends AbstractQName implements Comparable<
         return of(in.readUTF());
     }
 
-    public QName bindTo(final QNameModule namespace) {
-        return new QName(namespace, getLocalName());
-    }
-
     @Override
     @SuppressFBWarnings(value = "ES_COMPARING_STRINGS_WITH_EQ", justification = "Interning identity check")
     public UnqualifiedQName intern() {
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/YangConstants.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/YangConstants.java
index c0b7aafcb3..9daf1b4698 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/YangConstants.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/YangConstants.java
@@ -87,9 +87,10 @@ public final class YangConstants {
      */
     public static final String YANG_XPATH_FUNCTIONS_PREFIX = "yang";
 
-    // Dummy template QNames. These are never leaked, but are used for efficient instantiation via QName#withModule()
-    private static final QName DUMMY_OPERATION_INPUT = QName.create("DUMMY", "input");
-    private static final QName DUMMY_OPERATION_OUTPUT = QName.create("DUMMY", "output");
+    // Dummy template UnqualifiedQName. These are never leaked, but are used for efficient instantiation via
+    // UnqualifiedQName#bindTo()
+    private static final UnqualifiedQName DUMMY_OPERATION_INPUT = UnqualifiedQName.of("input");
+    private static final UnqualifiedQName DUMMY_OPERATION_OUTPUT = UnqualifiedQName.of("output");
 
     private YangConstants() {
         // Hidden on purpose
@@ -104,7 +105,7 @@ public final class YangConstants {
      * @throws NullPointerException if {@code module} is null
      */
     public static QName operationInputQName(final QNameModule module) {
-        return DUMMY_OPERATION_INPUT.withModule(module);
+        return DUMMY_OPERATION_INPUT.bindTo(module);
     }
 
     /**
@@ -116,6 +117,6 @@ public final class YangConstants {
      * @throws NullPointerException if {@code module} is null
      */
     public static QName operationOutputQName(final QNameModule module) {
-        return DUMMY_OPERATION_OUTPUT.withModule(module);
+        return DUMMY_OPERATION_OUTPUT.bindTo(module);
     }
 }
diff --git a/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/key/KeyStatementSupport.java b/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/key/KeyStatementSupport.java
index fbdd5784a2..3c514691c3 100644
--- a/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/key/KeyStatementSupport.java
+++ b/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/key/KeyStatementSupport.java
@@ -71,7 +71,7 @@ public final class KeyStatementSupport
         for (final SchemaNodeIdentifier arg : ctx.coerceStatementArgument()) {
             final QName qname = arg.getLastComponent();
             if (!targetModule.equals(qname.getModule())) {
-                final QName newQname = qname.withModule(targetModule).intern();
+                final QName newQname = qname.bindTo(targetModule).intern();
                 builder.add(SchemaNodeIdentifier.SAME.createChild(newQname));
                 replaced = true;
             } else {
diff --git a/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/AbstractTypeStatementSupport.java b/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/AbstractTypeStatementSupport.java
index d84c005561..7e1a00e8b9 100644
--- a/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/AbstractTypeStatementSupport.java
+++ b/yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/AbstractTypeStatementSupport.java
@@ -311,7 +311,7 @@ abstract class AbstractTypeStatementSupport
         final QName parentQName = parent.getLastComponent();
         checkArgument(parentQName != null, "Path %s has an empty parent", path);
 
-        final QName qname = path.getLastComponent().withModule(parentQName.getModule()).intern();
+        final QName qname = path.getLastComponent().bindTo(parentQName.getModule()).intern();
         return parent.createChild(qname);
     }
 }
\ No newline at end of file
diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractQNameStatementSupport.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractQNameStatementSupport.java
index 2bcb7613f7..2a3f3b1d2f 100644
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractQNameStatementSupport.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractQNameStatementSupport.java
@@ -33,6 +33,6 @@ public abstract class AbstractQNameStatementSupport<D extends DeclaredStatement<
 
     @Override
     public QName adaptArgumentValue(final StmtContext<QName, D, E> ctx, final QNameModule targetModule) {
-        return ctx.getStatementArgument().withModule(targetModule).intern();
+        return ctx.getStatementArgument().bindTo(targetModule).intern();
     }
 }
-- 
2.36.6