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

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.Module;
  26 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  30
  31 @Deprecated
  32 public final class SchemaNodeUtils {
  33     private SchemaNodeUtils() {
  34         // Hidden on purpose
  35     }
  36
  37     @Beta
  38     public static @NonNull Collection<? extends TypeDefinition<?>> getAllTypeDefinitions(
  39             final DataNodeContainer parent) {
  40         final List<TypeDefinition<?>> typedefs = new ArrayList<>();
  41         traverse(new DataNodeAggregator() {
  42             @Override
  43             protected void addTypedefs(final Collection<? extends TypeDefinition<?>> typeDefs) {
  44                 typedefs.addAll(typeDefs);
  45             }
  46         }, requireNonNull(parent));
  47         return typedefs;
  48     }
  49
  50     @Beta
  51     public static @NonNull Collection<? extends ContainerSchemaNode> getAllContainers(final DataNodeContainer parent) {
  52         final List<ContainerSchemaNode> containers = new ArrayList<>();
  53         traverse(new DataNodeAggregator() {
  54             @Override
  55             protected void addContainer(final ContainerSchemaNode containerNode) {
  56                 containers.add(containerNode);
  57             }
  58         }, requireNonNull(parent));
  59         return containers;
  60     }
  61
  62     @Beta
  63     public static void traverse(final @NonNull DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
  64         if (dataNode == null) {
  65             return;
  66         }
  67
  68         for (DataSchemaNode childNode : dataNode.getChildNodes()) {
  69             if (childNode.isAugmenting()) {
  70                 continue;
  71             }
  72             aggregator.addChild(childNode);
  73             if (childNode instanceof ContainerSchemaNode) {
  74                 final ContainerSchemaNode containerNode = (ContainerSchemaNode) childNode;
  75                 aggregator.addContainer(containerNode);
  76                 traverse(aggregator, containerNode);
  77             } else if (childNode instanceof ListSchemaNode) {
  78                 final ListSchemaNode list = (ListSchemaNode) childNode;
  79                 aggregator.addList(list);
  80                 traverse(aggregator, list);
  81             } else if (childNode instanceof ChoiceSchemaNode) {
  82                 final ChoiceSchemaNode choiceNode = (ChoiceSchemaNode) childNode;
  83                 aggregator.addChoice(choiceNode);
  84                 for (final CaseSchemaNode caseNode : choiceNode.getCases()) {
  85                     traverse(aggregator, caseNode);
  86                 }
  87             }
  88         }
  89
  90         aggregator.addTypedefs(dataNode.getTypeDefinitions());
  91
  92         traverseModule(aggregator, dataNode);
  93         traverseGroupings(aggregator, dataNode);
  94     }
  95
  96     private static void traverseModule(final DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
  97         final Module module;
  98         if (dataNode instanceof Module) {
  99             module = (Module) dataNode;
 100         } else {
 101             return;
 102         }
 103
 104         for (NotificationDefinition notificationDefinition : module.getNotifications()) {
 105             traverse(aggregator, notificationDefinition);
 106         }
 107
 108         for (RpcDefinition rpcDefinition : module.getRpcs()) {
 109             aggregator.addTypedefs(rpcDefinition.getTypeDefinitions());
 110             InputSchemaNode input = rpcDefinition.getInput();
 111             if (input != null) {
 112                 traverse(aggregator, input);
 113             }
 114             OutputSchemaNode output = rpcDefinition.getOutput();
 115             if (output != null) {
 116                 traverse(aggregator, output);
 117             }
 118         }
 119     }
 120
 121     private static void traverseGroupings(final DataNodeAggregator aggregator, final DataNodeContainer dataNode) {
 122         for (GroupingDefinition grouping : dataNode.getGroupings()) {
 123             aggregator.addGrouping(grouping);
 124             traverse(aggregator, grouping);
 125         }
 126     }
 127 }