Migrate getDataChildByName() users

[yangtools.git] / yang / yang-model-util / src / main / java / org / opendaylight / yangtools / yang / model / util / SchemaNodeUtils.java

diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaNodeUtils.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaNodeUtils.java
index 2b21b23c115e066492234379857fedb71bfa8c87..91f6319152e09dc4db444f0223b0f999fa255edf 100644 (file)
--- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaNodeUtils.java
+++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaNodeUtils.java
@@ -9,18 +9,34 @@ package org.opendaylight.yangtools.yang.model.util;
 
 import static java.util.Objects.requireNonNull;
 
+import com.google.common.annotations.Beta;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
 import java.util.Optional;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerLike;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
+import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
+import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
 public final class SchemaNodeUtils {
     private SchemaNodeUtils() {
-        throw new UnsupportedOperationException("Utility class");
+        // Hidden on purpose
     }
 
     public static Optional<SchemaNode> getOriginalIfPossible(final SchemaNode node) {
@@ -49,7 +65,7 @@ public final class SchemaNodeUtils {
      * @param qname input or output QName with namespace same as RPC
      * @return input or output schema. Returns null if RPC does not have input/output specified.
      */
-    public static @Nullable ContainerSchemaNode getRpcDataSchema(final @NonNull RpcDefinition rpc,
+    public static @Nullable ContainerLike getRpcDataSchema(final @NonNull RpcDefinition rpc,
             final @NonNull QName qname) {
         requireNonNull(rpc, "Rpc Schema must not be null");
         switch (requireNonNull(qname, "QName must not be null").getLocalName()) {
@@ -62,4 +78,95 @@ public final class SchemaNodeUtils {
                         + " does not represent rpc input or output.");
         }
     }
+
+    @Beta
+    public static @NonNull Collection<? extends TypeDefinition<?>> getAllTypeDefinitions(
+            final DataNodeContainer parent) {
+        final List<TypeDefinition<?>> typedefs = new ArrayList<>();
+        traverse(new DataNodeAggregator() {
+            @Override
+            protected void addTypedefs(final Collection<? extends TypeDefinition<?>> typeDefs) {
+                typedefs.addAll(typeDefs);
+            }
+        }, requireNonNull(parent));
+        return typedefs;
+    }
+
+    @Beta
+    public static @NonNull Collection<? extends ContainerSchemaNode> getAllContainers(final DataNodeContainer parent) {
+        final List<ContainerSchemaNode> containers = new ArrayList<>();
+        traverse(new DataNodeAggregator() {
+            @Override
+            protected void addContainer(final ContainerSchemaNode containerNode) {
+                containers.add(containerNode);
+            }
+        }, requireNonNull(parent));
+        return containers;
+    }
+
+    @Beta
+    public static void traverse(final @NonNull DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
+        if (dataNode == null) {
+            return;
+        }
+
+        for (DataSchemaNode childNode : dataNode.getChildNodes()) {
+            if (childNode.isAugmenting()) {
+                continue;
+            }
+            aggregator.addChild(childNode);
+            if (childNode instanceof ContainerSchemaNode) {
+                final ContainerSchemaNode containerNode = (ContainerSchemaNode) childNode;
+                aggregator.addContainer(containerNode);
+                traverse(aggregator, containerNode);
+            } else if (childNode instanceof ListSchemaNode) {
+                final ListSchemaNode list = (ListSchemaNode) childNode;
+                aggregator.addList(list);
+                traverse(aggregator, list);
+            } else if (childNode instanceof ChoiceSchemaNode) {
+                final ChoiceSchemaNode choiceNode = (ChoiceSchemaNode) childNode;
+                aggregator.addChoice(choiceNode);
+                for (final CaseSchemaNode caseNode : choiceNode.getCases()) {
+                    traverse(aggregator, caseNode);
+                }
+            }
+        }
+
+        aggregator.addTypedefs(dataNode.getTypeDefinitions());
+
+        traverseModule(aggregator, dataNode);
+        traverseGroupings(aggregator, dataNode);
+    }
+
+    private static void traverseModule(final DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
+        final Module module;
+        if (dataNode instanceof Module) {
+            module = (Module) dataNode;
+        } else {
+            return;
+        }
+
+        for (NotificationDefinition notificationDefinition : module.getNotifications()) {
+            traverse(aggregator, notificationDefinition);
+        }
+
+        for (RpcDefinition rpcDefinition : module.getRpcs()) {
+            aggregator.addTypedefs(rpcDefinition.getTypeDefinitions());
+            InputSchemaNode input = rpcDefinition.getInput();
+            if (input != null) {
+                traverse(aggregator, input);
+            }
+            OutputSchemaNode output = rpcDefinition.getOutput();
+            if (output != null) {
+                traverse(aggregator, output);
+            }
+        }
+    }
+
+    private static void traverseGroupings(final DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
+        for (GroupingDefinition grouping : dataNode.getGroupings()) {
+            aggregator.addGrouping(grouping);
+            traverse(aggregator, grouping);
+        }
+    }
 }