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