From: Robert Varga <robert.varga@pantheon.tech>
Date: Thu, 28 Sep 2023 21:46:00 +0000 (+0200)
Subject: Improve AbstractNamespaceCodec
X-Git-Tag: v12.0.0~102
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=67e1739cb27a6b1a85f23df9bde248c8b17a84b2;p=yangtools.git

Improve AbstractNamespaceCodec

Improve nullness guarantees in createQName().

Change-Id: Icdb58b2ede7a5e2b8f380614719f3a1842255e53
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---

diff --git a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractNamespaceCodec.java b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractNamespaceCodec.java
index e93ec24da9..bfda556402 100644
--- a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractNamespaceCodec.java
+++ b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractNamespaceCodec.java
@@ -35,10 +35,10 @@ abstract class AbstractNamespaceCodec<T> extends AbstractIllegalArgumentCodec<St
      * @param prefix Prefix for namespace
      * @param localName local name
      * @return QName
-     * @throws IllegalArgumentException if the prefix cannot be resolved
+     * @throws IllegalArgumentException if the {@code prefix} cannot be resolved or if the {@code localName} does not
+     *                                  conform to YANG requirements
      */
-    // FIXME: 9.0.0: this should really be @NonNull, right? we can also throw if localName is not valid
-    protected abstract @Nullable QName createQName(@NonNull String prefix, @NonNull String localName);
+    protected abstract @NonNull QName createQName(@NonNull String prefix, @NonNull String localName);
 
     private static String getIdAndPrefixAsStr(final String pathPart) {
         int predicateStartIndex = pathPart.indexOf('[');
diff --git a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractStringInstanceIdentifierCodec.java b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractStringInstanceIdentifierCodec.java
index be923a7de2..23752a6445 100644
--- a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractStringInstanceIdentifierCodec.java
+++ b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractStringInstanceIdentifierCodec.java
@@ -170,7 +170,7 @@ public abstract class AbstractStringInstanceIdentifierCodec extends AbstractName
      * @param localName Local name string
      * @return A newly-created QName
      */
-    protected QName createQName(final @Nullable QNameModule lastModule, final String localName) {
+    protected @NonNull QName createQName(final @Nullable QNameModule lastModule, final String localName) {
         // This implementation handles both XML encoding, where we follow XML namespace rules and old JSON encoding,
         // which is the same thing: always encode prefixes
         return createQName(XMLConstants.DEFAULT_NS_PREFIX, localName);
diff --git a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/XpathStringParsingPathArgumentBuilder.java b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/XpathStringParsingPathArgumentBuilder.java
index e238a80786..1f22c80b24 100644
--- a/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/XpathStringParsingPathArgumentBuilder.java
+++ b/data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/XpathStringParsingPathArgumentBuilder.java
@@ -208,7 +208,7 @@ final class XpathStringParsingPathArgumentBuilder implements Mutable {
      *
      * @return following QName.
      */
-    private QName nextQName() {
+    private @NonNull QName nextQName() {
         // Consume prefix or identifier
         final String maybePrefix = nextIdentifier();
         if (!allCharactersConsumed() && COLON == currentChar()) {