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 // FIXME: YANGTOOLS-1403: this functionality should be integrated into EffectiveAugmentStatement/AugmentationSchemaNode
  53 public final class EffectiveAugmentationSchema implements AugmentationSchemaNode {
  54     private final ImmutableMap<QName, DataSchemaNode> children;
  55     private final AugmentationSchemaNode delegate;
  56
  57     public EffectiveAugmentationSchema(final AugmentationSchemaNode augment, final DataNodeContainer target) {
  58         delegate = requireNonNull(augment);
  59
  60         final var augmentChildren = augment.getChildNodes();
  61         final var builder = ImmutableMap.<QName, DataSchemaNode>builderWithExpectedSize(augmentChildren.size());
  62         for (var augChild : augmentChildren) {
  63             // parent may have the corresponding child removed via 'deviate unsupported', i.e. the child is effectively
  64             // not present at the target site
  65             final var qname = augChild.getQName();
  66             final var targetChild = target.dataChildByName(qname);
  67             if (targetChild != null) {
  68                 builder.put(qname, targetChild);
  69             }
  70         }
  71         children = builder.build();
  72     }
  73
  74     @Override
  75     public Optional<? extends QualifiedBound> getWhenCondition() {
  76         return delegate.getWhenCondition();
  77     }
  78
  79     @Override
  80     public Optional<String> getDescription() {
  81         return delegate.getDescription();
  82     }
  83
  84     @Override
  85     public Optional<String> getReference() {
  86         return delegate.getReference();
  87     }
  88
  89     @Override
  90     public Status getStatus() {
  91         return delegate.getStatus();
  92     }
  93
  94     @Override
  95     public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
  96         return delegate.getUnknownSchemaNodes();
  97     }
  98
  99     @Override
 100     public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 101         return delegate.getTypeDefinitions();
 102     }
 103
 104     @Override
 105     public Collection<? extends DataSchemaNode> getChildNodes() {
 106         return children.values();
 107     }
 108
 109     @Override
 110     public Collection<? extends GroupingDefinition> getGroupings() {
 111         return delegate.getGroupings();
 112     }
 113
 114     @Override
 115     public DataSchemaNode dataChildByName(final QName name) {
 116         return children.get(requireNonNull(name));
 117     }
 118
 119     @Override
 120     public Collection<? extends UsesNode> getUses() {
 121         return delegate.getUses();
 122     }
 123
 124     @Override
 125     public Collection<? extends ActionDefinition> getActions() {
 126         return delegate.getActions();
 127     }
 128
 129     @Override
 130     public Optional<ActionDefinition> findAction(final QName qname) {
 131         return delegate.findAction(qname);
 132     }
 133
 134     @Override
 135     public Collection<? extends NotificationDefinition> getNotifications() {
 136         return delegate.getNotifications();
 137     }
 138
 139     @Override
 140     public Optional<NotificationDefinition> findNotification(final QName qname) {
 141         return delegate.findNotification(qname);
 142     }
 143
 144     @Override
 145     public AugmentEffectiveStatement asEffectiveStatement() {
 146         return delegate.asEffectiveStatement();
 147     }
 148 }