Rename {Data,Schema}TreeAwareEffectiveStatement.Namespace 34/99934/2
authorRobert Varga <robert.varga@pantheon.tech>
Wed, 2 Mar 2022 13:43:48 +0000 (14:43 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Wed, 2 Mar 2022 14:51:15 +0000 (15:51 +0100)
These two namespaces are related and are often used together, yet their
naming gets into way. Rename them to {Data,Schema}TreeNamespace and
adjust users.

Change-Id: I1978bb31cb19856ba10006f0c891f8c16c694292
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
codec/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONCodecFactorySupplier.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataTreeAwareEffectiveStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataTreeEffectiveStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaTreeAwareEffectiveStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/SchemaTreeEffectiveStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/compat/ActionNodeContainerCompat.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/compat/NotificationNodeContainerCompat.java
model/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/AbstractDeclaredEffectiveStatement.java
model/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/AbstractUndeclaredEffectiveStatement.java
parser/rfc8040-parser-support/src/main/java/org/opendaylight/yangtools/rfc8040/parser/YangDataEffectiveStatementImpl.java

index 8744651ab9cc42e03d4ab6dd8af714c9b7a5c64b..abe389fd0827230688e45bda87b8147cff43c93a 100644 (file)
@@ -26,7 +26,7 @@ import org.opendaylight.yangtools.yang.data.util.codec.SharedCodecCache;
 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement.Namespace;
+import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement.DataTreeNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
 import org.slf4j.Logger;
@@ -91,7 +91,7 @@ public enum JSONCodecFactorySupplier {
         private static int codecsForChildren(final JSONCodecFactory lazy, final SchemaInferenceStack stack,
                 final DataTreeAwareEffectiveStatement<?, ?> parent) {
             int ret = 0;
-            for (var entry : parent.getAll(Namespace.class).entrySet()) {
+            for (var entry : parent.getAll(DataTreeNamespace.class).entrySet()) {
                 final var child = entry.getValue();
                 if (child instanceof DataTreeAwareEffectiveStatement) {
                     stack.enterDataTree(entry.getKey());
index 897dabb20e137183bb9889132abc17d89b2f50d0..1788a89afe408c2478f8085312e42b96cae02d8a 100644 (file)
@@ -22,23 +22,22 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  *
  * @param <A> Argument type
  * @param <D> Class representing declared version of this statement.
- * @author Robert Varga
  */
 @Beta
 public interface DataTreeAwareEffectiveStatement<A, D extends DeclaredStatement<A>>
         extends SchemaTreeAwareEffectiveStatement<A, D> {
     /**
-     * Namespace of {@code data node}s. This is a subtree of {@link SchemaTreeAwareEffectiveStatement.Namespace} in that
-     * all data nodes are also schema nodes. The structure of the tree is different, though, as {@code choice}
-     * and {@code case} statements are glossed over and they do not contribute to the tree hierarchy -- only their
-     * children do.
+     * Namespace of {@code data node}s. This is a subtree of
+     * {@link SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace} in that all data nodes are also schema nodes. The
+     * structure of the tree is different, though, as {@code choice} and {@code case} statements are glossed over and
+     * they do not contribute to the tree hierarchy -- only their children do.
      *
      * <p>
      * This corresponds to the {@code data tree} view of a YANG-defined data.
      */
     @NonNullByDefault
-    abstract class Namespace extends EffectiveStatementNamespace<DataTreeEffectiveStatement<?>> {
-        private Namespace() {
+    abstract class DataTreeNamespace extends EffectiveStatementNamespace<DataTreeEffectiveStatement<?>> {
+        private DataTreeNamespace() {
             // Should never be instantiated
         }
     }
@@ -51,7 +50,7 @@ public interface DataTreeAwareEffectiveStatement<A, D extends DeclaredStatement<
      * @throws NullPointerException if {@code qname} is null
      */
     default @NonNull Optional<DataTreeEffectiveStatement<?>> findDataTreeNode(final @NonNull QName qname) {
-        return get(Namespace.class, requireNonNull(qname));
+        return get(DataTreeNamespace.class, requireNonNull(qname));
     }
 
     /**
index a55fa808f5df7b7ba44976ca4e005c448ed52756..c10e649556bbeac00e7ed610c732dc36fb91b02b 100644 (file)
@@ -15,7 +15,7 @@ import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 
 /**
  * Common interface grouping all {@link EffectiveStatement}s which are accessible via
- * {@link DataTreeAwareEffectiveStatement.Namespace}. This such statement corresponds to a {@code data node}.
+ * {@link DataTreeAwareEffectiveStatement.DataTreeNamespace}. This such statement corresponds to a {@code data node}.
  *
  * <p>
  * This interface could be named {@code SchemaNodeEffectiveStatement}, but that could induce a notion that it has
@@ -24,7 +24,6 @@ import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  * always be preferred and DataSchemaNode is to be treated as deprecated whenever possible.
  *
  * @param <D> Declared statement type
- * @author Robert Varga
  */
 @Beta
 public interface DataTreeEffectiveStatement<D extends DeclaredStatement<QName>>
index f110b808bb1b24e2537bc76330c4dea6c4781b40..1dbdf05cd34c9e1e72973edad1872072dced5ce5 100644 (file)
@@ -37,8 +37,8 @@ public interface SchemaTreeAwareEffectiveStatement<A, D extends DeclaredStatemen
      * Namespace of {@code schema node}s defined within this node.
      */
     @NonNullByDefault
-    abstract class Namespace extends EffectiveStatementNamespace<SchemaTreeEffectiveStatement<?>> {
-        private Namespace() {
+    abstract class SchemaTreeNamespace extends EffectiveStatementNamespace<SchemaTreeEffectiveStatement<?>> {
+        private SchemaTreeNamespace() {
             // Should never be instantiated
         }
     }
@@ -51,7 +51,7 @@ public interface SchemaTreeAwareEffectiveStatement<A, D extends DeclaredStatemen
      * @throws NullPointerException if {@code qname} is null
      */
     default @NonNull Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(final @NonNull QName qname) {
-        return get(Namespace.class, requireNonNull(qname));
+        return get(SchemaTreeNamespace.class, requireNonNull(qname));
     }
 
     /**
index 9468c2b7ac5ae205a320e0cbc8c4d501b4a2bfdd..fb3a28c93ebc58ca8a9168b5e079591a3d540b04 100644 (file)
@@ -15,7 +15,8 @@ import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 
 /**
  * Common interface grouping all {@link EffectiveStatement}s which are accessible via
- * {@link SchemaTreeAwareEffectiveStatement.Namespace}. This such statement corresponds to a {@code schema node}.
+ * {@link SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace}. This such statement corresponds to a
+ * {@code schema node}.
  *
  * <p>
  * This interface could be named {@code SchemaNodeEffectiveStatement}, but that could induce a notion that it has
@@ -24,7 +25,6 @@ import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  * always be preferred and SchemaNode is to be treated as deprecated whenever possible.
  *
  * @param <D> Declared statement type
- * @author Robert Varga
  */
 @Beta
 public interface SchemaTreeEffectiveStatement<D extends DeclaredStatement<QName>>
index 4626c389e4fb03235013abbfad9fee121e0d6f52..08bbeefc16ce913abc2306c0c05bae5ff9ab7c74 100644 (file)
@@ -28,7 +28,7 @@ public interface ActionNodeContainerCompat<A, D extends DeclaredStatement<A>,
     default Optional<ActionDefinition> findAction(final QName qname) {
         // 'action' identifier must never collide with another element, hence if we look it up and it ends up being
         // an ActionDefinition, we have found a match.
-        return get(Namespace.class, qname)
+        return get(SchemaTreeNamespace.class, qname)
             .flatMap(child -> child instanceof ActionDefinition ? Optional.of((ActionDefinition) child)
                 : Optional.empty());
     }
index 7d98318cfe067906834997076f276fb2730b7902..dd1d181d4f96be751b742fdfe406c5d116360c10 100644 (file)
@@ -28,7 +28,7 @@ public interface NotificationNodeContainerCompat<A, D extends DeclaredStatement<
     default Optional<NotificationDefinition> findNotification(final QName qname) {
         // 'notification' identifier must never collide with another element, hence if we look it up and it ends up
         // being an NotificationDefinition, we have found a match.
-        return get(Namespace.class, qname)
+        return get(SchemaTreeNamespace.class, qname)
             .flatMap(child -> child instanceof NotificationDefinition ? Optional.of((NotificationDefinition) child)
                 : Optional.empty());
     }
index 92ab46c4fecf0c68b98612d94f46bfbf09cb28a1..f6c1c7a5aaf42131caff53d61544f5d2ab0449fe 100644 (file)
@@ -24,8 +24,10 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement.DataTreeNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefNamespace;
 
@@ -60,7 +62,7 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
         @SuppressWarnings("unchecked")
         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
                 final Class<N> namespace) {
-            if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
+            if (SchemaTreeNamespace.class.equals(namespace)) {
                 return Optional.of((Map<K, V>) schemaTreeNamespace());
             }
             return super.getNamespaceContents(namespace);
@@ -91,7 +93,7 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
         @SuppressWarnings("unchecked")
         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
                 final Class<N> namespace) {
-            if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
+            if (DataTreeNamespace.class.equals(namespace)) {
                 return Optional.of((Map<K, V>) dataTreeNamespace());
             }
             return super.getNamespaceContents(namespace);
index 3b48eee8eb09444f47bda8e73d394da6007637fb..2cd305ef1bd4b1bebb71c10bfe23787d52847517 100644 (file)
@@ -24,8 +24,10 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement.DataTreeNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
 
 @Beta
@@ -49,7 +51,7 @@ public abstract class AbstractUndeclaredEffectiveStatement<A, D extends Declared
         @SuppressWarnings("unchecked")
         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
                 final Class<N> namespace) {
-            if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
+            if (SchemaTreeNamespace.class.equals(namespace)) {
                 return Optional.of((Map<K, V>) schemaTreeNamespace());
             }
             return super.getNamespaceContents(namespace);
@@ -80,7 +82,7 @@ public abstract class AbstractUndeclaredEffectiveStatement<A, D extends Declared
         @SuppressWarnings("unchecked")
         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
                 final Class<N> namespace) {
-            if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
+            if (DataTreeNamespace.class.equals(namespace)) {
                 return Optional.of((Map<K, V>) dataTreeNamespace());
             }
             return super.getNamespaceContents(namespace);
index 6382d3c42746c81f93b71bb5fd38eecc3bfec3d2..3b083715141837d907ccb6af7c1ab1afaa53a134 100644 (file)
@@ -23,8 +23,6 @@ import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.spi.meta.AbstractEffectiveUnknownSchmemaNode;
 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
 
@@ -70,8 +68,7 @@ final class YangDataEffectiveStatementImpl extends AbstractEffectiveUnknownSchme
     @Override
     protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
             final Class<N> namespace) {
-        if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)
-            || DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
+        if (SchemaTreeNamespace.class.equals(namespace) || DataTreeNamespace.class.equals(namespace)) {
             @SuppressWarnings("unchecked")
             final Map<K, V> ns = (Map<K, V>)Map.of(container.argument(), container);
             return Optional.of(ns);