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         @Deprecated
  73         public boolean isAugmenting() {
  74             return false;
  75         }
  76
  77         @Override
  78         public Optional<Boolean> effectiveConfig() {
  79             return Optional.empty();
  80         }
  81
  82         @Override
  83         public QName getQName() {
  84             return schemaNode.getQName();
  85         }
  86
  87         @Override
  88         @Deprecated
  89         public SchemaPath getPath() {
  90             return schemaNode.getPath();
  91         }
  92
  93         @Override
  94         public Optional<String> getDescription() {
  95             return schemaNode.getDescription();
  96         }
  97
  98         @Override
  99         public Optional<String> getReference() {
 100             return schemaNode.getReference();
 101         }
 102
 103         @Override
 104         public Status getStatus() {
 105             return schemaNode.getStatus();
 106         }
 107
 108         @Override
 109         public Collection<? extends @NonNull MustDefinition> getMustConstraints() {
 110             return ImmutableList.of();
 111         }
 112
 113         @Override
 114         public Optional<? extends QualifiedBound> getWhenCondition() {
 115             return Optional.empty();
 116         }
 117     }
 118
 119     private static final class RpcContainerSchemaNode extends AbstractContainerSchemaNode {
 120
 121         private final RpcDefinition rpcDefinition;
 122
 123         private RpcContainerSchemaNode(final RpcDefinition rpcDefinition) {
 124             super(rpcDefinition);
 125             this.rpcDefinition = rpcDefinition;
 126         }
 127
 128         @Override
 129         public Collection<? extends GroupingDefinition> getGroupings() {
 130             return rpcDefinition.getGroupings();
 131         }
 132
 133         @Override
 134         public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 135             return rpcDefinition.getTypeDefinitions();
 136         }
 137
 138         @Override
 139         public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
 140             return ImmutableSet.of();
 141         }
 142
 143         @Override
 144         public Collection<? extends DataSchemaNode> getChildNodes() {
 145             final InputSchemaNode input = rpcDefinition.getInput();
 146             final OutputSchemaNode output = rpcDefinition.getOutput();
 147             if (input == null && output == null) {
 148                 return ImmutableList.of();
 149             } else if (input != null && output != null) {
 150                 return ImmutableList.of(input,output);
 151             } else if (input != null) {
 152                 return ImmutableList.of(input);
 153             } else {
 154                 return ImmutableList.of(output);
 155             }
 156         }
 157
 158         @Override
 159         public DataSchemaNode dataChildByName(final QName name) {
 160             switch (name.getLocalName()) {
 161                 case "input":
 162                     return rpcDefinition.getInput();
 163                 case "output":
 164                     return rpcDefinition.getOutput();
 165                 default:
 166                     return null;
 167             }
 168         }
 169
 170         @Deprecated
 171         @Override
 172         public boolean isAddedByUses() {
 173             return false;
 174         }
 175
 176         @Override
 177         public Collection<? extends ActionDefinition> getActions() {
 178             return ImmutableSet.of();
 179         }
 180
 181         @Override
 182         public Collection<? extends NotificationDefinition> getNotifications() {
 183             return ImmutableSet.of();
 184         }
 185     }
 186
 187     private static final class NotificationContainerSchemaNode extends AbstractContainerSchemaNode {
 188
 189         private final NotificationDefinition notification;
 190         private final ImmutableMap<QName, ? extends DataSchemaNode> mapNodes;
 191
 192         private NotificationContainerSchemaNode(final NotificationDefinition notification) {
 193             super(notification);
 194             this.notification = notification;
 195             mapNodes = Maps.uniqueIndex(notification.getChildNodes(), DataSchemaNode::getQName);
 196         }
 197
 198         @Override
 199         public Collection<? extends NotificationDefinition> getNotifications() {
 200             return ImmutableSet.of(notification);
 201         }
 202
 203         @Override
 204         public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
 205             return notification.getAvailableAugmentations();
 206         }
 207
 208         @Override
 209         public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 210             return notification.getTypeDefinitions();
 211         }
 212
 213         @Override
 214         public Collection<? extends DataSchemaNode> getChildNodes() {
 215             return notification.getChildNodes();
 216         }
 217
 218         @Override
 219         public Collection<? extends GroupingDefinition> getGroupings() {
 220             return notification.getGroupings();
 221         }
 222
 223         @Override
 224         public DataSchemaNode dataChildByName(final QName name) {
 225             return mapNodes.get(requireNonNull(name));
 226         }
 227
 228         @Override
 229         @Deprecated
 230         public boolean isAddedByUses() {
 231             //FIXME: reference to https://bugs.opendaylight.org/show_bug.cgi?id=6897
 232             return false;
 233         }
 234
 235         @Override
 236         public Collection<? extends ActionDefinition> getActions() {
 237             return ImmutableSet.of();
 238         }
 239     }
 240 }