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