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.parser.stmt.rfc6020;
10 import static org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator.MAX;
11 import java.util.Collection;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
15 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
16 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
23 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
24 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
34 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
35 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
36 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
41 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
42 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
44 .add(Rfc6020Mapping.AUGMENT, 0, MAX)
45 .add(Rfc6020Mapping.DESCRIPTION, 0, 1)
46 .add(Rfc6020Mapping.IF_FEATURE, 0, MAX)
47 .add(Rfc6020Mapping.REFINE, 0, MAX)
48 .add(Rfc6020Mapping.REFERENCE, 0, 1)
49 .add(Rfc6020Mapping.STATUS, 0, 1)
50 .add(Rfc6020Mapping.WHEN, 0, 1)
53 private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
55 protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
59 public static class Definition extends
60 AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
63 super(Rfc6020Mapping.USES);
67 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
68 return Utils.qNameFromArgument(ctx, value);
72 public void onFullDefinitionDeclared(
73 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
74 if (!StmtContextUtils.areFeaturesSupported(usesNode)) {
78 SUBSTATEMENT_VALIDATOR.validate(usesNode);
80 if (StmtContextUtils.isInExtensionBody(usesNode)) {
84 ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
85 final QName groupingName = usesNode.getStatementArgument();
87 final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
88 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
89 final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
90 usesNode.getParentContext());
92 usesAction.apply(new InferenceAction() {
96 StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
97 StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
100 GroupingUtils.copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
101 GroupingUtils.resolveUsesNode(usesNode, targetNodeStmtCtx);
102 } catch (SourceException e) {
103 LOG.warn(e.getMessage(), e);
109 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
110 InferenceException.throwIf(failed.contains(sourceGroupingPre),
111 usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
112 throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
118 public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
119 return new UsesStatementImpl(ctx);
123 public EffectiveStatement<QName, UsesStatement> createEffective(
124 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
125 return new UsesEffectiveStatementImpl(ctx);
131 public QName getName() {
136 public WhenStatement getWhenStatement() {
137 return firstDeclared(WhenStatement.class);
141 public Collection<? extends IfFeatureStatement> getIfFeatures() {
142 return allDeclared(IfFeatureStatement.class);
146 public StatusStatement getStatus() {
147 return firstDeclared(StatusStatement.class);
151 public DescriptionStatement getDescription() {
152 return firstDeclared(DescriptionStatement.class);
156 public ReferenceStatement getReference() {
157 return firstDeclared(ReferenceStatement.class);
161 public Collection<? extends AugmentStatement> getAugments() {
162 return allDeclared(AugmentStatement.class);
166 public Collection<? extends RefineStatement> getRefines() {
167 return allDeclared(RefineStatement.class);