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