Allow JSON/XML writers to be instantiated with root node

[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / codec / SchemaTracker.java

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/SchemaTracker.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/SchemaTracker.java
index b969d40bac9ccdf4add939ff109a413d45c50594..7a9bd4c9065221bdc8d452a0f0863be27b3fa023 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/SchemaTracker.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/SchemaTracker.java
@@ -8,6 +8,7 @@
 package org.opendaylight.yangtools.yang.data.impl.codec;
 
 import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
 
 import com.google.common.annotations.Beta;
 import com.google.common.collect.Iterables;
@@ -15,8 +16,9 @@ import java.io.IOException;
 import java.util.ArrayDeque;
 import java.util.Collection;
 import java.util.Deque;
-import java.util.HashSet;
 import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyXmlSchemaNode;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
@@ -24,9 +26,9 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgum
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
@@ -39,7 +41,6 @@ import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
-import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
 import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -54,18 +55,8 @@ public final class SchemaTracker {
     private final Deque<Object> schemaStack = new ArrayDeque<>();
     private final DataNodeContainer root;
 
-    private SchemaTracker(final SchemaContext context, final SchemaPath path) {
-        final Collection<SchemaNode> schemaNodes = SchemaUtils.findParentSchemaNodesOnPath(context, path);
-        checkArgument(!schemaNodes.isEmpty(), "Unable to find schema node for supplied schema path: %s", path);
-        if (schemaNodes.size() > 1) {
-            LOG.warn("More possible schema nodes {} for supplied schema path {}", schemaNodes, path);
-        }
-        final Optional<SchemaNode> current = schemaNodes.stream().filter(node -> node instanceof DataNodeContainer)
-                .findFirst();
-        checkArgument(current.isPresent(),
-                "Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",
-                path, current);
-        root = (DataNodeContainer) current.get();
+    private SchemaTracker(final DataNodeContainer root) {
+        this.root = requireNonNull(root);
     }
 
     /**
@@ -74,8 +65,19 @@ public final class SchemaTracker {
      * @param context Associated {@link SchemaContext}.
      * @return A new {@link NormalizedNodeStreamWriter}
      */
-    public static SchemaTracker create(final SchemaContext context) {
-        return create(context, SchemaPath.ROOT);
+    // FIXME: 3.0.0: remove this method
+    public static @NonNull SchemaTracker create(final SchemaContext context) {
+        return new SchemaTracker(context);
+    }
+
+    /**
+     * Create a new writer with the specified node as its root.
+     *
+     * @param root Root node
+     * @return A new {@link NormalizedNodeStreamWriter}
+     */
+    public static @NonNull SchemaTracker create(final DataNodeContainer root) {
+        return new SchemaTracker(root);
     }
 
     /**
@@ -85,8 +87,19 @@ public final class SchemaTracker {
      * @param path schema path
      * @return A new {@link NormalizedNodeStreamWriter}
      */
-    public static SchemaTracker create(final SchemaContext context, final SchemaPath path) {
-        return new SchemaTracker(context, path);
+    public static @NonNull SchemaTracker create(final SchemaContext context, final SchemaPath path) {
+        final Collection<SchemaNode> schemaNodes = SchemaUtils.findParentSchemaNodesOnPath(context, path);
+        checkArgument(!schemaNodes.isEmpty(), "Unable to find schema node for supplied schema path: %s", path);
+        if (schemaNodes.size() > 1) {
+            LOG.warn("More possible schema nodes {} for supplied schema path {}", schemaNodes, path);
+        }
+        final Optional<DataNodeContainer> current = schemaNodes.stream()
+                .filter(node -> node instanceof DataNodeContainer).map(DataNodeContainer.class::cast)
+                .findFirst();
+        checkArgument(current.isPresent(),
+                "Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",
+                path, current);
+        return new SchemaTracker(current.get());
     }
 
     public Object getParent() {
@@ -121,7 +134,7 @@ public final class SchemaTracker {
 
     private static SchemaNode findChildInCases(final ChoiceSchemaNode parent, final QName qname) {
         DataSchemaNode schema = null;
-        for (final ChoiceCaseNode caze : parent.getCases()) {
+        for (final CaseSchemaNode caze : parent.getCases().values()) {
             final DataSchemaNode potential = caze.getDataChildByName(qname);
             if (potential != null) {
                 schema = potential;
@@ -133,7 +146,7 @@ public final class SchemaTracker {
 
     private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
         DataSchemaNode schema = null;
-        for (final ChoiceCaseNode caze : parent.getCases()) {
+        for (final CaseSchemaNode caze : parent.getCases().values()) {
             final DataSchemaNode potential = caze.getDataChildByName(qname);
             if (potential != null) {
                 schema = caze;
@@ -170,14 +183,6 @@ public final class SchemaTracker {
         return (LeafListSchemaNode)schema;
     }
 
-    @Deprecated
-    public LeafListSchemaNode leafSetEntryNode() {
-        final Object parent = getParent();
-
-        checkArgument(parent instanceof LeafListSchemaNode, "Not currently in a leaf-list");
-        return (LeafListSchemaNode) parent;
-    }
-
     public LeafListSchemaNode leafSetEntryNode(final QName qname) {
         final Object parent = getParent();
         if (parent instanceof LeafListSchemaNode) {
@@ -224,7 +229,7 @@ public final class SchemaTracker {
         return schema;
     }
 
-    public AugmentationSchema startAugmentationNode(final AugmentationIdentifier identifier) {
+    public AugmentationSchemaNode startAugmentationNode(final AugmentationIdentifier identifier) {
         LOG.debug("Enter augmentation {}", identifier);
         Object parent = getParent();
 
@@ -234,13 +239,10 @@ public final class SchemaTracker {
             parent = findCaseByChild((ChoiceSchemaNode) parent, name);
         }
         checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer", parent);
-        final AugmentationSchema schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent,
+        final AugmentationSchemaNode schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent,
             identifier.getPossibleChildNames());
-        final HashSet<DataSchemaNode> realChildSchemas = new HashSet<>();
-        for (final DataSchemaNode child : schema.getChildNodes()) {
-            realChildSchemas.add(((DataNodeContainer) parent).getDataChildByName(child.getQName()));
-        }
-        final AugmentationSchema resolvedSchema = new EffectiveAugmentationSchema(schema, realChildSchemas);
+        final AugmentationSchemaNode resolvedSchema = EffectiveAugmentationSchema.create(schema,
+            (DataNodeContainer) parent);
         schemaStack.push(resolvedSchema);
         return resolvedSchema;
     }