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