2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.util;
10 import static java.util.Objects.requireNonNull;
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;
30 * Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent. This is needed to
31 * correctly interpret constructs like this:
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
50 * Note this class only handles {@link DataSchemaNode}s, not all {@code schema tree} statements, as it strictly should.
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;
57 public EffectiveAugmentationSchema(final AugmentationSchemaNode augment, final DataNodeContainer target) {
58 delegate = requireNonNull(augment);
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);
71 children = builder.build();
75 public Optional<? extends QualifiedBound> getWhenCondition() {
76 return delegate.getWhenCondition();
80 public Optional<String> getDescription() {
81 return delegate.getDescription();
85 public Optional<String> getReference() {
86 return delegate.getReference();
90 public Status getStatus() {
91 return delegate.getStatus();
95 public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
96 return delegate.getUnknownSchemaNodes();
100 public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
101 return delegate.getTypeDefinitions();
105 public Collection<? extends DataSchemaNode> getChildNodes() {
106 return children.values();
110 public Collection<? extends GroupingDefinition> getGroupings() {
111 return delegate.getGroupings();
115 public DataSchemaNode dataChildByName(final QName name) {
116 return children.get(requireNonNull(name));
120 public Collection<? extends UsesNode> getUses() {
121 return delegate.getUses();
125 public Optional<AugmentationSchemaNode> getOriginalDefinition() {
126 return delegate.getOriginalDefinition();
130 public Collection<? extends ActionDefinition> getActions() {
131 return delegate.getActions();
135 public Optional<ActionDefinition> findAction(final QName qname) {
136 return delegate.findAction(qname);
140 public Collection<? extends NotificationDefinition> getNotifications() {
141 return delegate.getNotifications();
145 public Optional<NotificationDefinition> findNotification(final QName qname) {
146 return delegate.findNotification(qname);
150 public AugmentEffectiveStatement asEffectiveStatement() {
151 return delegate.asEffectiveStatement();