Allow LeafSetEntryNodes to be added to result builder
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / ImmutableNodes.java
index 6ab563185f1dc540bd1df9e230b8e816a53eb2db..987406e19c4864d852fbdcbdd965998f4bd72834 100644 (file)
@@ -7,14 +7,18 @@
  */
 package org.opendaylight.yangtools.yang.data.impl.schema;
 
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.Iterator;
 import java.util.Map.Entry;
 import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
 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.schema.ChoiceNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
@@ -36,20 +40,21 @@ import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 
 public final class ImmutableNodes {
+    private static final NodeIdentifier SCHEMACONTEXT_NAME = NodeIdentifier.create(SchemaContext.NAME);
 
     private ImmutableNodes() {
         throw new UnsupportedOperationException("Utilities class should not be instantiated");
     }
 
-    public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder() {
+    public static @NonNull CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder() {
         return ImmutableMapNodeBuilder.create();
     }
 
-    public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final QName name) {
+    public static @NonNull CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final QName name) {
         return mapNodeBuilder(NodeIdentifier.create(name));
     }
 
-    public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final NodeIdentifier name) {
+    public static @NonNull CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final NodeIdentifier name) {
         return ImmutableMapNodeBuilder.create().withNodeIdentifier(name);
     }
 
@@ -59,15 +64,16 @@ public final class ImmutableNodes {
      * @param name QName which will be used as node identifier
      * @return An unordered Map node
      */
-    public static MapNode mapNode(final QName name) {
+    public static @NonNull MapNode mapNode(final QName name) {
         return mapNodeBuilder(name).build();
     }
 
-    private static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapNodeBuilder(final QName qname) {
+    private static @NonNull CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapNodeBuilder(
+            final QName qname) {
         return orderedMapNodeBuilder().withNodeIdentifier(NodeIdentifier.create(qname));
     }
 
-    private static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapNodeBuilder() {
+    private static @NonNull CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapNodeBuilder() {
         return ImmutableOrderedMapNodeBuilder.create();
     }
 
@@ -77,7 +83,7 @@ public final class ImmutableNodes {
      * @param name QName which will be used as node identifier
      * @return An ordered Map node
      */
-    public static OrderedMapNode orderedMapNode(final QName name) {
+    public static @NonNull OrderedMapNode orderedMapNode(final QName name) {
         return orderedMapNodeBuilder(name).build();
     }
 
@@ -89,7 +95,7 @@ public final class ImmutableNodes {
      * @param <T> Type of leaf node value
      * @return Leaf node with supplied identifier and value
      */
-    public static <T> LeafNode<T> leafNode(final NodeIdentifier name, final T value) {
+    public static <T> @NonNull LeafNode<T> leafNode(final NodeIdentifier name, final T value) {
         return ImmutableLeafNodeBuilder.<T>create()
                 .withNodeIdentifier(name)
                 .withValue(value)
@@ -104,22 +110,22 @@ public final class ImmutableNodes {
      * @param <T> Type of leaf node value
      * @return Leaf node with supplied identifier and value
      */
-    public static <T> LeafNode<T> leafNode(final QName name, final T value) {
+    public static <T> @NonNull LeafNode<T> leafNode(final QName name, final T value) {
         return leafNode(NodeIdentifier.create(name), value);
     }
 
-    public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
+    public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
             final QName nodeName, final QName keyName, final Object keyValue) {
         return ImmutableMapEntryNodeBuilder.create()
                 .withNodeIdentifier(new NodeIdentifierWithPredicates(nodeName, keyName, keyValue))
                 .withChild(leafNode(keyName, keyValue));
     }
 
-    public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
+    public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
         return ImmutableMapEntryNodeBuilder.create();
     }
 
-    public static MapEntryNode mapEntry(final QName nodeName,final QName keyName,final Object keyValue) {
+    public static @NonNull MapEntryNode mapEntry(final QName nodeName,final QName keyName,final Object keyValue) {
         return mapEntryBuilder(nodeName, keyName, keyValue).build();
     }
 
@@ -129,7 +135,7 @@ public final class ImmutableNodes {
      * @param name QName which will be used as node identifier
      * @return A container node
      */
-    public static ContainerNode containerNode(final QName name) {
+    public static @NonNull ContainerNode containerNode(final QName name) {
         return ImmutableContainerNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
     }
 
@@ -139,7 +145,7 @@ public final class ImmutableNodes {
      * @param name QName which will be used as node identifier
      * @return A choice node
      */
-    public static ChoiceNode choiceNode(final QName name) {
+    public static @NonNull ChoiceNode choiceNode(final QName name) {
         return ImmutableChoiceNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
     }
 
@@ -149,7 +155,7 @@ public final class ImmutableNodes {
      * @param name QName which will be used as node identifier
      * @return An unkeyed list node
      */
-    public static UnkeyedListNode listNode(final QName name) {
+    public static @NonNull UnkeyedListNode listNode(final QName name) {
         return ImmutableUnkeyedListNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
     }
 
@@ -160,7 +166,8 @@ public final class ImmutableNodes {
      * @param id instance identifier to convert to node structure starting from root
      * @return serialized normalized node for provided instance Id
      */
-    public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id) {
+    public static @NonNull NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx,
+            final YangInstanceIdentifier id) {
         return fromInstanceId(ctx, id, Optional.empty(), Optional.empty());
     }
 
@@ -173,7 +180,7 @@ public final class ImmutableNodes {
      *                       instance identifier
      * @return serialized normalized node for provided instance Id with overridden last child.
      */
-    public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
+    public static @NonNull NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
             final NormalizedNode<?, ?> deepestElement) {
         return fromInstanceId(ctx, id, Optional.of(deepestElement), Optional.empty());
     }
@@ -190,14 +197,22 @@ public final class ImmutableNodes {
      * @return serialized normalized node for provided instance Id with (optionally) overridden last child
      *         and (optionally) marked with specific operation attribute.
      */
-    public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
+    public static @NonNull NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
             final Optional<NormalizedNode<?, ?>> deepestElement, final Optional<Entry<QName, ModifyAction>> operation) {
-        final YangInstanceIdentifier.PathArgument topLevelElement = id.getPathArguments().get(0);
-        final DataSchemaNode dataChildByName = ctx.getDataChildByName(topLevelElement.getNodeType());
-        Preconditions.checkNotNull(dataChildByName,
-            "Cannot find %s node in schema context. Instance identifier has to start from root", topLevelElement);
-        final InstanceIdToNodes<?> instanceIdToNodes = InstanceIdToNodes.fromSchemaAndQNameChecked(ctx,
-            topLevelElement.getNodeType());
-        return instanceIdToNodes.create(id, deepestElement, operation);
+        final PathArgument topLevelElement;
+        final InstanceIdToNodes<?> instanceIdToNodes;
+        final Iterator<PathArgument> it = id.getPathArguments().iterator();
+        if (it.hasNext()) {
+            topLevelElement = it.next();
+            final DataSchemaNode dataChildByName = ctx.getDataChildByName(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);
+        }
+
+        return instanceIdToNodes.create(topLevelElement, it, deepestElement, operation);
     }
 }