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 com.google.common.collect.ImmutableSet;
  14 import java.util.Collection;
  15 import java.util.HashMap;
  16 import java.util.HashSet;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.Set;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  24 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  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.UnknownSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  33
  34 /**
  35  * Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent.
  36  */
  37 // FIXME: 7.0.0: re-evaluate the need for this class and potentially its effective statement replacement
  38 public final class EffectiveAugmentationSchema implements AugmentationSchemaNode {
  39     private final AugmentationSchemaNode delegate;
  40     private final ImmutableSet<DataSchemaNode> realChildSchemas;
  41     private final ImmutableMap<QName, DataSchemaNode> mappedChildSchemas;
  42
  43     public EffectiveAugmentationSchema(final AugmentationSchemaNode augmentSchema,
  44             final Collection<? extends DataSchemaNode> realChildSchemas) {
  45         this.delegate = requireNonNull(augmentSchema);
  46         this.realChildSchemas = ImmutableSet.copyOf(realChildSchemas);
  47
  48         final Map<QName, DataSchemaNode> m = new HashMap<>(realChildSchemas.size());
  49         for (DataSchemaNode realChildSchema : realChildSchemas) {
  50             m.put(realChildSchema.getQName(), realChildSchema);
  51         }
  52
  53         this.mappedChildSchemas = ImmutableMap.copyOf(m);
  54     }
  55
  56     /**
  57      * Returns an AugmentationSchemaNode as effective in a parent node.
  58      *
  59      * @param schema Augmentation schema
  60      * @param parent Parent schema
  61      * @return Adjusted Augmentation schema
  62      * @throws NullPointerException if any of the arguments is null
  63      */
  64     public static AugmentationSchemaNode create(final AugmentationSchemaNode schema, final DataNodeContainer parent) {
  65         Set<DataSchemaNode> children = new HashSet<>();
  66         for (DataSchemaNode augNode : schema.getChildNodes()) {
  67             children.add(parent.getDataChildByName(augNode.getQName()));
  68         }
  69         return new EffectiveAugmentationSchema(schema, children);
  70     }
  71
  72     @Override
  73     public Optional<? extends QualifiedBound> getWhenCondition() {
  74         return delegate.getWhenCondition();
  75     }
  76
  77     @Override
  78     public Optional<String> getDescription() {
  79         return delegate.getDescription();
  80     }
  81
  82     @Override
  83     public Optional<String> getReference() {
  84         return delegate.getReference();
  85     }
  86
  87     @Override
  88     public Status getStatus() {
  89         return delegate.getStatus();
  90     }
  91
  92     @Override
  93     public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
  94         return delegate.getUnknownSchemaNodes();
  95     }
  96
  97     @Override
  98     public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
  99         return delegate.getTypeDefinitions();
 100     }
 101
 102     @Override
 103     public Collection<? extends DataSchemaNode> getChildNodes() {
 104         return realChildSchemas;
 105     }
 106
 107     @Override
 108     public Collection<? extends GroupingDefinition> getGroupings() {
 109         return delegate.getGroupings();
 110     }
 111
 112     @Override
 113     public DataSchemaNode dataChildByName(final QName name) {
 114         return mappedChildSchemas.get(requireNonNull(name));
 115     }
 116
 117     @Override
 118     public Collection<? extends UsesNode> getUses() {
 119         return delegate.getUses();
 120     }
 121
 122     @Override
 123     public Optional<AugmentationSchemaNode> getOriginalDefinition() {
 124         return delegate.getOriginalDefinition();
 125     }
 126
 127     @Override
 128     public Collection<? extends ActionDefinition> getActions() {
 129         return delegate.getActions();
 130     }
 131
 132     @Override
 133     public Optional<ActionDefinition> findAction(final QName qname) {
 134         return delegate.findAction(qname);
 135     }
 136
 137     @Override
 138     public Collection<? extends NotificationDefinition> getNotifications() {
 139         return delegate.getNotifications();
 140     }
 141
 142     @Override
 143     public Optional<NotificationDefinition> findNotification(final QName qname) {
 144         return delegate.findNotification(qname);
 145     }
 146
 147     @Override
 148     public AugmentEffectiveStatement asEffectiveStatement() {
 149         return delegate.asEffectiveStatement();
 150     }
 151 }