netconf/netconf-util/src/main/java/org/opendaylight/netconf/util/NodeContainerProxy.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.netconf.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.collect.Maps;
  14 import java.util.Collection;
  15 import java.util.Map;
  16 import java.util.Optional;
  17 import java.util.Set;
  18 import org.eclipse.jdt.annotation.NonNull;
  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.ContainerSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  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.SchemaPath;
  29 import org.opendaylight.yangtools.yang.model.api.Status;
  30 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  34
  35 /**
  36  * Simple proxy for container like schema nodes, where user provides a collection of children schema nodes.
  37  *
  38  * @deprecated This class is no longer used anywhere and is scheduled for removal.
  39  */
  40 @Deprecated(since = "2.0.0", forRemoval = true)
  41 public final class NodeContainerProxy implements ContainerSchemaNode {
  42     private final Collection<? extends AugmentationSchemaNode> availableAugmentations;
  43     private final @NonNull Map<QName, ? extends DataSchemaNode> childNodes;
  44     private final @NonNull SchemaPath path;
  45     private final @NonNull QName qname;
  46
  47     @VisibleForTesting
  48     NodeContainerProxy(final QName qname, final SchemaPath path, final Map<QName, ? extends DataSchemaNode> childNodes,
  49                        final Collection<? extends AugmentationSchemaNode> availableAugmentations) {
  50         this.qname = requireNonNull(qname);
  51         this.path = requireNonNull(path);
  52         this.childNodes = requireNonNull(childNodes);
  53         this.availableAugmentations = availableAugmentations;
  54     }
  55
  56     public static @NonNull NodeContainerProxy ofModelContext(final QName qname, final EffectiveModelContext context) {
  57         return new NodeContainerProxy(qname, SchemaPath.ROOT, asMap(context.getChildNodes()), Set.of());
  58     }
  59
  60     public static @NonNull NodeContainerProxy ofNotification(final NotificationDefinition notification) {
  61         return new NodeContainerProxy(notification.getQName(), notification.getPath(),
  62             asMap(notification.getChildNodes()), notification.getAvailableAugmentations());
  63     }
  64
  65     private static Map<QName, ? extends DataSchemaNode> asMap(final Collection<? extends DataSchemaNode> childNodes) {
  66         return Maps.uniqueIndex(childNodes, DataSchemaNode::getQName);
  67     }
  68
  69     @Override
  70     public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
  71         return Set.of();
  72     }
  73
  74     @Override
  75     public Collection<? extends DataSchemaNode> getChildNodes() {
  76         return childNodes.values();
  77     }
  78
  79     @Override
  80     public Collection<? extends GroupingDefinition> getGroupings() {
  81         return Set.of();
  82     }
  83
  84     @Override
  85     public DataSchemaNode dataChildByName(final QName name) {
  86         return childNodes.get(name);
  87     }
  88
  89     @Override
  90     public Collection<? extends UsesNode> getUses() {
  91         return Set.of();
  92     }
  93
  94     @Override
  95     public boolean isPresenceContainer() {
  96         throw new UnsupportedOperationException();
  97     }
  98
  99     @Override
 100     public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
 101         return availableAugmentations;
 102     }
 103
 104     @Override
 105     @Deprecated
 106     public boolean isAugmenting() {
 107         throw new UnsupportedOperationException();
 108     }
 109
 110     @Override
 111     @Deprecated
 112     public boolean isAddedByUses() {
 113         throw new UnsupportedOperationException();
 114     }
 115
 116     @Override
 117     public Optional<Boolean> effectiveConfig() {
 118         throw new UnsupportedOperationException();
 119     }
 120
 121     @Override
 122     public QName getQName() {
 123         return qname;
 124     }
 125
 126     @Override
 127     @Deprecated
 128     public SchemaPath getPath() {
 129         return path;
 130     }
 131
 132     @Override
 133     public Optional<String> getDescription() {
 134         throw new UnsupportedOperationException();
 135     }
 136
 137     @Override
 138     public Optional<String> getReference() {
 139         throw new UnsupportedOperationException();
 140     }
 141
 142     @Override
 143     public Status getStatus() {
 144         throw new UnsupportedOperationException();
 145     }
 146
 147     @Override
 148     public Collection<? extends NotificationDefinition> getNotifications() {
 149         return Set.of();
 150     }
 151
 152     @Override
 153     public Collection<? extends ActionDefinition> getActions() {
 154         return Set.of();
 155     }
 156
 157     @Override
 158     public Optional<? extends QualifiedBound> getWhenCondition() {
 159         return Optional.empty();
 160     }
 161
 162     @Override
 163     public Collection<? extends @NonNull MustDefinition> getMustConstraints() {
 164         return Set.of();
 165     }
 166
 167     @Override
 168     public ContainerEffectiveStatement asEffectiveStatement() {
 169         throw new UnsupportedOperationException();
 170     }
 171 }