model/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/EffectiveAugmentationSchema.java

   1 /*
   2  * Copyright (c) 2015 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.yangtools.yang.model.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import java.util.Collection;
  14 import java.util.Optional;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  17 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  19 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.Status;
  23 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  28
  29 /**
  30  * Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent. This is needed to
  31  * correctly interpret constructs like this:
  32  * <pre>
  33  *   <code>
  34  *     container foo;
  35  *
  36  *     augment /foo {
  37  *       container bar;
  38  *     }
  39  *
  40  *     augment /foo/bar {
  41  *       container baz;
  42  *     }
  43  *   </code>
  44  * </pre>
  45  * The {@link AugmentationSchemaNode} returned for {@code augment /foo} contains bare {@code container bar}, e.g. it
  46  * does not show {@code augment /foo/bar} as an available augmentation -- this is only visible in {@code foo}'s schema
  47  * nodes.
  48  *
  49  * <p>
  50  * Note this class only handles {@link DataSchemaNode}s, not all {@code schema tree} statements, as it strictly should.
  51  *
  52  * @deprecated This class should not be needed anymore.
  53  */
  54 @Deprecated(since = "11.0.0", forRemoval = true)
  55 public final class EffectiveAugmentationSchema implements AugmentationSchemaNode {
  56     private final ImmutableMap<QName, DataSchemaNode> children;
  57     private final AugmentationSchemaNode delegate;
  58
  59     public EffectiveAugmentationSchema(final AugmentationSchemaNode augment, final DataNodeContainer target) {
  60         delegate = requireNonNull(augment);
  61
  62         final var augmentChildren = augment.getChildNodes();
  63         final var builder = ImmutableMap.<QName, DataSchemaNode>builderWithExpectedSize(augmentChildren.size());
  64         for (var augChild : augmentChildren) {
  65             // parent may have the corresponding child removed via 'deviate unsupported', i.e. the child is effectively
  66             // not present at the target site
  67             final var qname = augChild.getQName();
  68             final var targetChild = target.dataChildByName(qname);
  69             if (targetChild != null) {
  70                 builder.put(qname, targetChild);
  71             }
  72         }
  73         children = builder.build();
  74     }
  75
  76     @Override
  77     public Optional<? extends QualifiedBound> getWhenCondition() {
  78         return delegate.getWhenCondition();
  79     }
  80
  81     @Override
  82     public Optional<String> getDescription() {
  83         return delegate.getDescription();
  84     }
  85
  86     @Override
  87     public Optional<String> getReference() {
  88         return delegate.getReference();
  89     }
  90
  91     @Override
  92     public Status getStatus() {
  93         return delegate.getStatus();
  94     }
  95
  96     @Override
  97     public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
  98         return delegate.getUnknownSchemaNodes();
  99     }
 100
 101     @Override
 102     public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 103         return delegate.getTypeDefinitions();
 104     }
 105
 106     @Override
 107     public Collection<? extends DataSchemaNode> getChildNodes() {
 108         return children.values();
 109     }
 110
 111     @Override
 112     public Collection<? extends GroupingDefinition> getGroupings() {
 113         return delegate.getGroupings();
 114     }
 115
 116     @Override
 117     public DataSchemaNode dataChildByName(final QName name) {
 118         return children.get(requireNonNull(name));
 119     }
 120
 121     @Override
 122     public Collection<? extends UsesNode> getUses() {
 123         return delegate.getUses();
 124     }
 125
 126     @Override
 127     public Collection<? extends ActionDefinition> getActions() {
 128         return delegate.getActions();
 129     }
 130
 131     @Override
 132     public Optional<ActionDefinition> findAction(final QName qname) {
 133         return delegate.findAction(qname);
 134     }
 135
 136     @Override
 137     public Collection<? extends NotificationDefinition> getNotifications() {
 138         return delegate.getNotifications();
 139     }
 140
 141     @Override
 142     public Optional<NotificationDefinition> findNotification(final QName qname) {
 143         return delegate.findNotification(qname);
 144     }
 145
 146     @Override
 147     public AugmentEffectiveStatement asEffectiveStatement() {
 148         return delegate.asEffectiveStatement();
 149     }
 150 }