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