yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/ContainerSchemaNodes.java

   1 /*
   2  * Copyright (c) 2016 ZTE, 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.data.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableMap;
  15 import com.google.common.collect.ImmutableSet;
  16 import com.google.common.collect.Maps;
  17 import java.util.Collection;
  18 import java.util.Optional;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  32 import org.opendaylight.yangtools.yang.model.api.Status;
  33 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  35 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  36
  37 /**
  38  * yang-data-util
  39  * org.opendaylight.yangtools.yang.data.util
  40  * Utility class for taking notification or rpc as ContainerSchemaNode.
  41  * @author <a href="mailto:geng.xingyuan@zte.com.cn">Geng Xingyuan</a>
  42  */
  43 public final class ContainerSchemaNodes {
  44
  45     private ContainerSchemaNodes() {
  46     }
  47
  48     @Beta
  49     public static ContainerLike forNotification(final NotificationDefinition notification) {
  50         return new NotificationContainerSchemaNode(notification);
  51     }
  52
  53     @Beta
  54     public static ContainerLike forRPC(final RpcDefinition rpc) {
  55         return new RpcContainerSchemaNode(rpc);
  56     }
  57
  58     private abstract static class AbstractContainerSchemaNode implements ContainerLike {
  59         private final SchemaNode schemaNode;
  60
  61         private AbstractContainerSchemaNode(final SchemaNode schemaNode) {
  62             this.schemaNode = schemaNode;
  63         }
  64
  65         @Override
  66         public Collection<? extends UsesNode> getUses() {
  67             return ImmutableSet.of();
  68         }
  69
  70         @Override
  71         public boolean isAugmenting() {
  72             return false;
  73         }
  74
  75         @Override
  76         public Optional<Boolean> effectiveConfig() {
  77             return Optional.empty();
  78         }
  79
  80         @Override
  81         public QName getQName() {
  82             return schemaNode.getQName();
  83         }
  84
  85         @Override
  86         @Deprecated
  87         public SchemaPath getPath() {
  88             return schemaNode.getPath();
  89         }
  90
  91         @Override
  92         public Optional<String> getDescription() {
  93             return schemaNode.getDescription();
  94         }
  95
  96         @Override
  97         public Optional<String> getReference() {
  98             return schemaNode.getReference();
  99         }
 100
 101         @Override
 102         public Status getStatus() {
 103             return schemaNode.getStatus();
 104         }
 105
 106         @Override
 107         public Collection<? extends MustDefinition> getMustConstraints() {
 108             return ImmutableList.of();
 109         }
 110
 111         @Override
 112         public Optional<? extends QualifiedBound> getWhenCondition() {
 113             return Optional.empty();
 114         }
 115     }
 116
 117     private static final class RpcContainerSchemaNode extends AbstractContainerSchemaNode {
 118
 119         private final RpcDefinition rpcDefinition;
 120
 121         private RpcContainerSchemaNode(final RpcDefinition rpcDefinition) {
 122             super(rpcDefinition);
 123             this.rpcDefinition = rpcDefinition;
 124         }
 125
 126         @Override
 127         public Collection<? extends GroupingDefinition> getGroupings() {
 128             return rpcDefinition.getGroupings();
 129         }
 130
 131         @Override
 132         public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 133             return rpcDefinition.getTypeDefinitions();
 134         }
 135
 136         @Override
 137         public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
 138             return ImmutableSet.of();
 139         }
 140
 141         @Override
 142         public Collection<? extends DataSchemaNode> getChildNodes() {
 143             final InputSchemaNode input = rpcDefinition.getInput();
 144             final OutputSchemaNode output = rpcDefinition.getOutput();
 145             if (input == null && output == null) {
 146                 return ImmutableList.of();
 147             } else if (input != null && output != null) {
 148                 return ImmutableList.of(input,output);
 149             } else if (input != null) {
 150                 return ImmutableList.of(input);
 151             } else {
 152                 return ImmutableList.of(output);
 153             }
 154         }
 155
 156         @Override
 157         public Optional<DataSchemaNode> findDataChildByName(final QName name) {
 158             switch (name.getLocalName()) {
 159                 case "input":
 160                     return Optional.of(rpcDefinition.getInput());
 161                 case "output":
 162                     return Optional.of(rpcDefinition.getOutput());
 163                 default:
 164                     return Optional.empty();
 165             }
 166         }
 167
 168         @Deprecated
 169         @Override
 170         public boolean isAddedByUses() {
 171             return false;
 172         }
 173
 174         @Override
 175         public Collection<? extends ActionDefinition> getActions() {
 176             return ImmutableSet.of();
 177         }
 178
 179         @Override
 180         public Collection<? extends NotificationDefinition> getNotifications() {
 181             return ImmutableSet.of();
 182         }
 183     }
 184
 185     private static final class NotificationContainerSchemaNode extends AbstractContainerSchemaNode {
 186
 187         private final NotificationDefinition notification;
 188         private final ImmutableMap<QName, ? extends DataSchemaNode> mapNodes;
 189
 190         private NotificationContainerSchemaNode(final NotificationDefinition notification) {
 191             super(notification);
 192             this.notification = notification;
 193             mapNodes = Maps.uniqueIndex(notification.getChildNodes(), DataSchemaNode::getQName);
 194         }
 195
 196         @Override
 197         public Collection<? extends NotificationDefinition> getNotifications() {
 198             return ImmutableSet.of(notification);
 199         }
 200
 201         @Override
 202         public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
 203             return notification.getAvailableAugmentations();
 204         }
 205
 206         @Override
 207         public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 208             return notification.getTypeDefinitions();
 209         }
 210
 211         @Override
 212         public Collection<? extends DataSchemaNode> getChildNodes() {
 213             return notification.getChildNodes();
 214         }
 215
 216         @Override
 217         public Collection<? extends GroupingDefinition> getGroupings() {
 218             return notification.getGroupings();
 219         }
 220
 221         @Override
 222         public Optional<DataSchemaNode> findDataChildByName(final QName name) {
 223             return Optional.ofNullable(mapNodes.get(requireNonNull(name)));
 224         }
 225
 226         @Override
 227         @Deprecated
 228         public boolean isAddedByUses() {
 229             //FIXME: reference to https://bugs.opendaylight.org/show_bug.cgi?id=6897
 230             return false;
 231         }
 232
 233         @Override
 234         public Collection<? extends ActionDefinition> getActions() {
 235             return ImmutableSet.of();
 236         }
 237     }
 238 }