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