Remove EffectiveModelContext{Listener,Provider}
[yangtools.git] / data / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / ImmutableNodes.java
index 553243f24d085ea01040b98fef197740908e5ad0..38e7fa8fbd9fe5c5206af4bcc11a7fd6ecc1d9ef 100644 (file)
@@ -7,36 +7,35 @@
  */
 package org.opendaylight.yangtools.yang.data.impl.schema;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
-import java.util.Iterator;
+import java.io.IOException;
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode.BuilderFactory;
 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
 import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
-import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
-import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUserMapNodeBuilder;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.YangInstanceIdentifierWriter;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 
+/**
+ * Utility methods producing immutable implementations of various {@link NormalizedNode}s.
+ *
+ * @deprecated Use {@link org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes} instead.
+ */
+@Deprecated(since = "12.0.0", forRemoval = true)
 public final class ImmutableNodes {
+    private static final @NonNull BuilderFactory BUILDER_FACTORY =
+        org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes.builderFactory();
     // FIXME: YANGTOOLS-1074: we do not want this name
     private static final NodeIdentifier SCHEMACONTEXT_NAME = NodeIdentifier.create(SchemaContext.NAME);
 
@@ -44,17 +43,19 @@ public final class ImmutableNodes {
         // Hidden on purpose
     }
 
-    public static @NonNull CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapNodeBuilder() {
-        return ImmutableMapNodeBuilder.create();
+    public static SystemMapNode.@NonNull Builder mapNodeBuilder() {
+        return BUILDER_FACTORY.newSystemMapBuilder();
     }
 
-    public static @NonNull CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapNodeBuilder(final QName name) {
+    public static SystemMapNode.@NonNull Builder mapNodeBuilder(final QName name) {
         return mapNodeBuilder(NodeIdentifier.create(name));
     }
 
-    public static @NonNull CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapNodeBuilder(
-            final NodeIdentifier name) {
-        return ImmutableMapNodeBuilder.create().withNodeIdentifier(name);
+    public static SystemMapNode.@NonNull Builder mapNodeBuilder(final NodeIdentifier name) {
+        final var ret = mapNodeBuilder();
+        // FIXME: use fluent once we have specialized enough
+        ret.withNodeIdentifier(name);
+        return ret;
     }
 
     /**
@@ -94,7 +95,7 @@ public final class ImmutableNodes {
      * @return An ordered Map node
      */
     public static @NonNull UserMapNode orderedMapNode(final NodeIdentifier name) {
-        return ImmutableUserMapNodeBuilder.create().withNodeIdentifier(name).build();
+        return BUILDER_FACTORY.newUserMapBuilder().withNodeIdentifier(name).build();
     }
 
     /**
@@ -106,7 +107,7 @@ public final class ImmutableNodes {
      * @return Leaf node with supplied identifier and value
      */
     public static <T> @NonNull LeafNode<T> leafNode(final NodeIdentifier name, final T value) {
-        return ImmutableLeafNodeBuilder.createNode(name, value);
+        return org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes.leafNode(name, value);
     }
 
     /**
@@ -118,18 +119,20 @@ public final class ImmutableNodes {
      * @return Leaf node with supplied identifier and value
      */
     public static <T> @NonNull LeafNode<T> leafNode(final QName name, final T value) {
-        return leafNode(NodeIdentifier.create(name), value);
+        return org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes.leafNode(name, value);
     }
 
-    public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
-            final QName nodeName, final QName keyName, final Object keyValue) {
-        return ImmutableMapEntryNodeBuilder.create()
-                .withNodeIdentifier(NodeIdentifierWithPredicates.of(nodeName, keyName, keyValue))
-                .withChild(leafNode(keyName, keyValue));
+    public static MapEntryNode.@NonNull Builder mapEntryBuilder(final QName nodeName, final QName keyName,
+            final Object keyValue) {
+        final var ret = mapEntryBuilder();
+        // FIXME: use fluent once we have specialized enough
+        ret.withNodeIdentifier(NodeIdentifierWithPredicates.of(nodeName, keyName, keyValue))
+            .withChild(leafNode(keyName, keyValue));
+        return ret;
     }
 
-    public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
-        return ImmutableMapEntryNodeBuilder.create();
+    public static MapEntryNode.@NonNull Builder mapEntryBuilder() {
+        return BUILDER_FACTORY.newMapEntryBuilder();
     }
 
     public static @NonNull MapEntryNode mapEntry(final QName nodeName, final QName keyName, final Object keyValue) {
@@ -153,7 +156,7 @@ public final class ImmutableNodes {
      * @return A container node
      */
     public static @NonNull ContainerNode containerNode(final NodeIdentifier name) {
-        return ImmutableContainerNodeBuilder.create().withNodeIdentifier(name).build();
+        return BUILDER_FACTORY.newContainerBuilder().withNodeIdentifier(name).build();
     }
 
     /**
@@ -173,7 +176,7 @@ public final class ImmutableNodes {
      * @return A choice node
      */
     public static @NonNull ChoiceNode choiceNode(final NodeIdentifier name) {
-        return ImmutableChoiceNodeBuilder.create().withNodeIdentifier(name).build();
+        return BUILDER_FACTORY.newChoiceBuilder().withNodeIdentifier(name).build();
     }
 
     /**
@@ -193,7 +196,7 @@ public final class ImmutableNodes {
      * @return An unkeyed list node
      */
     public static @NonNull UnkeyedListNode listNode(final NodeIdentifier name) {
-        return ImmutableUnkeyedListNodeBuilder.create().withNodeIdentifier(name).build();
+        return BUILDER_FACTORY.newUnkeyedListBuilder().withNodeIdentifier(name).build();
     }
 
     /**
@@ -202,22 +205,28 @@ public final class ImmutableNodes {
      * @param ctx schema context to used during serialization
      * @param id instance identifier to convert to node structure starting from root
      * @return serialized normalized node for provided instance Id
+     * @throws NullPointerException if any argument is null
+     * @throws IllegalArgumentException if the identifier cannot be converted
      */
-    public static @NonNull NormalizedNode fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id) {
-        final PathArgument topLevelElement;
-        final InstanceIdToNodes<?> instanceIdToNodes;
-        final Iterator<PathArgument> it = id.getPathArguments().iterator();
-        if (it.hasNext()) {
-            topLevelElement = it.next();
-            final DataSchemaNode dataChildByName = ctx.dataChildByName(topLevelElement.getNodeType());
-            checkNotNull(dataChildByName,
-                "Cannot find %s node in schema context. Instance identifier has to start from root", topLevelElement);
-            instanceIdToNodes = InstanceIdToNodes.fromSchemaAndQNameChecked(ctx, topLevelElement.getNodeType());
-        } else {
-            topLevelElement = SCHEMACONTEXT_NAME;
-            instanceIdToNodes = InstanceIdToNodes.fromDataSchemaNode(ctx);
+    public static @NonNull NormalizedNode fromInstanceId(final EffectiveModelContext ctx,
+            final YangInstanceIdentifier id) {
+        if (id.isEmpty()) {
+            return containerNode(SCHEMACONTEXT_NAME);
         }
 
-        return instanceIdToNodes.create(topLevelElement, it);
+        final var result = new NormalizationResultHolder();
+        try (var writer = ImmutableNormalizedNodeStreamWriter.from(result)) {
+            try (var iidWriter = YangInstanceIdentifierWriter.open(writer, ctx, id)) {
+                // leaf-list entry nodes are special: they require a value and we can derive it from our instance
+                // identitifier
+                final var lastArg = id.getLastPathArgument();
+                if (lastArg instanceof NodeWithValue<?> withValue) {
+                    writer.scalarValue(withValue.getValue());
+                }
+            }
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Failed to convert " + id, e);
+        }
+        return result.getResult().data();
     }
 }