From: Robert Varga <robert.varga@pantheon.tech>
Date: Mon, 30 Sep 2019 09:40:29 +0000 (+0200)
Subject: Allow startAnyxmlNode() to handle differing object models
X-Git-Tag: v4.0.0~9
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=78db01f74de82201a6803951b025f783cd8c0ad8;p=yangtools.git

Allow startAnyxmlNode() to handle differing object models

Anyxml can have a number of underlying object models, with the most
common being DOMSource. This changes the entrypoint to work the same
as anydata, allowing implementations to support different models.

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

diff --git a/yang/rfc7952-data-util/src/main/java/org/opendaylight/yangtools/rfc7952/data/util/NormalizedNodeStreamWriterMetadataDecorator.java b/yang/rfc7952-data-util/src/main/java/org/opendaylight/yangtools/rfc7952/data/util/NormalizedNodeStreamWriterMetadataDecorator.java
index 0e705af7cf..cbcd22b348 100644
--- a/yang/rfc7952-data-util/src/main/java/org/opendaylight/yangtools/rfc7952/data/util/NormalizedNodeStreamWriterMetadataDecorator.java
+++ b/yang/rfc7952-data-util/src/main/java/org/opendaylight/yangtools/rfc7952/data/util/NormalizedNodeStreamWriterMetadataDecorator.java
@@ -123,9 +123,12 @@ final class NormalizedNodeStreamWriterMetadataDecorator extends ForwardingNormal
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        super.startAnyxmlNode(name);
-        enterMetadataNode(name);
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        final boolean ret = super.startAnyxmlNode(name, objectModel);
+        if (ret) {
+            enterMetadataNode(name);
+        }
+        return ret;
     }
 
     @Override
diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/ForwardingNormalizedNodeStreamWriter.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/ForwardingNormalizedNodeStreamWriter.java
index aa7663442a..e5f5ca308e 100644
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/ForwardingNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/ForwardingNormalizedNodeStreamWriter.java
@@ -88,8 +88,8 @@ public abstract class ForwardingNormalizedNodeStreamWriter extends ForwardingObj
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        delegate().startAnyxmlNode(name);
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        return delegate().startAnyxmlNode(name, objectModel);
     }
 
     @Override
diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/LoggingNormalizedNodeStreamWriter.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/LoggingNormalizedNodeStreamWriter.java
index db4952b1dc..c5100112e6 100644
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/LoggingNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/LoggingNormalizedNodeStreamWriter.java
@@ -130,9 +130,10 @@ public final class LoggingNormalizedNodeStreamWriter implements NormalizedNodeSt
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) {
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) {
         LOG.debug("{}{}(anyxml)", ind(), name);
         incIndent();
+        return true;
     }
 
     @Override
diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java
index 5f06ab7adb..a9d2451d9c 100644
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeStreamWriter.java
@@ -59,7 +59,7 @@ import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  * <li>{@code leaf-list} - Leaf list start is emitted using {@link #startLeafSet(NodeIdentifier, int)}. Individual
  * leaf-list entries are emitted using {@link #startLeafSetEntryNode(NodeWithValue)}.
  *
- * <li>{@code anyxml} - An anyxml node event is emitted using {@link #startAnyxmlNode(NodeIdentifier)}.</li>
+ * <li>{@code anyxml} - An anyxml node event is emitted using {@link #startAnyxmlNode(NodeIdentifier, Class)}.</li>
  *
  * <li>{@code choice} - Choice node event is emitted by {@link #startChoiceNode(NodeIdentifier, int)} event.</li>
  *
@@ -154,7 +154,7 @@ public interface NormalizedNodeStreamWriter extends Closeable, Flushable,
      * Emits start of new container. Valid sub-events are:
      * <ul>
      * <li>{@link #startLeafNode}</li>
-     * <li>{@link #startAnyxmlNode(NodeIdentifier)}</li>
+     * <li>{@link #startAnyxmlNode(NodeIdentifier, Class)}</li>
      * <li>{@link #startContainerNode(NodeIdentifier, int)}</li>
      * <li>{@link #startChoiceNode(NodeIdentifier, int)}</li>
      * <li>{@link #startLeafSet(NodeIdentifier, int)}</li>
@@ -308,6 +308,7 @@ public interface NormalizedNodeStreamWriter extends Closeable, Flushable,
      * @param objectModel The object model of anydata content
      * @return True if the specified object model is supported by this extension and the process of emitting the node
      *         has started. False if the object model is not supported and the node has not started to be emitted.
+     * @throws NullPointerException if any argument is null
      * @throws IOException if an underlying IO error occurs
      */
     @Beta
@@ -317,14 +318,16 @@ public interface NormalizedNodeStreamWriter extends Closeable, Flushable,
      * Emits a start of anyxml node event.
      *
      * @param name name of node as defined in schema, namespace and revision are derived from parent node.
-     * @throws NullPointerException if {@code name} is null
+     * @param objectModel The object model of anyxml content
+     * @return True if the specified object model is supported by this extension and the process of emitting the node
+     *         has started. False if the object model is not supported and the node has not started to be emitted.
+     * @throws NullPointerException if any argument is null
      * @throws IllegalArgumentException If emitted node is invalid in current context or was emitted multiple times.
      * @throws IllegalStateException If node was emitted inside {@code map}, {@code choice} or a {@code unkeyed list}
      *                               node.
      * @throws IOException if an underlying IO error occurs
      */
-    // FIXME: 4.0.0: this should follow the startAnydataNode template
-    void startAnyxmlNode(NodeIdentifier name) throws IOException;
+    boolean startAnyxmlNode(NodeIdentifier name, Class<?> objectModel) throws IOException;
 
     /**
      * Set the value of current anyxml node. This call is only valid within the context in which an anyxml node is open.
diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeWriter.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeWriter.java
index 96500be754..87aa4d680b 100644
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeWriter.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeWriter.java
@@ -150,11 +150,14 @@ public class NormalizedNodeWriter implements Closeable, Flushable {
         } else if (node instanceof AnyxmlNode) {
             final AnyxmlNode<?> anyxmlNode = (AnyxmlNode<?>)node;
             final Class<?> model = anyxmlNode.getValueObjectModel();
-            if (DOMSource.class.isAssignableFrom(model)) {
+            if (writer.startAnyxmlNode(anyxmlNode.getIdentifier(), model)) {
                 final Object value = node.getValue();
-                verify(value instanceof DOMSource, "Inconsistent anyxml node %s", anyxmlNode);
-                writer.startAnyxmlNode(anyxmlNode.getIdentifier());
-                writer.domSourceValue((DOMSource) value);
+                if (DOMSource.class.isAssignableFrom(model)) {
+                    verify(value instanceof DOMSource, "Inconsistent anyxml node %s", anyxmlNode);
+                    writer.domSourceValue((DOMSource) value);
+                } else {
+                    writer.scalarValue(value);
+                }
                 writer.endNode();
                 return true;
             }
diff --git a/yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONNormalizedNodeStreamWriter.java b/yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONNormalizedNodeStreamWriter.java
index 6101d15bc8..cb2ed769d3 100644
--- a/yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONNormalizedNodeStreamWriter.java
@@ -316,10 +316,14 @@ public abstract class JSONNormalizedNodeStreamWriter implements NormalizedNodeSt
     }
 
     @Override
-    public final void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        tracker.startAnyxmlNode(name);
-        context.emittingChild(codecs.getSchemaContext(), writer);
-        context.writeChildJsonIdentifier(codecs.getSchemaContext(), writer, name.getNodeType());
+    public final boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        if (DOMSource.class.isAssignableFrom(objectModel)) {
+            tracker.startAnyxmlNode(name);
+            context.emittingChild(codecs.getSchemaContext(), writer);
+            context.writeChildJsonIdentifier(codecs.getSchemaContext(), writer, name.getNodeType());
+            return true;
+        }
+        return false;
     }
 
     @Override
diff --git a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java
index 86f4041bac..9c60bb759c 100644
--- a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java
@@ -138,9 +138,13 @@ final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNorm
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        tracker.startAnyxmlNode(name);
-        startElement(name.getNodeType());
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        if (DOMSource.class.isAssignableFrom(objectModel)) {
+            tracker.startAnyxmlNode(name);
+            startElement(name.getNodeType());
+            return true;
+        }
+        return false;
     }
 
     @Override
diff --git a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemalessXMLStreamNormalizedNodeStreamWriter.java b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemalessXMLStreamNormalizedNodeStreamWriter.java
index fee9596aae..8d1b68c492 100644
--- a/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemalessXMLStreamNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemalessXMLStreamNormalizedNodeStreamWriter.java
@@ -79,9 +79,13 @@ final class SchemalessXMLStreamNormalizedNodeStreamWriter extends XMLStreamNorma
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        nodeTypeStack.push(NodeType.ANY_XML);
-        startElement(name.getNodeType());
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        if (DOMSource.class.isAssignableFrom(objectModel)) {
+            nodeTypeStack.push(NodeType.ANY_XML);
+            startElement(name.getNodeType());
+            return true;
+        }
+        return false;
     }
 
     @Override
diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
index 9cce8db57b..d8b9dc438e 100644
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
@@ -165,10 +165,14 @@ public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStream
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) {
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) {
         checkDataNodeContainer();
-        enter(name, ImmutableAnyXmlNodeBuilder.create());
-        nextSchema = null;
+        if (DOMSource.class.isAssignableFrom(objectModel)) {
+            enter(name, ImmutableAnyXmlNodeBuilder.create());
+            nextSchema = null;
+            return true;
+        }
+        return false;
     }
 
     @Override
diff --git a/yang/yang-data-transform/src/main/java/org/opendaylight/yangtools/transform/QNameTransformingStreamWriter.java b/yang/yang-data-transform/src/main/java/org/opendaylight/yangtools/transform/QNameTransformingStreamWriter.java
index 444464fd6a..1ff8994794 100644
--- a/yang/yang-data-transform/src/main/java/org/opendaylight/yangtools/transform/QNameTransformingStreamWriter.java
+++ b/yang/yang-data-transform/src/main/java/org/opendaylight/yangtools/transform/QNameTransformingStreamWriter.java
@@ -144,8 +144,8 @@ public abstract class QNameTransformingStreamWriter extends ForwardingNormalized
     }
 
     @Override
-    public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
-        super.startAnyxmlNode(transform(name));
+    public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+        return super.startAnyxmlNode(transform(name), objectModel);
     }
 
     @Override
diff --git a/yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AnyXmlNodeDataWithSchema.java b/yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AnyXmlNodeDataWithSchema.java
index d0151f2a9a..962076588d 100644
--- a/yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AnyXmlNodeDataWithSchema.java
+++ b/yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AnyXmlNodeDataWithSchema.java
@@ -30,9 +30,10 @@ public class AnyXmlNodeDataWithSchema extends SimpleNodeDataWithSchema<AnyxmlSch
     public void write(final NormalizedNodeStreamWriter writer, final StreamWriterMetadataExtension metaWriter)
             throws IOException {
         writer.nextDataSchemaNode(getSchema());
-        writer.startAnyxmlNode(provideNodeIdentifier());
-        writeMetadata(metaWriter);
-        writer.domSourceValue((DOMSource) getValue());
-        writer.endNode();
+        if (writer.startAnyxmlNode(provideNodeIdentifier(), DOMSource.class)) {
+            writeMetadata(metaWriter);
+            writer.domSourceValue((DOMSource) getValue());
+            writer.endNode();
+        }
     }
 }