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.meta.StmtContextUtils.findFirstDeclaredSubstatement;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
13 import java.util.Optional;
14 import javax.annotation.Nonnull;
15 import org.opendaylight.yangtools.yang.common.Revision;
16 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionStatement;
23 import org.opendaylight.yangtools.yang.model.util.ModuleIdentifierImpl;
24 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
30 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
31 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
32 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.SubmoduleEffectiveStatementImpl;
34 public class SubmoduleStatementImpl extends AbstractRootStatement<SubmoduleStatement> implements SubmoduleStatement {
35 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
37 .addAny(YangStmtMapping.ANYXML)
38 .addAny(YangStmtMapping.AUGMENT)
39 .addMandatory(YangStmtMapping.BELONGS_TO)
40 .addAny(YangStmtMapping.CHOICE)
41 .addOptional(YangStmtMapping.CONTACT)
42 .addAny(YangStmtMapping.CONTAINER)
43 .addOptional(YangStmtMapping.DESCRIPTION)
44 .addAny(YangStmtMapping.DEVIATION)
45 .addAny(YangStmtMapping.EXTENSION)
46 .addAny(YangStmtMapping.FEATURE)
47 .addAny(YangStmtMapping.GROUPING)
48 .addAny(YangStmtMapping.IDENTITY)
49 .addAny(YangStmtMapping.IMPORT)
50 .addAny(YangStmtMapping.INCLUDE)
51 .addAny(YangStmtMapping.LEAF)
52 .addAny(YangStmtMapping.LEAF_LIST)
53 .addAny(YangStmtMapping.LIST)
54 .addAny(YangStmtMapping.NOTIFICATION)
55 .addOptional(YangStmtMapping.ORGANIZATION)
56 .addOptional(YangStmtMapping.REFERENCE)
57 .addAny(YangStmtMapping.REVISION)
58 .addAny(YangStmtMapping.RPC)
59 .addAny(YangStmtMapping.TYPEDEF)
60 .addAny(YangStmtMapping.USES)
61 .addOptional(YangStmtMapping.YANG_VERSION)
64 protected SubmoduleStatementImpl(final StmtContext<String, SubmoduleStatement, ?> context) {
68 public static class Definition extends AbstractStatementSupport<String, SubmoduleStatement,
69 EffectiveStatement<String, SubmoduleStatement>> {
72 super(YangStmtMapping.SUBMODULE);
76 public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
81 public SubmoduleStatement createDeclared(
82 final StmtContext<String, SubmoduleStatement, ?> ctx) {
83 return new SubmoduleStatementImpl(ctx);
87 public EffectiveStatement<String, SubmoduleStatement> createEffective(
88 final StmtContext<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> ctx) {
89 return new SubmoduleEffectiveStatementImpl(ctx);
93 public void onPreLinkageDeclared(
94 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
95 stmt.setRootIdentifier(getSubmoduleIdentifier(stmt));
99 public void onLinkageDeclared(
100 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
101 final ModuleIdentifier submoduleIdentifier = getSubmoduleIdentifier(stmt);
103 final StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>
104 possibleDuplicateSubmodule = stmt.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
105 if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
106 throw new SourceException(stmt.getStatementSourceReference(), "Submodule name collision: %s. At %s",
107 stmt.getStatementArgument(), possibleDuplicateSubmodule.getStatementSourceReference());
110 stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
112 final String belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(), BelongsToStatement.class);
113 final StmtContext<?, ?, ?> prefixSubStmtCtx = findFirstDeclaredSubstatement(stmt, 0,
114 BelongsToStatement.class, PrefixStatement.class);
115 SourceException.throwIfNull(prefixSubStmtCtx, stmt.getStatementSourceReference(),
116 "Prefix of belongsTo statement is missing in submodule [%s]", stmt.getStatementArgument());
118 final String prefix = (String) prefixSubStmtCtx.getStatementArgument();
120 stmt.addToNs(BelongsToPrefixToModuleName.class, prefix, belongsToModuleName);
123 private static ModuleIdentifier getSubmoduleIdentifier(
124 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
125 final Optional<Revision> maybeDate = StmtContextUtils.getLatestRevision(stmt.declaredSubstatements());
126 return ModuleIdentifierImpl.create(stmt.getStatementArgument(), maybeDate);
130 protected SubstatementValidator getSubstatementValidator() {
131 return SUBSTATEMENT_VALIDATOR;
137 public String getName() {
138 return rawArgument();
142 public YangVersionStatement getYangVersion() {
143 return firstDeclared(YangVersionStatement.class);
148 public BelongsToStatement getBelongsTo() {
149 return firstDeclared(BelongsToStatement.class);